blob: 71cbeac23cdef461e78508629ffc16fd6de276df [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
Trevor Johns682c24e2016-04-12 10:13:47 -0700118 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * 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
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * 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.
Trevor Johns682c24e2016-04-12 10:13:47 -0700189 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 * 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;
Trevor Johns682c24e2016-04-12 10:13:47 -0700342 * &lt;data android:mimeType="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>
Trevor Johns682c24e2016-04-12 10:13:47 -0700361 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * 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 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001327 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 * <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 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001334 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001335 * <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 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001420 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1421 * <p>Input: Nothing.
1422 * <p>Output: Nothing.
1423 * @hide
1424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1427 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1428
1429 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001430 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1431 * <p>Input: Nothing.
1432 * <p>Output: Nothing.
1433 * @hide
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1437 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1438
1439 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001440 * Activity Action: Show settings for managing network data usage of a
1441 * specific application. Applications should define an activity that offers
1442 * options to control data usage.
1443 */
1444 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1445 public static final String ACTION_MANAGE_NETWORK_USAGE =
1446 "android.intent.action.MANAGE_NETWORK_USAGE";
1447
1448 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001449 * Activity Action: Launch application installer.
1450 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001451 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001452 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1453 * you can also use "package:<package-name>" to install an application for the
1454 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001455 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1456 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1457 * <p>
1458 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1459 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001460 * <p>
1461 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1462 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1463 * in order to launch the application installer.
1464 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 *
1466 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1467 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1468 * @see #EXTRA_RETURN_RESULT
1469 */
1470 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1471 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1472
1473 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001474 * Activity Action: Launch ephemeral installer.
1475 * <p>
1476 * Input: The data must be a http: URI that the ephemeral application is registered
1477 * to handle.
1478 * <p class="note">
1479 * This is a protected intent that can only be sent by the system.
1480 * </p>
1481 *
1482 * @hide
1483 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001484 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1485 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1486 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1487
1488 /**
1489 * Service Action: Resolve ephemeral application.
1490 * <p>
1491 * The system will have a persistent connection to this service.
1492 * This is a protected intent that can only be sent by the system.
1493 * </p>
1494 *
1495 * @hide
1496 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001497 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1498 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1499 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1500
1501 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001502 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1503 * package. Specifies the installer package name; this package will receive the
1504 * {@link #ACTION_APP_ERROR} intent.
1505 */
1506 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1507 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1508
1509 /**
1510 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1511 * package. Specifies that the application being installed should not be
1512 * treated as coming from an unknown source, but as coming from the app
1513 * invoking the Intent. For this to work you must start the installer with
1514 * startActivityForResult().
1515 */
1516 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1517 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1518
1519 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001520 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1521 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001522 * data field originated from.
1523 */
rich cannings706e8ba2012-08-20 13:20:14 -07001524 public static final String EXTRA_ORIGINATING_URI
1525 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001526
1527 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001528 * This extra can be used with any Intent used to launch an activity, supplying information
1529 * about who is launching that activity. This field contains a {@link android.net.Uri}
1530 * object, typically an http: or https: URI of the web site that the referral came from;
1531 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1532 * a native application that it came from.
1533 *
1534 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1535 * instead of directly retrieving the extra. It is also valid for applications to
1536 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1537 * a string, not a Uri; the field here, if supplied, will always take precedence,
1538 * however.</p>
1539 *
1540 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001541 */
1542 public static final String EXTRA_REFERRER
1543 = "android.intent.extra.REFERRER";
1544
1545 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001546 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1547 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1548 * not be created, in particular when Intent extras are supplied through the
1549 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1550 * schemes.
1551 *
1552 * @see #EXTRA_REFERRER
1553 */
1554 public static final String EXTRA_REFERRER_NAME
1555 = "android.intent.extra.REFERRER_NAME";
1556
1557 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001558 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001559 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001560 * @hide
1561 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001562 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001563 public static final String EXTRA_ORIGINATING_UID
1564 = "android.intent.extra.ORIGINATING_UID";
1565
1566 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001567 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1568 * package. Tells the installer UI to skip the confirmation with the user
1569 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001570 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1571 * will no longer show an interstitial message about updating existing
1572 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001573 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001574 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001575 public static final String EXTRA_ALLOW_REPLACE
1576 = "android.intent.extra.ALLOW_REPLACE";
1577
1578 /**
1579 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1580 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1581 * return to the application the result code of the install/uninstall. The returned result
1582 * code will be {@link android.app.Activity#RESULT_OK} on success or
1583 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1584 */
1585 public static final String EXTRA_RETURN_RESULT
1586 = "android.intent.extra.RETURN_RESULT";
1587
1588 /**
1589 * Package manager install result code. @hide because result codes are not
1590 * yet ready to be exposed.
1591 */
1592 public static final String EXTRA_INSTALL_RESULT
1593 = "android.intent.extra.INSTALL_RESULT";
1594
1595 /**
1596 * Activity Action: Launch application uninstaller.
1597 * <p>
1598 * Input: The data must be a package: URI whose scheme specific part is
1599 * the package name of the current installed package to be uninstalled.
1600 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1601 * <p>
1602 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1603 * succeeded.
1604 */
1605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1606 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1607
1608 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001609 * Specify whether the package should be uninstalled for all users.
1610 * @hide because these should not be part of normal application flow.
1611 */
1612 public static final String EXTRA_UNINSTALL_ALL_USERS
1613 = "android.intent.extra.UNINSTALL_ALL_USERS";
1614
1615 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001616 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1617 * describing the last run version of the platform that was setup.
1618 * @hide
1619 */
1620 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1621
Svet Ganov3695b8a2015-03-24 16:30:25 -07001622 /**
1623 * Activity action: Launch UI to manage the permissions of an app.
1624 * <p>
1625 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1626 * will be managed by the launched UI.
1627 * </p>
1628 * <p>
1629 * Output: Nothing.
1630 * </p>
1631 *
1632 * @see #EXTRA_PACKAGE_NAME
1633 *
1634 * @hide
1635 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001636 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001637 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1638 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1639 "android.intent.action.MANAGE_APP_PERMISSIONS";
1640
1641 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001642 * Activity action: Launch UI to manage permissions.
1643 * <p>
1644 * Input: Nothing.
1645 * </p>
1646 * <p>
1647 * Output: Nothing.
1648 * </p>
1649 *
1650 * @hide
1651 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001652 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1654 public static final String ACTION_MANAGE_PERMISSIONS =
1655 "android.intent.action.MANAGE_PERMISSIONS";
1656
1657 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001658 * Activity action: Launch UI to review permissions for an app.
1659 * The system uses this intent if permission review for apps not
1660 * supporting the new runtime permissions model is enabled. In
1661 * this mode a permission review is required before any of the
1662 * app components can run.
1663 * <p>
1664 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1665 * permissions will be reviewed (mandatory).
1666 * </p>
1667 * <p>
1668 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1669 * be fired after the permission review (optional).
1670 * </p>
1671 * <p>
1672 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1673 * be invoked after the permission review (optional).
1674 * </p>
1675 * <p>
1676 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1677 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1678 * </p>
1679 * <p>
1680 * Output: Nothing.
1681 * </p>
1682 *
1683 * @see #EXTRA_PACKAGE_NAME
1684 * @see #EXTRA_INTENT
1685 * @see #EXTRA_REMOTE_CALLBACK
1686 * @see #EXTRA_RESULT_NEEDED
1687 *
1688 * @hide
1689 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001690 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1692 public static final String ACTION_REVIEW_PERMISSIONS =
1693 "android.intent.action.REVIEW_PERMISSIONS";
1694
1695 /**
1696 * Intent extra: A callback for reporting remote result as a bundle.
1697 * <p>
1698 * Type: IRemoteCallback
1699 * </p>
1700 *
1701 * @hide
1702 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001703 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001704 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1705
1706 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001707 * Intent extra: An app package name.
1708 * <p>
1709 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001710 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001711 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001712 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001713 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1714
1715 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001716 * Intent extra: An app split name.
1717 * <p>
1718 * Type: String
1719 * </p>
1720 * @hide
1721 */
1722 @SystemApi
1723 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1724
1725 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001726 * Intent extra: An extra for specifying whether a result is needed.
1727 * <p>
1728 * Type: boolean
1729 * </p>
1730 *
1731 * @hide
1732 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001733 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001734 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1735
1736 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001737 * Activity action: Launch UI to manage which apps have a given permission.
1738 * <p>
1739 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1740 * to which will be managed by the launched UI.
1741 * </p>
1742 * <p>
1743 * Output: Nothing.
1744 * </p>
1745 *
1746 * @see #EXTRA_PERMISSION_NAME
1747 *
1748 * @hide
1749 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001750 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001751 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1752 public static final String ACTION_MANAGE_PERMISSION_APPS =
1753 "android.intent.action.MANAGE_PERMISSION_APPS";
1754
1755 /**
1756 * Intent extra: The name of a permission.
1757 * <p>
1758 * Type: String
1759 * </p>
1760 *
1761 * @hide
1762 */
1763 @SystemApi
1764 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1765
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001766 // ---------------------------------------------------------------------
1767 // ---------------------------------------------------------------------
1768 // Standard intent broadcast actions (see action variable).
1769
1770 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001771 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1772 * <p>
1773 * For historical reasons, the name of this broadcast action refers to the power
1774 * state of the screen but it is actually sent in response to changes in the
1775 * overall interactive state of the device.
1776 * </p><p>
1777 * This broadcast is sent when the device becomes non-interactive which may have
1778 * nothing to do with the screen turning off. To determine the
1779 * actual state of the screen, use {@link android.view.Display#getState}.
1780 * </p><p>
1781 * See {@link android.os.PowerManager#isInteractive} for details.
1782 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001783 * You <em>cannot</em> receive this through components declared in
1784 * manifests, only by explicitly registering for it with
1785 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1786 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001787 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001788 * <p class="note">This is a protected intent that can only be sent
1789 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001790 */
1791 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1792 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001793
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001795 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1796 * <p>
1797 * For historical reasons, the name of this broadcast action refers to the power
1798 * state of the screen but it is actually sent in response to changes in the
1799 * overall interactive state of the device.
1800 * </p><p>
1801 * This broadcast is sent when the device becomes interactive which may have
1802 * nothing to do with the screen turning on. To determine the
1803 * actual state of the screen, use {@link android.view.Display#getState}.
1804 * </p><p>
1805 * See {@link android.os.PowerManager#isInteractive} for details.
1806 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001807 * You <em>cannot</em> receive this through components declared in
1808 * manifests, only by explicitly registering for it with
1809 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1810 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001817
1818 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001819 * Broadcast Action: Sent after the system stops dreaming.
1820 *
1821 * <p class="note">This is a protected intent that can only be sent by the system.
1822 * It is only sent to registered receivers.</p>
1823 */
1824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1825 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1826
1827 /**
1828 * Broadcast Action: Sent after the system starts dreaming.
1829 *
1830 * <p class="note">This is a protected intent that can only be sent by the system.
1831 * It is only sent to registered receivers.</p>
1832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1834 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1835
1836 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001837 * 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 -07001838 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001839 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001840 * <p class="note">This is a protected intent that can only be sent
1841 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001842 */
1843 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001844 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001845
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001846 /**
1847 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001848 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001849 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001850 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1851 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1858 /**
1859 * Broadcast Action: The time was set.
1860 */
1861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1862 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1863 /**
1864 * Broadcast Action: The date has changed.
1865 */
1866 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1867 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1868 /**
1869 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1870 * <ul>
1871 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1872 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001873 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001874 * <p class="note">This is a protected intent that can only be sent
1875 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1878 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1879 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001880 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1881 * DNS entries should be tossed.
1882 * @hide
1883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1885 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1886 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001887 * Alarm Changed Action: This is broadcast when the AlarmClock
1888 * application's alarm is set or unset. It is used by the
1889 * AlarmClock application and the StatusBar service.
1890 * @hide
1891 */
1892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1893 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001894
1895 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001896 * Broadcast Action: This is broadcast once, after the user has finished
1897 * booting, but while still in the "locked" state. It can be used to perform
1898 * application-specific initialization, such as installing alarms. You must
1899 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1900 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001901 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001902 * This broadcast is sent immediately at boot by all devices (regardless of
1903 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1904 * higher. Upon receipt of this broadcast, the user is still locked and only
1905 * device-protected storage can be accessed safely. If you want to access
1906 * credential-protected storage, you need to wait for the user to be
1907 * unlocked (typically by entering their lock pattern or PIN for the first
1908 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1909 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1910 * <p>
1911 * To receive this broadcast, your receiver component must be marked as
1912 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001913 * <p class="note">
1914 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001915 *
1916 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1919 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1920
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001921 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001922 * Broadcast Action: This is broadcast once, after the user has finished
1923 * booting. It can be used to perform application-specific initialization,
1924 * such as installing alarms. You must hold the
1925 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1926 * order to receive this broadcast.
1927 * <p>
1928 * This broadcast is sent at boot by all devices (both with and without
1929 * direct boot support). Upon receipt of this broadcast, the user is
1930 * unlocked and both device-protected and credential-protected storage can
1931 * accessed safely.
1932 * <p>
1933 * If you need to run while the user is still locked (before they've entered
1934 * their lock pattern or PIN for the first time), you can listen for the
1935 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1936 * <p class="note">
1937 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 /**
1943 * Broadcast Action: This is broadcast when a user action should request a
1944 * temporary system dialog to dismiss. Some examples of temporary system
1945 * dialogs are the notification window-shade and the recent tasks dialog.
1946 */
1947 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1948 /**
1949 * Broadcast Action: Trigger the download and eventual installation
1950 * of a package.
1951 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001952 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001953 * <p class="note">This is a protected intent that can only be sent
1954 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001955 *
1956 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001957 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001958 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1961 /**
1962 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001963 * device. The data contains the name of the package. Note that the
1964 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001965 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001966 * <ul>
1967 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1968 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1969 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1970 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001971 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1977 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001978 * Broadcast Action: A new version of an application package has been
1979 * installed, replacing an existing version that was previously installed.
1980 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001981 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001982 * <ul>
1983 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1984 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001985 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001986 * <p class="note">This is a protected intent that can only be sent
1987 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1991 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001992 * Broadcast Action: A new version of your application has been installed
1993 * over an existing one. This is only sent to the application that was
1994 * replaced. It does not contain any additional data; to receive it, just
1995 * use an intent filter for this action.
1996 *
1997 * <p class="note">This is a protected intent that can only be sent
1998 * by the system.
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2002 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 * Broadcast Action: An existing application package has been removed from
2004 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002005 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002006 * <ul>
2007 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2008 * to the package.
2009 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2010 * application -- data and code -- is being removed.
2011 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2012 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2013 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002014 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002015 * <p class="note">This is a protected intent that can only be sent
2016 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2020 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002021 * Broadcast Action: An existing application package has been completely
2022 * removed from the device. The data contains the name of the package.
2023 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2024 * {@link #EXTRA_DATA_REMOVED} is true and
2025 * {@link #EXTRA_REPLACING} is false of that broadcast.
2026 *
2027 * <ul>
2028 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2029 * to the package.
2030 * </ul>
2031 *
2032 * <p class="note">This is a protected intent that can only be sent
2033 * by the system.
2034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_PACKAGE_FULLY_REMOVED
2037 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2038 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002039 * Broadcast Action: An existing application package has been changed (for
2040 * example, a component has been enabled or disabled). The data contains
2041 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002042 * <ul>
2043 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002044 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002045 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002046 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2047 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002048 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002049 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002050 * <p class="note">This is a protected intent that can only be sent
2051 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2055 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002056 * @hide
2057 * Broadcast Action: Ask system services if there is any reason to
2058 * restart the given package. The data contains the name of the
2059 * package.
2060 * <ul>
2061 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2062 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2063 * </ul>
2064 *
2065 * <p class="note">This is a protected intent that can only be sent
2066 * by the system.
2067 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002068 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002069 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2070 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2071 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002072 * Broadcast Action: The user has restarted a package, and all of its
2073 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002075 * be removed. Note that the restarted package does <em>not</em>
2076 * receive this broadcast.
2077 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 * <ul>
2079 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2080 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002081 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002082 * <p class="note">This is a protected intent that can only be sent
2083 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2087 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002088 * Broadcast Action: The user has cleared the data of a package. This should
2089 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002090 * its persistent data is erased and this broadcast sent.
2091 * Note that the cleared package does <em>not</em>
2092 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002093 * <ul>
2094 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2095 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002096 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002097 * <p class="note">This is a protected intent that can only be sent
2098 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2102 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002103 * Broadcast Action: Packages have been suspended.
2104 * <p>Includes the following extras:
2105 * <ul>
2106 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2107 * </ul>
2108 *
2109 * <p class="note">This is a protected intent that can only be sent
2110 * by the system. It is only sent to registered receivers.
2111 */
2112 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2113 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2114 /**
2115 * Broadcast Action: Packages have been unsuspended.
2116 * <p>Includes the following extras:
2117 * <ul>
2118 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2119 * </ul>
2120 *
2121 * <p class="note">This is a protected intent that can only be sent
2122 * by the system. It is only sent to registered receivers.
2123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2126 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127 * Broadcast Action: A user ID has been removed from the system. The user
2128 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002129 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002130 * <p class="note">This is a protected intent that can only be sent
2131 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 */
2133 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2134 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002135
2136 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002137 * Broadcast Action: Sent to the installer package of an application when
2138 * that application is first launched (that is the first time it is moved
2139 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002140 *
2141 * <p class="note">This is a protected intent that can only be sent
2142 * by the system.
2143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2146
2147 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002148 * Broadcast Action: Sent to the system package verifier when a package
2149 * needs to be verified. The data contains the package URI.
2150 * <p class="note">
2151 * This is a protected intent that can only be sent by the system.
2152 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2156
2157 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002158 * Broadcast Action: Sent to the system package verifier when a package is
2159 * verified. The data contains the package URI.
2160 * <p class="note">
2161 * This is a protected intent that can only be sent by the system.
2162 */
2163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2164 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2165
2166 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002167 * Broadcast Action: Sent to the system intent filter verifier when an
2168 * intent filter needs to be verified. The data contains the filter data
2169 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002170 * <p class="note">
2171 * This is a protected intent that can only be sent by the system.
2172 * </p>
2173 *
2174 * @hide
2175 */
2176 @SystemApi
2177 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2178 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2179
2180 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002181 * Broadcast Action: Resources for a set of packages (which were
2182 * previously unavailable) are currently
2183 * available since the media on which they exist is available.
2184 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2185 * list of packages whose availability changed.
2186 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2187 * list of uids of packages whose availability changed.
2188 * Note that the
2189 * packages in this list do <em>not</em> receive this broadcast.
2190 * The specified set of packages are now available on the system.
2191 * <p>Includes the following extras:
2192 * <ul>
2193 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2194 * whose resources(were previously unavailable) are currently available.
2195 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2196 * packages whose resources(were previously unavailable)
2197 * are currently available.
2198 * </ul>
2199 *
2200 * <p class="note">This is a protected intent that can only be sent
2201 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002202 */
2203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002204 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2205 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002206
2207 /**
2208 * Broadcast Action: Resources for a set of packages are currently
2209 * unavailable since the media on which they exist is unavailable.
2210 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2211 * list of packages whose availability changed.
2212 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2213 * list of uids of packages whose availability changed.
2214 * The specified set of packages can no longer be
2215 * launched and are practically unavailable on the system.
2216 * <p>Inclues the following extras:
2217 * <ul>
2218 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2219 * whose resources are no longer available.
2220 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2221 * whose resources are no longer available.
2222 * </ul>
2223 *
2224 * <p class="note">This is a protected intent that can only be sent
2225 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002226 */
2227 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002228 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002229 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002231 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002232 * Broadcast Action: preferred activities have changed *explicitly*.
2233 *
2234 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2235 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2236 * be sent.
2237 *
2238 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2239 *
2240 * @hide
2241 */
2242 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2243 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2244 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2245
2246
2247 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002248 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002249 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002250 * This should <em>only</em> be used to determine when the wallpaper
2251 * has changed to show the new wallpaper to the user. You should certainly
2252 * never, in response to this, change the wallpaper or other attributes of
2253 * it such as the suggested size. That would be crazy, right? You'd cause
2254 * all kinds of loops, especially if other apps are doing similar things,
2255 * right? Of course. So please don't do this.
2256 *
2257 * @deprecated Modern applications should use
2258 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2259 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2260 * shown behind their UI, rather than watching for this broadcast and
2261 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002262 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002263 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2265 /**
2266 * Broadcast Action: The current device {@link android.content.res.Configuration}
2267 * (orientation, locale, etc) has changed. When such a change happens, the
2268 * UIs (view hierarchy) will need to be rebuilt based on this new
2269 * information; for the most part, applications don't need to worry about
2270 * this, because the system will take care of stopping and restarting the
2271 * application to make sure it sees the new changes. Some system code that
2272 * can not be restarted will need to watch for this action and handle it
2273 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002274 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002275 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002276 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002277 * in manifests, only by explicitly registering for it with
2278 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2279 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002280 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002283 *
2284 * @see android.content.res.Configuration
2285 */
2286 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2287 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2288 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002289 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002290 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002291 * <p class="note">This is a protected intent that can only be sent
2292 * by the system.
2293 */
2294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2295 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2296 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002297 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2298 * charging state, level, and other information about the battery.
2299 * See {@link android.os.BatteryManager} for documentation on the
2300 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002301 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002303 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002304 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002305 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002306 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2307 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2308 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2309 * broadcasts that are sent and can be received through manifest
2310 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002311 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002312 * <p class="note">This is a protected intent that can only be sent
2313 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002314 */
2315 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2316 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2317 /**
2318 * Broadcast Action: Indicates low battery condition on the device.
2319 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002321 * <p class="note">This is a protected intent that can only be sent
2322 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002323 */
2324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2325 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2326 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002327 * Broadcast Action: Indicates the battery is now okay after being low.
2328 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2329 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002330 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2335 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2336 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002337 * Broadcast Action: External power has been connected to the device.
2338 * This is intended for applications that wish to register specifically to this notification.
2339 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2340 * stay active to receive this notification. This action can be used to implement actions
2341 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002342 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002347 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002348 /**
2349 * Broadcast Action: External power has been removed from the device.
2350 * This is intended for applications that wish to register specifically to this notification.
2351 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2352 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002353 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002354 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002355 * <p class="note">This is a protected intent that can only be sent
2356 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002357 */
2358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002359 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002360 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002361 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002362 * Broadcast Action: Device is shutting down.
2363 * This is broadcast when the device is being shut down (completely turned
2364 * off, not sleeping). Once the broadcast is complete, the final shutdown
2365 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002366 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002367 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002368 * <p class="note">This is a protected intent that can only be sent
2369 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002370 * <p>May include the following extras:
2371 * <ul>
2372 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2373 * shutdown is only for userspace processes. If not set, assumed to be false.
2374 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002377 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002378 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002379 * Activity Action: Start this activity to request system shutdown.
2380 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002381 * to request confirmation from the user before shutting down. The optional boolean
2382 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2383 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002384 *
2385 * <p class="note">This is a protected intent that can only be sent
2386 * by the system.
2387 *
2388 * {@hide}
2389 */
2390 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2391 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002392 * Broadcast Action: A sticky broadcast that indicates low memory
2393 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002394 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002395 * <p class="note">This is a protected intent that can only be sent
2396 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002397 */
2398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2399 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2400 /**
2401 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002402 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002403 * <p class="note">This is a protected intent that can only be sent
2404 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002405 */
2406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2407 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2408 /**
Jake Hambybb371632010-08-23 18:16:48 -07002409 * Broadcast Action: A sticky broadcast that indicates a memory full
2410 * condition on the device. This is intended for activities that want
2411 * to be able to fill the data partition completely, leaving only
2412 * enough free space to prevent system-wide SQLite failures.
2413 *
2414 * <p class="note">This is a protected intent that can only be sent
2415 * by the system.
2416 *
2417 * {@hide}
2418 */
2419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2420 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2421 /**
2422 * Broadcast Action: Indicates memory full condition on the device
2423 * no longer exists.
2424 *
2425 * <p class="note">This is a protected intent that can only be sent
2426 * by the system.
2427 *
2428 * {@hide}
2429 */
2430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2431 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2432 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002433 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2434 * and package management should be started.
2435 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2436 * notification.
2437 */
2438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2439 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2440 /**
2441 * Broadcast Action: The device has entered USB Mass Storage mode.
2442 * This is used mainly for the USB Settings panel.
2443 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2444 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002445 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002446 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002447 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002448 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2449
2450 /**
2451 * Broadcast Action: The device has exited USB Mass Storage mode.
2452 * This is used mainly for the USB Settings panel.
2453 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2454 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002455 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002456 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002457 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002458 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2459
2460 /**
2461 * Broadcast Action: External media has been removed.
2462 * The path to the mount point for the removed media is contained in the Intent.mData field.
2463 */
2464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2465 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2466
2467 /**
2468 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002469 * 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 -07002470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2473
2474 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002475 * Broadcast Action: External media is present, and being disk-checked
2476 * 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 -08002477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2480
2481 /**
2482 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2483 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002484 */
2485 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2486 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2487
2488 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002489 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002490 * 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 -07002491 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2492 * media was mounted read only.
2493 */
2494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2495 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2496
2497 /**
2498 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002499 * 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 -07002500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2502 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2503
2504 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002505 * Broadcast Action: External media is no longer being shared via USB mass storage.
2506 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2507 *
2508 * @hide
2509 */
2510 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2511
2512 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002513 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2514 * The path to the mount point for the removed media is contained in the Intent.mData field.
2515 */
2516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2517 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2518
2519 /**
2520 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002521 * 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 -07002522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2524 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2525
2526 /**
2527 * Broadcast Action: User has expressed the desire to remove the external storage media.
2528 * Applications should close all files they have open within the mount point when they receive this intent.
2529 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2530 */
2531 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2532 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2533
2534 /**
2535 * Broadcast Action: The media scanner has started scanning a directory.
2536 * The path to the directory being scanned is contained in the Intent.mData field.
2537 */
2538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2539 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2540
2541 /**
2542 * Broadcast Action: The media scanner has finished scanning a directory.
2543 * The path to the scanned directory is contained in the Intent.mData field.
2544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2547
2548 /**
2549 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2550 * The path to the file is contained in the Intent.mData field.
2551 */
2552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2553 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2554
2555 /**
2556 * Broadcast Action: The "Media Button" was pressed. Includes a single
2557 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2558 * caused the broadcast.
2559 */
2560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2561 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2562
2563 /**
2564 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2565 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2566 * caused the broadcast.
2567 */
2568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2569 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2570
2571 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2572 // location; they are not general-purpose actions.
2573
2574 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002575 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002576 */
2577 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2578 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2579 "android.intent.action.GTALK_CONNECTED";
2580
2581 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002582 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002583 */
2584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2585 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2586 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002587
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002588 /**
2589 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002590 */
2591 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2592 public static final String ACTION_INPUT_METHOD_CHANGED =
2593 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002594
2595 /**
2596 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2597 * more radios have been turned off or on. The intent will have the following extra value:</p>
2598 * <ul>
2599 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2600 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2601 * turned off</li>
2602 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002603 *
Peng Xua35b5532016-01-20 00:05:45 -08002604 * <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 -07002605 */
2606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2607 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2608
2609 /**
2610 * Broadcast Action: Some content providers have parts of their namespace
2611 * where they publish new events or items that the user may be especially
2612 * interested in. For these things, they may broadcast this action when the
2613 * set of interesting items change.
2614 *
2615 * For example, GmailProvider sends this notification when the set of unread
2616 * mail in the inbox changes.
2617 *
2618 * <p>The data of the intent identifies which part of which provider
2619 * changed. When queried through the content resolver, the data URI will
2620 * return the data set in question.
2621 *
2622 * <p>The intent will have the following extra values:
2623 * <ul>
2624 * <li><em>count</em> - The number of items in the data set. This is the
2625 * same as the number of items in the cursor returned by querying the
2626 * data URI. </li>
2627 * </ul>
2628 *
2629 * This intent will be sent at boot (if the count is non-zero) and when the
2630 * data set changes. It is possible for the data set to change without the
2631 * count changing (for example, if a new unread message arrives in the same
2632 * sync operation in which a message is archived). The phone should still
2633 * ring/vibrate/etc as normal in this case.
2634 */
2635 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2636 public static final String ACTION_PROVIDER_CHANGED =
2637 "android.intent.action.PROVIDER_CHANGED";
2638
2639 /**
2640 * Broadcast Action: Wired Headset plugged in or unplugged.
2641 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002642 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2643 * and documentation.
2644 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002645 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002646 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002649 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002650
2651 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002652 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2653 * <ul>
2654 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2655 * </ul>
2656 *
2657 * <p class="note">This is a protected intent that can only be sent
2658 * by the system.
2659 *
2660 * @hide
2661 */
2662 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2663 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2664 = "android.intent.action.ADVANCED_SETTINGS";
2665
2666 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002667 * Broadcast Action: Sent after application restrictions are changed.
2668 *
2669 * <p class="note">This is a protected intent that can only be sent
2670 * by the system.</p>
2671 */
2672 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2673 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2674 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2675
2676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002677 * Broadcast Action: An outgoing call is about to be placed.
2678 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002679 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002680 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002681 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002682 * the phone number originally intended to be dialed.</li>
2683 * </ul>
2684 * <p>Once the broadcast is finished, the resultData is used as the actual
2685 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002686 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002687 * outgoing call in turn: for example, a parental control application
2688 * might verify that the user is authorized to place the call at that
2689 * time, then a number-rewriting application might add an area code if
2690 * one was not specified.</p>
2691 * <p>For consistency, any receiver whose purpose is to prohibit phone
2692 * calls should have a priority of 0, to ensure it will see the final
2693 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002694 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002695 * should have a positive priority.
2696 * Negative priorities are reserved for the system for this broadcast;
2697 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002698 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2699 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002700 * <p>Emergency calls cannot be intercepted using this mechanism, and
2701 * other calls cannot be modified to call emergency numbers using this
2702 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002703 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2704 * call to use their own service instead. Those apps should first prevent
2705 * the call from being placed by setting resultData to <code>null</code>
2706 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002707 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002708 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2709 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002710 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002711 * <p class="note">This is a protected intent that can only be sent
2712 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 */
2714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2715 public static final String ACTION_NEW_OUTGOING_CALL =
2716 "android.intent.action.NEW_OUTGOING_CALL";
2717
2718 /**
2719 * Broadcast Action: Have the device reboot. This is only for use by
2720 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002721 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002722 * <p class="note">This is a protected intent that can only be sent
2723 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 */
2725 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2726 public static final String ACTION_REBOOT =
2727 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002728
Wei Huang97ecc9c2009-05-11 17:44:20 -07002729 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002730 * Broadcast Action: A sticky broadcast for changes in the physical
2731 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002732 *
2733 * <p>The intent will have the following extra values:
2734 * <ul>
2735 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002736 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002737 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002738 * <p>This is intended for monitoring the current physical dock state.
2739 * See {@link android.app.UiModeManager} for the normal API dealing with
2740 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002741 */
2742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2743 public static final String ACTION_DOCK_EVENT =
2744 "android.intent.action.DOCK_EVENT";
2745
2746 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002747 * Broadcast Action: A broadcast when idle maintenance can be started.
2748 * This means that the user is not interacting with the device and is
2749 * not expected to do so soon. Typical use of the idle maintenance is
2750 * to perform somehow expensive tasks that can be postponed at a moment
2751 * when they will not degrade user experience.
2752 * <p>
2753 * <p class="note">In order to keep the device responsive in case of an
2754 * unexpected user interaction, implementations of a maintenance task
2755 * should be interruptible. In such a scenario a broadcast with action
2756 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2757 * should not do the maintenance work in
2758 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2759 * maintenance service by {@link Context#startService(Intent)}. Also
2760 * you should hold a wake lock while your maintenance service is running
2761 * to prevent the device going to sleep.
2762 * </p>
2763 * <p>
2764 * <p class="note">This is a protected intent that can only be sent by
2765 * the system.
2766 * </p>
2767 *
2768 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002769 *
2770 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002771 */
2772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2773 public static final String ACTION_IDLE_MAINTENANCE_START =
2774 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2775
2776 /**
2777 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2778 * This means that the user was not interacting with the device as a result
2779 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2780 * was sent and now the user started interacting with the device. Typical
2781 * use of the idle maintenance is to perform somehow expensive tasks that
2782 * can be postponed at a moment when they will not degrade user experience.
2783 * <p>
2784 * <p class="note">In order to keep the device responsive in case of an
2785 * unexpected user interaction, implementations of a maintenance task
2786 * should be interruptible. Hence, on receiving a broadcast with this
2787 * action, the maintenance task should be interrupted as soon as possible.
2788 * In other words, you should not do the maintenance work in
2789 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2790 * maintenance service that was started on receiving of
2791 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2792 * lock you acquired when your maintenance service started.
2793 * </p>
2794 * <p class="note">This is a protected intent that can only be sent
2795 * by the system.
2796 *
2797 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002798 *
2799 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002800 */
2801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2802 public static final String ACTION_IDLE_MAINTENANCE_END =
2803 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2804
2805 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002806 * Broadcast Action: a remote intent is to be broadcasted.
2807 *
2808 * A remote intent is used for remote RPC between devices. The remote intent
2809 * is serialized and sent from one device to another device. The receiving
2810 * device parses the remote intent and broadcasts it. Note that anyone can
2811 * broadcast a remote intent. However, if the intent receiver of the remote intent
2812 * does not trust intent broadcasts from arbitrary intent senders, it should require
2813 * the sender to hold certain permissions so only trusted sender's broadcast will be
2814 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002815 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002816 */
2817 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002818 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002819
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002820 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002821 * Broadcast Action: This is broadcast once when the user is booting after a
2822 * system update. It can be used to perform cleanup or upgrades after a
2823 * system update.
2824 * <p>
2825 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2826 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2827 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2828 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002829 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002830 * @hide
2831 */
2832 public static final String ACTION_PRE_BOOT_COMPLETED =
2833 "android.intent.action.PRE_BOOT_COMPLETED";
2834
Amith Yamasani13593602012-03-22 16:16:17 -07002835 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002836 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002837 * on restricted users. The broadcast intent contains an extra
2838 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2839 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2840 * String[] depending on the restriction type.<p/>
2841 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002842 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2843 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2844 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002845 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2846 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002847 * @see RestrictionEntry
2848 */
2849 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2850 "android.intent.action.GET_RESTRICTION_ENTRIES";
2851
2852 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002853 * Sent the first time a user is starting, to allow system apps to
2854 * perform one time initialization. (This will not be seen by third
2855 * party applications because a newly initialized user does not have any
2856 * third party applications installed for it.) This is sent early in
2857 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002858 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2859 * broadcast, since it is part of a visible user interaction; be as quick
2860 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002861 */
2862 public static final String ACTION_USER_INITIALIZE =
2863 "android.intent.action.USER_INITIALIZE";
2864
2865 /**
2866 * Sent when a user switch is happening, causing the process's user to be
2867 * brought to the foreground. This is only sent to receivers registered
2868 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2869 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002870 * foreground. This is sent as a foreground
2871 * broadcast, since it is part of a visible user interaction; be as quick
2872 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002873 */
2874 public static final String ACTION_USER_FOREGROUND =
2875 "android.intent.action.USER_FOREGROUND";
2876
2877 /**
2878 * Sent when a user switch is happening, causing the process's user to be
2879 * sent to the background. This is only sent to receivers registered
2880 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2881 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002882 * background. This is sent as a foreground
2883 * broadcast, since it is part of a visible user interaction; be as quick
2884 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002885 */
2886 public static final String ACTION_USER_BACKGROUND =
2887 "android.intent.action.USER_BACKGROUND";
2888
2889 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002890 * Broadcast sent to the system when a user is added. Carries an extra
2891 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2892 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002893 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002894 * @hide
2895 */
2896 public static final String ACTION_USER_ADDED =
2897 "android.intent.action.USER_ADDED";
2898
2899 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002900 * Broadcast sent by the system when a user is started. Carries an extra
2901 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002902 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002903 * that has been started. This is sent as a foreground
2904 * broadcast, since it is part of a visible user interaction; be as quick
2905 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002906 * @hide
2907 */
2908 public static final String ACTION_USER_STARTED =
2909 "android.intent.action.USER_STARTED";
2910
2911 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002912 * Broadcast sent when a user is in the process of starting. Carries an extra
2913 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2914 * sent to registered receivers, not manifest receivers. It is sent to all
2915 * users (including the one that is being started). You must hold
2916 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2917 * this broadcast. This is sent as a background broadcast, since
2918 * its result is not part of the primary UX flow; to safely keep track of
2919 * started/stopped state of a user you can use this in conjunction with
2920 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2921 * other user state broadcasts since those are foreground broadcasts so can
2922 * execute in a different order.
2923 * @hide
2924 */
2925 public static final String ACTION_USER_STARTING =
2926 "android.intent.action.USER_STARTING";
2927
2928 /**
2929 * Broadcast sent when a user is going to be stopped. Carries an extra
2930 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2931 * sent to registered receivers, not manifest receivers. It is sent to all
2932 * users (including the one that is being stopped). You must hold
2933 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2934 * this broadcast. The user will not stop until all receivers have
2935 * handled the broadcast. This is sent as a background broadcast, since
2936 * its result is not part of the primary UX flow; to safely keep track of
2937 * started/stopped state of a user you can use this in conjunction with
2938 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2939 * other user state broadcasts since those are foreground broadcasts so can
2940 * execute in a different order.
2941 * @hide
2942 */
2943 public static final String ACTION_USER_STOPPING =
2944 "android.intent.action.USER_STOPPING";
2945
2946 /**
2947 * Broadcast sent to the system when a user is stopped. Carries an extra
2948 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2949 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2950 * specific package. This is only sent to registered receivers, not manifest
2951 * receivers. It is sent to all running users <em>except</em> the one that
2952 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002953 * @hide
2954 */
2955 public static final String ACTION_USER_STOPPED =
2956 "android.intent.action.USER_STOPPED";
2957
2958 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002959 * 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 -07002960 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002961 * one that has been removed. The user will not be completely removed until all receivers have
2962 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002963 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002964 * @hide
2965 */
2966 public static final String ACTION_USER_REMOVED =
2967 "android.intent.action.USER_REMOVED";
2968
2969 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002970 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002971 * the userHandle of the user to become the current one. This is only sent to
2972 * registered receivers, not manifest receivers. It is sent to all running users.
2973 * You must hold
2974 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002975 * @hide
2976 */
2977 public static final String ACTION_USER_SWITCHED =
2978 "android.intent.action.USER_SWITCHED";
2979
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002980 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002981 * Broadcast Action: Sent when the credential-encrypted private storage has
2982 * become unlocked for the target user. This is only sent to registered
2983 * receivers, not manifest receivers.
2984 */
2985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2986 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2987
2988 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002989 * Broadcast sent to the system when a user's information changes. Carries an extra
2990 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002991 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002992 * @hide
2993 */
2994 public static final String ACTION_USER_INFO_CHANGED =
2995 "android.intent.action.USER_INFO_CHANGED";
2996
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002997 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002998 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2999 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003000 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3001 * that need to display merged content across both primary and managed profiles need to
3002 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003003 * not manifest receivers.
3004 */
3005 public static final String ACTION_MANAGED_PROFILE_ADDED =
3006 "android.intent.action.MANAGED_PROFILE_ADDED";
3007
3008 /**
3009 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003010 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3011 * Only applications (for example Launchers) that need to display merged content across both
3012 * primary and managed profiles need to worry about this broadcast. This is only sent to
3013 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003014 */
3015 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3016 "android.intent.action.MANAGED_PROFILE_REMOVED";
3017
3018 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003019 * Broadcast sent to the primary user when the credential-encrypted private storage for
3020 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3021 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3022 * Launchers) that need to display merged content across both primary and managed profiles
3023 * need to worry about this broadcast. This is only sent to registered receivers,
3024 * not manifest receivers.
3025 */
3026 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3027 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3028
3029 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003030 * Broadcast sent to the primary user when an associated managed profile has become available.
3031 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003032 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3033 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3034 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003035 */
Rubin Xue95057a2016-04-01 16:49:25 +01003036 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3037 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3038
3039 /**
3040 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3041 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3042 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3043 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3044 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3045 */
3046 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3047 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003048
3049 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003050 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3051 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3052 * the device was locked or unlocked.
3053 *
3054 * This is only sent to registered receivers.
3055 *
3056 * @hide
3057 */
3058 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3059 "android.intent.action.DEVICE_LOCKED_CHANGED";
3060
3061 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003062 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3063 */
3064 public static final String ACTION_QUICK_CLOCK =
3065 "android.intent.action.QUICK_CLOCK";
3066
Michael Wright0087a142013-02-05 16:29:39 -08003067 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003068 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003069 * @hide
3070 */
3071 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3072 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3073
Justin Kohd378ad72013-04-01 12:18:26 -07003074 /**
3075 * Broadcast Action: A global button was pressed. Includes a single
3076 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3077 * caused the broadcast.
3078 * @hide
3079 */
3080 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3081
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003082 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003083 * Broadcast Action: Sent when media resource is granted.
3084 * <p>
3085 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3086 * granted.
3087 * </p>
3088 * <p class="note">
3089 * This is a protected intent that can only be sent by the system.
3090 * </p>
3091 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003092 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003093 * </p>
3094 *
3095 * @hide
3096 */
3097 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3098 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3099
3100 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003101 * Activity Action: Allow the user to select and return one or more existing
3102 * documents. When invoked, the system will display the various
3103 * {@link DocumentsProvider} instances installed on the device, letting the
3104 * user interactively navigate through them. These documents include local
3105 * media, such as photos and video, and documents provided by installed
3106 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003107 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003108 * Each document is represented as a {@code content://} URI backed by a
3109 * {@link DocumentsProvider}, which can be opened as a stream with
3110 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3111 * {@link android.provider.DocumentsContract.Document} metadata.
3112 * <p>
3113 * All selected documents are returned to the calling application with
3114 * persistable read and write permission grants. If you want to maintain
3115 * access to the documents across device reboots, you need to explicitly
3116 * take the persistable permissions using
3117 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3118 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003119 * Callers must indicate the acceptable document MIME types through
3120 * {@link #setType(String)}. For example, to select photos, use
3121 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3122 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3123 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003124 * <p>
3125 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003126 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3127 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003128 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003129 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3130 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003131 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003132 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003133 * Callers can set a document URI through
3134 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3135 * location of documents navigator. System will do its best to launch the
3136 * navigator in the specified document if it's a folder, or the folder that
3137 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003138 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003139 * Output: The URI of the item that was picked, returned in
3140 * {@link #getData()}. This must be a {@code content://} URI so that any
3141 * receiver can access it. If multiple documents were selected, they are
3142 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003143 *
3144 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003145 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003146 * @see #ACTION_CREATE_DOCUMENT
3147 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003148 */
3149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3150 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3151
3152 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003153 * Activity Action: Allow the user to create a new document. When invoked,
3154 * the system will display the various {@link DocumentsProvider} instances
3155 * installed on the device, letting the user navigate through them. The
3156 * returned document may be a newly created document with no content, or it
3157 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003158 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003159 * Each document is represented as a {@code content://} URI backed by a
3160 * {@link DocumentsProvider}, which can be opened as a stream with
3161 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3162 * {@link android.provider.DocumentsContract.Document} metadata.
3163 * <p>
3164 * Callers must indicate the concrete MIME type of the document being
3165 * created by setting {@link #setType(String)}. This MIME type cannot be
3166 * changed after the document is created.
3167 * <p>
3168 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3169 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003170 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003171 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3172 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003173 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003174 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003175 * Callers can set a document URI through
3176 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3177 * location of documents navigator. System will do its best to launch the
3178 * navigator in the specified document if it's a folder, or the folder that
3179 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003180 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003181 * Output: The URI of the item that was created. This must be a
3182 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003183 *
3184 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003185 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003186 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003187 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003188 */
3189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3190 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3191
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003192 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003193 * Activity Action: Allow the user to pick a directory subtree. When
3194 * invoked, the system will display the various {@link DocumentsProvider}
3195 * instances installed on the device, letting the user navigate through
3196 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003197 * <p>
3198 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003199 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3200 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3201 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003202 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003203 * Callers can set a document URI through
3204 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3205 * location of documents navigator. System will do its best to launch the
3206 * navigator in the specified document if it's a folder, or the folder that
3207 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003208 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003209 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003210 *
3211 * @see DocumentsContract
3212 */
3213 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003214 public static final String
3215 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003216
Felipe Lemec7b1f892016-01-15 15:02:31 -08003217 /**
Peng Xua35b5532016-01-20 00:05:45 -08003218 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3219 * exisiting sensor being disconnected.
3220 *
3221 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3222 *
3223 * {@hide}
3224 */
3225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3226 public static final String
3227 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3228
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003229 /** {@hide} */
3230 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3231
Christopher Tate6597e342015-02-17 12:15:25 -08003232 /**
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003233 * Boolean intent extra to be used with {@link ACTION_MASTER_CLEAR} in order to force a factory
3234 * reset even if {@link android.os.UserManager.DISALLOW_FACTORY_RESET} is set.
3235 * @hide
3236 */
3237 public static final String EXTRA_FORCE_MASTER_CLEAR =
3238 "android.intent.extra.FORCE_MASTER_CLEAR";
3239
3240 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003241 * Broadcast action: report that a settings element is being restored from backup. The intent
3242 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3243 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3244 * is the value of that settings entry prior to the restore operation. All of these values are
3245 * represented as strings.
3246 *
3247 * <p>This broadcast is sent only for settings provider entries known to require special handling
3248 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3249 * the provider's backup agent implementation.
3250 *
3251 * @see #EXTRA_SETTING_NAME
3252 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3253 * @see #EXTRA_SETTING_NEW_VALUE
3254 * {@hide}
3255 */
3256 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3257
3258 /** {@hide} */
3259 public static final String EXTRA_SETTING_NAME = "setting_name";
3260 /** {@hide} */
3261 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3262 /** {@hide} */
3263 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3264
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003265 /**
3266 * Activity Action: Process a piece of text.
3267 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3268 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3269 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3270 */
3271 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3272 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3273 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003274 * The name of the extra used to define the text to be processed, as a
3275 * CharSequence. Note that this may be a styled CharSequence, so you must use
3276 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003277 */
3278 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3279 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003280 * 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 +00003281 */
3282 public static final String EXTRA_PROCESS_TEXT_READONLY =
3283 "android.intent.extra.PROCESS_TEXT_READONLY";
3284
Bryce Leebc58f592015-09-25 16:43:01 -07003285 /**
3286 * Broadcast action: reports when a new thermal event has been reached. When the device
3287 * is reaching its maximum temperatue, the thermal level reported
3288 * {@hide}
3289 */
3290 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3291 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3292
3293 /** {@hide} */
3294 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3295
3296 /**
3297 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003298 * {@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_NORMAL = 0;
3302
3303 /**
3304 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003305 * the {@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_WARNING = 1;
3309
3310 /**
3311 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003312 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003313 * {@hide}
3314 */
3315 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3316
3317
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003318 // ---------------------------------------------------------------------
3319 // ---------------------------------------------------------------------
3320 // Standard intent categories (see addCategory()).
3321
3322 /**
3323 * Set if the activity should be an option for the default action
3324 * (center press) to perform on a piece of data. Setting this will
3325 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003326 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003327 * Intent when initiating an action -- it is for use in intent filters
3328 * specified in packages.
3329 */
3330 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3331 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3332 /**
3333 * Activities that can be safely invoked from a browser must support this
3334 * category. For example, if the user is viewing a web page or an e-mail
3335 * and clicks on a link in the text, the Intent generated execute that
3336 * link will require the BROWSABLE category, so that only activities
3337 * supporting this category will be considered as possible actions. By
3338 * supporting this category, you are promising that there is nothing
3339 * damaging (without user intervention) that can happen by invoking any
3340 * matching Intent.
3341 */
3342 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3343 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3344 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003345 * Categories for activities that can participate in voice interaction.
3346 * An activity that supports this category must be prepared to run with
3347 * no UI shown at all (though in some case it may have a UI shown), and
3348 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3349 */
3350 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3351 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3352 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003353 * Set if the activity should be considered as an alternative action to
3354 * the data the user is currently viewing. See also
3355 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3356 * applies to the selection in a list of items.
3357 *
3358 * <p>Supporting this category means that you would like your activity to be
3359 * displayed in the set of alternative things the user can do, usually as
3360 * part of the current activity's options menu. You will usually want to
3361 * include a specific label in the &lt;intent-filter&gt; of this action
3362 * describing to the user what it does.
3363 *
3364 * <p>The action of IntentFilter with this category is important in that it
3365 * describes the specific action the target will perform. This generally
3366 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3367 * a specific name such as "com.android.camera.action.CROP. Only one
3368 * alternative of any particular action will be shown to the user, so using
3369 * a specific action like this makes sure that your alternative will be
3370 * displayed while also allowing other applications to provide their own
3371 * overrides of that particular action.
3372 */
3373 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3374 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3375 /**
3376 * Set if the activity should be considered as an alternative selection
3377 * action to the data the user has currently selected. This is like
3378 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3379 * of items from which the user can select, giving them alternatives to the
3380 * default action that will be performed on it.
3381 */
3382 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3383 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3384 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003385 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003386 */
3387 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3388 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3389 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003390 * Should be displayed in the top-level launcher.
3391 */
3392 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3393 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3394 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003395 * Indicates an activity optimized for Leanback mode, and that should
3396 * be displayed in the Leanback launcher.
3397 */
3398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3399 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3400 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003401 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3402 * @hide
3403 */
3404 @SystemApi
3405 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3406 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003407 * Provides information about the package it is in; typically used if
3408 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3409 * a front-door to the user without having to be shown in the all apps list.
3410 */
3411 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3412 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3413 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003414 * This is the home activity, that is the first activity that is displayed
3415 * when the device boots.
3416 */
3417 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3418 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3419 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003420 * This is the home activity that is displayed when the device is finished setting up and ready
3421 * for use.
3422 * @hide
3423 */
3424 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3425 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3426 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003427 * This is the setup wizard activity, that is the first activity that is displayed
3428 * when the user sets up the device for the first time.
3429 * @hide
3430 */
3431 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3432 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3433 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003434 * This activity is a preference panel.
3435 */
3436 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3437 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3438 /**
3439 * This activity is a development preference panel.
3440 */
3441 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3442 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3443 /**
3444 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003445 */
3446 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3447 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3448 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003449 * This activity allows the user to browse and download new applications.
3450 */
3451 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3452 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3453 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003454 * This activity may be exercised by the monkey or other automated test tools.
3455 */
3456 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3457 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3458 /**
3459 * To be used as a test (not part of the normal user experience).
3460 */
3461 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3462 /**
3463 * To be used as a unit test (run through the Test Harness).
3464 */
3465 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3466 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003467 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 * experience).
3469 */
3470 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003471
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003472 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003473 * Used to indicate that an intent only wants URIs that can be opened with
3474 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3475 * must support at least the columns defined in {@link OpenableColumns} when
3476 * queried.
3477 *
3478 * @see #ACTION_GET_CONTENT
3479 * @see #ACTION_OPEN_DOCUMENT
3480 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481 */
3482 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3483 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3484
3485 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003486 * Used to indicate that an intent filter can accept files which are not necessarily
3487 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3488 * at least streamable via
3489 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3490 * using one of the stream types exposed via
3491 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3492 *
3493 * @see #ACTION_SEND
3494 * @see #ACTION_SEND_MULTIPLE
3495 */
3496 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3497 public static final String CATEGORY_TYPED_OPENABLE =
3498 "android.intent.category.TYPED_OPENABLE";
3499
3500 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003501 * To be used as code under test for framework instrumentation tests.
3502 */
3503 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3504 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003505 /**
3506 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003507 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3508 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3512 /**
3513 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003514 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3515 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003516 */
3517 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3518 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003519 /**
3520 * An activity to run when device is inserted into a analog (low end) dock.
3521 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3522 * information, see {@link android.app.UiModeManager}.
3523 */
3524 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3525 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3526
3527 /**
3528 * An activity to run when device is inserted into a digital (high end) dock.
3529 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3530 * information, see {@link android.app.UiModeManager}.
3531 */
3532 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3533 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003534
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003535 /**
3536 * Used to indicate that the activity can be used in a car environment.
3537 */
3538 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3539 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3540
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003541 // ---------------------------------------------------------------------
3542 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003543 // Application launch intent categories (see addCategory()).
3544
3545 /**
3546 * Used with {@link #ACTION_MAIN} to launch the browser application.
3547 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003548 * <p>NOTE: This should not be used as the primary key of an Intent,
3549 * since it will not result in the app launching with the correct
3550 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003551 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003552 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003553 */
3554 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3555 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3556
3557 /**
3558 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3559 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003560 * <p>NOTE: This should not be used as the primary key of an Intent,
3561 * since it will not result in the app launching with the correct
3562 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003563 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003564 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003565 */
3566 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3567 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3568
3569 /**
3570 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3571 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003572 * <p>NOTE: This should not be used as the primary key of an Intent,
3573 * since it will not result in the app launching with the correct
3574 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003575 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003576 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003577 */
3578 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3579 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3580
3581 /**
3582 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3583 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003584 * <p>NOTE: This should not be used as the primary key of an Intent,
3585 * since it will not result in the app launching with the correct
3586 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003587 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003588 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003589 */
3590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3591 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3592
3593 /**
3594 * Used with {@link #ACTION_MAIN} to launch the email application.
3595 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003596 * <p>NOTE: This should not be used as the primary key of an Intent,
3597 * since it will not result in the app launching with the correct
3598 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003599 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003600 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003601 */
3602 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3603 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3604
3605 /**
3606 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3607 * The activity should be able to view and manipulate image and video files
3608 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003609 * <p>NOTE: This should not be used as the primary key of an Intent,
3610 * since it will not result in the app launching with the correct
3611 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003612 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003613 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003614 */
3615 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3616 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3617
3618 /**
3619 * Used with {@link #ACTION_MAIN} to launch the maps application.
3620 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003621 * <p>NOTE: This should not be used as the primary key of an Intent,
3622 * since it will not result in the app launching with the correct
3623 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003624 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003625 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003626 */
3627 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3628 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3629
3630 /**
3631 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3632 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003633 * <p>NOTE: This should not be used as the primary key of an Intent,
3634 * since it will not result in the app launching with the correct
3635 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003636 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003637 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003638 */
3639 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3640 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3641
3642 /**
3643 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003644 * The activity should be able to play, browse, or manipulate music files
3645 * stored on the device.
3646 * <p>NOTE: This should not be used as the primary key of an Intent,
3647 * since it will not result in the app launching with the correct
3648 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003649 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003650 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003651 */
3652 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3653 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3654
3655 // ---------------------------------------------------------------------
3656 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 // Standard extra data keys.
3658
3659 /**
3660 * The initial data to place in a newly created record. Use with
3661 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3662 * fields as would be given to the underlying ContentProvider.insert()
3663 * call.
3664 */
3665 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3666
3667 /**
3668 * A constant CharSequence that is associated with the Intent, used with
3669 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3670 * this may be a styled CharSequence, so you must use
3671 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3672 * retrieve it.
3673 */
3674 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3675
3676 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003677 * A constant String that is associated with the Intent, used with
3678 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3679 * as HTML formatted text. Note that you <em>must</em> also supply
3680 * {@link #EXTRA_TEXT}.
3681 */
3682 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3683
3684 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003685 * A content: URI holding a stream of data associated with the Intent,
3686 * used with {@link #ACTION_SEND} to supply the data being sent.
3687 */
3688 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3689
3690 /**
3691 * A String[] holding e-mail addresses that should be delivered to.
3692 */
3693 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3694
3695 /**
3696 * A String[] holding e-mail addresses that should be carbon copied.
3697 */
3698 public static final String EXTRA_CC = "android.intent.extra.CC";
3699
3700 /**
3701 * A String[] holding e-mail addresses that should be blind carbon copied.
3702 */
3703 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3704
3705 /**
3706 * A constant string holding the desired subject line of a message.
3707 */
3708 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3709
3710 /**
3711 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003712 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003713 */
3714 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3715
3716 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003717 * An int representing the user id to be used.
3718 *
3719 * @hide
3720 */
3721 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3722
3723 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003724 * An int representing the task id to be retrieved. This is used when a launch from recents is
3725 * intercepted by another action such as credentials confirmation to remember which task should
3726 * be resumed when complete.
3727 *
3728 * @hide
3729 */
3730 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3731
3732 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003733 * An Intent[] describing additional, alternate choices you would like shown with
3734 * {@link #ACTION_CHOOSER}.
3735 *
3736 * <p>An app may be capable of providing several different payload types to complete a
3737 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3738 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3739 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3740 * photo data or a hosted link where the photos can be viewed.</p>
3741 *
3742 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3743 * first/primary/preferred intent in the set. Additional intents specified in
3744 * this extra are ordered; by default intents that appear earlier in the array will be
3745 * preferred over intents that appear later in the array as matches for the same
3746 * target component. To alter this preference, a calling app may also supply
3747 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3748 */
3749 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3750
3751 /**
Adam Powell52c39212016-04-07 15:14:18 -07003752 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3753 * and omitted from a list of components presented to the user.
3754 *
3755 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3756 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3757 * from your own package or other apps from your organization if the idea of sending to those
3758 * targets would be redundant with other app functionality. Filtered components will not
3759 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3760 */
3761 public static final String EXTRA_EXCLUDE_COMPONENTS
3762 = "android.intent.extra.EXCLUDE_COMPONENTS";
3763
3764 /**
3765 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3766 * describing additional high-priority deep-link targets for the chooser to present to the user.
3767 *
3768 * <p>Targets provided in this way will be presented inline with all other targets provided
3769 * by services from other apps. They will be prioritized before other service targets, but
3770 * after those targets provided by sources that the user has manually pinned to the front.</p>
3771 *
3772 * @see #ACTION_CHOOSER
3773 */
3774 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3775
3776 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003777 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3778 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3779 *
3780 * <p>An app preparing an action for another app to complete may wish to allow the user to
3781 * disambiguate between several options for completing the action based on the chosen target
3782 * or otherwise refine the action before it is invoked.
3783 * </p>
3784 *
3785 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3786 * <ul>
3787 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3788 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3789 * chosen target beyond the first</li>
3790 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3791 * should fill in and send once the disambiguation is complete</li>
3792 * </ul>
3793 */
3794 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3795 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3796
3797 /**
3798 * A {@link ResultReceiver} used to return data back to the sender.
3799 *
3800 * <p>Used to complete an app-specific
3801 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3802 *
3803 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3804 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3805 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3806 * when the user selects a target component from the chooser. It is up to the recipient
3807 * to send a result to this ResultReceiver to signal that disambiguation is complete
3808 * and that the chooser should invoke the user's choice.</p>
3809 *
3810 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3811 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3812 * to match and fill in the final Intent or ChooserTarget before starting it.
3813 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3814 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3815 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3816 *
3817 * <p>The result code passed to the ResultReceiver should be
3818 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3819 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3820 * the chooser should finish without starting a target.</p>
3821 */
3822 public static final String EXTRA_RESULT_RECEIVER
3823 = "android.intent.extra.RESULT_RECEIVER";
3824
3825 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003826 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003827 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003828 */
3829 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3830
3831 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003832 * A Parcelable[] of {@link Intent} or
3833 * {@link android.content.pm.LabeledIntent} objects as set with
3834 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3835 * a the front of the list of choices, when shown to the user with a
3836 * {@link #ACTION_CHOOSER}.
3837 */
3838 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3839
3840 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003841 * A {@link IntentSender} to start after ephemeral installation success.
3842 * @hide
3843 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003844 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3845
3846 /**
3847 * A {@link IntentSender} to start after ephemeral installation failure.
3848 * @hide
3849 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003850 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3851
3852 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08003853 * The host name that triggered an ephemeral resolution.
3854 * @hide
3855 */
3856 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
3857
3858 /**
3859 * An opaque token to track ephemeral resolution.
3860 * @hide
3861 */
3862 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
3863
3864 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003865 * A Bundle forming a mapping of potential target package names to different extras Bundles
3866 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3867 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3868 * be currently installed on the device.
3869 *
3870 * <p>An application may choose to provide alternate extras for the case where a user
3871 * selects an activity from a predetermined set of target packages. If the activity
3872 * the user selects from the chooser belongs to a package with its package name as
3873 * a key in this bundle, the corresponding extras for that package will be merged with
3874 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3875 * extra has the same key as an extra already present in the intent it will overwrite
3876 * the extra from the intent.</p>
3877 *
3878 * <p><em>Examples:</em>
3879 * <ul>
3880 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3881 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3882 * parameters for that target.</li>
3883 * <li>An application may offer additional metadata for known targets of a given intent
3884 * to pass along information only relevant to that target such as account or content
3885 * identifiers already known to that application.</li>
3886 * </ul></p>
3887 */
3888 public static final String EXTRA_REPLACEMENT_EXTRAS =
3889 "android.intent.extra.REPLACEMENT_EXTRAS";
3890
3891 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003892 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3893 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3894 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3895 * {@link ComponentName} of the chosen component.
3896 *
3897 * <p>In some situations this callback may never come, for example if the user abandons
3898 * the chooser, switches to another task or any number of other reasons. Apps should not
3899 * be written assuming that this callback will always occur.</p>
3900 */
3901 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3902 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3903
3904 /**
3905 * The {@link ComponentName} chosen by the user to complete an action.
3906 *
3907 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3908 */
3909 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3910
3911 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003912 * A {@link android.view.KeyEvent} object containing the event that
3913 * triggered the creation of the Intent it is in.
3914 */
3915 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3916
3917 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003918 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3919 * before shutting down.
3920 *
3921 * {@hide}
3922 */
3923 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3924
3925 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003926 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3927 * requested by the user.
3928 *
3929 * {@hide}
3930 */
3931 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3932 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3933
3934 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003935 * 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 -07003936 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3937 * of restarting the application.
3938 */
3939 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3940
3941 /**
3942 * A String holding the phone number originally entered in
3943 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3944 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3945 */
3946 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003947
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948 /**
3949 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3950 * intents to supply the uid the package had been assigned. Also an optional
3951 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3952 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3953 * purpose.
3954 */
3955 public static final String EXTRA_UID = "android.intent.extra.UID";
3956
3957 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003958 * @hide String array of package names.
3959 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003960 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003961 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3962
3963 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003964 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3965 * intents to indicate whether this represents a full uninstall (removing
3966 * both the code and its data) or a partial uninstall (leaving its data,
3967 * implying that this is an update).
3968 */
3969 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003970
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003971 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003972 * @hide
3973 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3974 * intents to indicate that at this point the package has been removed for
3975 * all users on the device.
3976 */
3977 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3978 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3979
3980 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003981 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3982 * intents to indicate that this is a replacement of the package, so this
3983 * broadcast will immediately be followed by an add broadcast for a
3984 * different version of the same package.
3985 */
3986 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003987
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003988 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003989 * Used as an int extra field in {@link android.app.AlarmManager} intents
3990 * to tell the application being invoked how many pending alarms are being
3991 * delievered with the intent. For one-shot alarms this will always be 1.
3992 * For recurring alarms, this might be greater than 1 if the device was
3993 * asleep or powered off at the time an earlier alarm would have been
3994 * delivered.
3995 */
3996 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003997
Jacek Surazski86b6c532009-05-13 14:38:28 +02003998 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003999 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4000 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004001 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4002 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004003 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4004 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4005 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004006 */
4007 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4008
4009 /**
4010 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4011 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004012 */
4013 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4014
4015 /**
4016 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4017 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004018 */
4019 public static final int EXTRA_DOCK_STATE_DESK = 1;
4020
4021 /**
4022 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4023 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004024 */
4025 public static final int EXTRA_DOCK_STATE_CAR = 2;
4026
4027 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004028 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4029 * to represent that the phone is in a analog (low end) dock.
4030 */
4031 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4032
4033 /**
4034 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4035 * to represent that the phone is in a digital (high end) dock.
4036 */
4037 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4038
4039 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004040 * Boolean that can be supplied as meta-data with a dock activity, to
4041 * indicate that the dock should take over the home key when it is active.
4042 */
4043 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004044
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004045 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004046 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4047 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004048 */
4049 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4050
4051 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004052 * Used in the extra field in the remote intent. It's astring token passed with the
4053 * remote intent.
4054 */
4055 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4056 "android.intent.extra.remote_intent_token";
4057
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004058 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004059 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004060 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004061 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004062 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004063 "android.intent.extra.changed_component_name";
4064
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004065 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004066 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004067 * and contains a string array of all of the components that have changed. If
4068 * the state of the overall package has changed, then it will contain an entry
4069 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004070 */
4071 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4072 "android.intent.extra.changed_component_name_list";
4073
4074 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004075 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004076 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004077 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4078 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4079 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004080 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004081 */
4082 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4083 "android.intent.extra.changed_package_list";
4084
4085 /**
4086 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004087 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4088 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004089 * and contains an integer array of uids of all of the components
4090 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004091 */
4092 public static final String EXTRA_CHANGED_UID_LIST =
4093 "android.intent.extra.changed_uid_list";
4094
4095 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004096 * @hide
4097 * Magic extra system code can use when binding, to give a label for
4098 * who it is that has bound to a service. This is an integer giving
4099 * a framework string resource that can be displayed to the user.
4100 */
4101 public static final String EXTRA_CLIENT_LABEL =
4102 "android.intent.extra.client_label";
4103
4104 /**
4105 * @hide
4106 * Magic extra system code can use when binding, to give a PendingIntent object
4107 * that can be launched for the user to disable the system's use of this
4108 * service.
4109 */
4110 public static final String EXTRA_CLIENT_INTENT =
4111 "android.intent.extra.client_intent";
4112
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004113 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004114 * Extra used to indicate that an intent should only return data that is on
4115 * the local device. This is a boolean extra; the default is false. If true,
4116 * an implementation should only allow the user to select data that is
4117 * already on the device, not requiring it be downloaded from a remote
4118 * service when opened.
4119 *
4120 * @see #ACTION_GET_CONTENT
4121 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004122 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004123 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004124 */
4125 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004126 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004127
Amith Yamasani13593602012-03-22 16:16:17 -07004128 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004129 * Extra used to indicate that an intent can allow the user to select and
4130 * return multiple items. This is a boolean extra; the default is false. If
4131 * true, an implementation is allowed to present the user with a UI where
4132 * they can pick multiple items that are all returned to the caller. When
4133 * this happens, they should be returned as the {@link #getClipData()} part
4134 * of the result Intent.
4135 *
4136 * @see #ACTION_GET_CONTENT
4137 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004138 */
4139 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004140 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004141
4142 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004143 * The integer userHandle carried with broadcast intents related to addition, removal and
4144 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4145 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4146 *
Amith Yamasani13593602012-03-22 16:16:17 -07004147 * @hide
4148 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004149 public static final String EXTRA_USER_HANDLE =
4150 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004151
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004152 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004153 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4154 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4155 */
4156 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004157 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004158
4159 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004160 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004161 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4162 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004163 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004164 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4165
4166 /**
4167 * Extra sent in the intent to the BroadcastReceiver that handles
4168 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4169 * the restrictions as key/value pairs.
4170 */
4171 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4172 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004173
Amith Yamasani86118ba2013-03-28 14:33:16 -07004174 /**
4175 * Extra used in the response from a BroadcastReceiver that handles
4176 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4177 */
4178 public static final String EXTRA_RESTRICTIONS_INTENT =
4179 "android.intent.extra.restrictions_intent";
4180
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004181 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004182 * Extra used to communicate a set of acceptable MIME types. The type of the
4183 * extra is {@code String[]}. Values may be a combination of concrete MIME
4184 * types (such as "image/png") and/or partial MIME types (such as
4185 * "audio/*").
4186 *
4187 * @see #ACTION_GET_CONTENT
4188 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004189 */
4190 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4191
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004192 /**
4193 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4194 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004195 * When this is true, hardware devices can use this information to determine that
4196 * they shouldn't do a complete shutdown of their device since this is not a
4197 * complete shutdown down to the kernel, but only user space restarting.
4198 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004199 */
4200 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4201 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4202
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004203 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004204 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4205 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4206 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4207 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004208 *
4209 * @hide for internal use only.
4210 */
4211 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4212 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004213 /** @hide */
4214 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4215 /** @hide */
4216 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4217 /** @hide */
4218 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004219
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004220 /** {@hide} */
4221 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4222
Rubin Xue8490f12015-06-25 12:17:48 +01004223 /** {@hide} */
4224 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4225
Santos Cordon15a13782015-03-31 18:32:31 -07004226 /**
4227 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4228 * activation request.
4229 * TODO: Add information about the structure and response data used with the pending intent.
4230 * @hide
4231 */
4232 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4233 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4234
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004235 /**
4236 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004237 *
4238 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004239 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004240 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4241
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004242 /**
4243 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004244 * When a profile goes into quiet mode, all apps in the profile are killed and the
4245 * profile user is stopped. Widgets originating from the profile are masked, and app
4246 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004247 */
4248 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004249
4250 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004251 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004252 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004253 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4254 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004255 *
4256 * @hide
4257 */
4258 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4259 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4260
4261 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004262 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4263 * whether to show the chooser or not when there is only one application available
4264 * to choose from.
4265 *
4266 * @hide
4267 */
4268 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4269 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4270
4271 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004272 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004273 * to represent that a video codec is allowed to use.
4274 *
4275 * @hide
4276 */
4277 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4278
4279 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004280 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004281 * to represent that a audio codec is allowed to use.
4282 *
4283 * @hide
4284 */
4285 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4286
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004287 // ---------------------------------------------------------------------
4288 // ---------------------------------------------------------------------
4289 // Intent flags (see mFlags variable).
4290
Tor Norbyed9273d62013-05-30 15:59:53 -07004291 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004292 @IntDef(flag = true, value = {
4293 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4294 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004295 @Retention(RetentionPolicy.SOURCE)
4296 public @interface GrantUriMode {}
4297
Jeff Sharkey846318a2014-04-04 12:12:41 -07004298 /** @hide */
4299 @IntDef(flag = true, value = {
4300 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4301 @Retention(RetentionPolicy.SOURCE)
4302 public @interface AccessUriMode {}
4303
4304 /**
4305 * Test if given mode flags specify an access mode, which must be at least
4306 * read and/or write.
4307 *
4308 * @hide
4309 */
4310 public static boolean isAccessUriMode(int modeFlags) {
4311 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4312 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4313 }
4314
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004315 /**
4316 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004317 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004318 * specified in its ClipData. When applying to an Intent's ClipData,
4319 * all URIs as well as recursive traversals through data or other ClipData
4320 * in Intent items will be granted; only the grant flags of the top-level
4321 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004322 */
4323 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4324 /**
4325 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004326 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004327 * specified in its ClipData. When applying to an Intent's ClipData,
4328 * all URIs as well as recursive traversals through data or other ClipData
4329 * in Intent items will be granted; only the grant flags of the top-level
4330 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331 */
4332 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4333 /**
4334 * Can be set by the caller to indicate that this Intent is coming from
4335 * a background operation, not from direct user interaction.
4336 */
4337 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4338 /**
4339 * A flag you can enable for debugging: when set, log messages will be
4340 * printed during the resolution of this intent to show you what has
4341 * been found to create the final resolved list.
4342 */
4343 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004344 /**
4345 * If set, this intent will not match any components in packages that
4346 * are currently stopped. If this is not set, then the default behavior
4347 * is to include such applications in the result.
4348 */
4349 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4350 /**
4351 * If set, this intent will always match any components in packages that
4352 * are currently stopped. This is the default behavior when
4353 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4354 * flags are set, this one wins (it allows overriding of exclude for
4355 * places where the framework may automatically set the exclude flag).
4356 */
4357 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004358
4359 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004360 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004361 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004362 * persisted across device reboots until explicitly revoked with
4363 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4364 * grant for possible persisting; the receiving application must call
4365 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4366 * actually persist.
4367 *
4368 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4369 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4370 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004371 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004372 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004373 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004374
4375 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004376 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4377 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4378 * applies to any URI that is a prefix match against the original granted
4379 * URI. (Without this flag, the URI must match exactly for access to be
4380 * granted.) Another URI is considered a prefix match only when scheme,
4381 * authority, and all path segments defined by the prefix are an exact
4382 * match.
4383 */
4384 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4385
4386 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004387 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004388 * homework and verified that they correctly handle packages and components
4389 * that come and go over time. In particular:
4390 * <ul>
4391 * <li>Apps installed on external storage, which will appear to be
4392 * uninstalled while the the device is ejected.
4393 * <li>Apps with encryption unaware components, which will appear to not
4394 * exist while the device is locked.
4395 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004396 *
4397 * @hide
4398 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004399 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004400
4401 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004402 * Internal flag used to indicate ephemeral applications should not be
4403 * considered when resolving the intent.
4404 *
4405 * @hide
4406 */
4407 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4408
4409 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004410 * If set, the new activity is not kept in the history stack. As soon as
4411 * the user navigates away from it, the activity is finished. This may also
4412 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4413 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004414 *
4415 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4416 * is never invoked when the current activity starts a new activity which
4417 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004418 */
4419 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4420 /**
4421 * If set, the activity will not be launched if it is already running
4422 * at the top of the history stack.
4423 */
4424 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4425 /**
4426 * If set, this activity will become the start of a new task on this
4427 * history stack. A task (from the activity that started it to the
4428 * next task activity) defines an atomic group of activities that the
4429 * user can move to. Tasks can be moved to the foreground and background;
4430 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004431 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004432 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4433 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004434 *
4435 * <p>This flag is generally used by activities that want
4436 * to present a "launcher" style behavior: they give the user a list of
4437 * separate things that can be done, which otherwise run completely
4438 * independently of the activity launching them.
4439 *
4440 * <p>When using this flag, if a task is already running for the activity
4441 * you are now starting, then a new activity will not be started; instead,
4442 * the current task will simply be brought to the front of the screen with
4443 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4444 * to disable this behavior.
4445 *
4446 * <p>This flag can not be used when the caller is requesting a result from
4447 * the activity being launched.
4448 */
4449 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4450 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004451 * This flag is used to create a new task and launch an activity into it.
4452 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4453 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4454 * search through existing tasks for ones matching this Intent. Only if no such
4455 * task is found would a new task be created. When paired with
4456 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4457 * the search for a matching task and unconditionally start a new task.
4458 *
4459 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4460 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004461 * top-level application launcher.</strong> Used in conjunction with
4462 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4463 * behavior of bringing an existing task to the foreground. When set,
4464 * a new task is <em>always</em> started to host the Activity for the
4465 * Intent, regardless of whether there is already an existing task running
4466 * the same thing.
4467 *
4468 * <p><strong>Because the default system does not include graphical task management,
4469 * you should not use this flag unless you provide some way for a user to
4470 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004471 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004472 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4473 * creating new document tasks.
4474 *
4475 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004476 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004477 *
Scott Main7aee61f2011-02-08 11:25:01 -08004478 * <p>See
4479 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4480 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004481 *
4482 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4483 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004484 */
4485 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4486 /**
4487 * If set, and the activity being launched is already running in the
4488 * current task, then instead of launching a new instance of that activity,
4489 * all of the other activities on top of it will be closed and this Intent
4490 * will be delivered to the (now on top) old activity as a new Intent.
4491 *
4492 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4493 * If D calls startActivity() with an Intent that resolves to the component
4494 * of activity B, then C and D will be finished and B receive the given
4495 * Intent, resulting in the stack now being: A, B.
4496 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004497 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004498 * either receive the new intent you are starting here in its
4499 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004500 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004501 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4502 * the same intent, then it will be finished and re-created; for all other
4503 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4504 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004505 *
4506 * <p>This launch mode can also be used to good effect in conjunction with
4507 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4508 * of a task, it will bring any currently running instance of that task
4509 * to the foreground, and then clear it to its root state. This is
4510 * especially useful, for example, when launching an activity from the
4511 * notification manager.
4512 *
Scott Main7aee61f2011-02-08 11:25:01 -08004513 * <p>See
4514 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4515 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004516 */
4517 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4518 /**
4519 * If set and this intent is being used to launch a new activity from an
4520 * existing one, then the reply target of the existing activity will be
4521 * transfered to the new activity. This way the new activity can call
4522 * {@link android.app.Activity#setResult} and have that result sent back to
4523 * the reply target of the original activity.
4524 */
4525 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4526 /**
4527 * If set and this intent is being used to launch a new activity from an
4528 * existing one, the current activity will not be counted as the top
4529 * activity for deciding whether the new intent should be delivered to
4530 * the top instead of starting a new one. The previous activity will
4531 * be used as the top, with the assumption being that the current activity
4532 * will finish itself immediately.
4533 */
4534 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4535 /**
4536 * If set, the new activity is not kept in the list of recently launched
4537 * activities.
4538 */
4539 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4540 /**
4541 * This flag is not normally set by application code, but set for you by
4542 * the system as described in the
4543 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4544 * launchMode} documentation for the singleTask mode.
4545 */
4546 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4547 /**
4548 * If set, and this activity is either being started in a new task or
4549 * bringing to the top an existing task, then it will be launched as
4550 * the front door of the task. This will result in the application of
4551 * any affinities needed to have that task in the proper state (either
4552 * moving activities to or from it), or simply resetting that task to
4553 * its initial state if needed.
4554 */
4555 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4556 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004557 * This flag is not normally set by application code, but set for you by
4558 * the system if this activity is being launched from history
4559 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004560 */
4561 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004562 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004563 * @deprecated As of API 21 this performs identically to
4564 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004565 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004566 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004567 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004568 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004569 * This flag is used to open a document into a new task rooted at the activity launched
4570 * by this Intent. Through the use of this flag, or its equivalent attribute,
4571 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004572 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004573 *
Craig Mautner026596b2014-05-21 15:35:44 -07004574 * <p>The use of the activity attribute form of this,
4575 * {@link android.R.attr#documentLaunchMode}, is
4576 * preferred over the Intent flag described here. The attribute form allows the
4577 * Activity to specify multiple document behavior for all launchers of the Activity
4578 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004579 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004580 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4581 * it is kept after the activity is finished is different than the use of
4582 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4583 * this flag is being used to create a new recents entry, then by default that entry
4584 * will be removed once the activity is finished. You can modify this behavior with
4585 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4586 *
Craig Mautner026596b2014-05-21 15:35:44 -07004587 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4588 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4589 * equivalent of the Activity manifest specifying {@link
4590 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4591 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4592 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004593 *
Craig Mautner026596b2014-05-21 15:35:44 -07004594 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004595 *
Craig Mautner026596b2014-05-21 15:35:44 -07004596 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004597 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4598 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004599 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004600 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004601 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004602 * callback from occurring on the current frontmost activity before it is
4603 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004604 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004605 * <p>Typically, an activity can rely on that callback to indicate that an
4606 * explicit user action has caused their activity to be moved out of the
4607 * foreground. The callback marks an appropriate point in the activity's
4608 * lifecycle for it to dismiss any notifications that it intends to display
4609 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004610 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004611 * <p>If an activity is ever started via any non-user-driven events such as
4612 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4613 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004614 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004615 */
4616 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004617 /**
4618 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4619 * this flag will cause the launched activity to be brought to the front of its
4620 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004621 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004622 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4623 * If D calls startActivity() with an Intent that resolves to the component
4624 * of activity B, then B will be brought to the front of the history stack,
4625 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004626 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004627 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004628 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004629 */
4630 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004631 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004632 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4633 * this flag will prevent the system from applying an activity transition
4634 * animation to go to the next activity state. This doesn't mean an
4635 * animation will never run -- if another activity change happens that doesn't
4636 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004637 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004638 * when you are going to do a series of activity operations but the
4639 * animation seen by the user shouldn't be driven by the first activity
4640 * change but rather a later one.
4641 */
4642 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4643 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004644 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4645 * this flag will cause any existing task that would be associated with the
4646 * activity to be cleared before the activity is started. That is, the activity
4647 * becomes the new root of an otherwise empty task, and any old activities
4648 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4649 */
4650 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4651 /**
4652 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4653 * this flag will cause a newly launching task to be placed on top of the current
4654 * home activity task (if there is one). That is, pressing back from the task
4655 * will always return the user to home even if that was not the last activity they
4656 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4657 */
4658 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4659 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004660 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4661 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004662 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004663 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004664 * this flag. When set and the task's activity is finished, the recents
4665 * entry will remain in the interface for the user to re-launch it, like a
4666 * recents entry for a top-level application.
4667 * <p>
4668 * The receiving activity can override this request with
4669 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4670 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004671 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004672 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004673 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004674
4675 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004676 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4677 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004678 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4679 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004680 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004681 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004682
4683 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004684 * If set, when sending a broadcast only registered receivers will be
4685 * called -- no BroadcastReceiver components will be launched.
4686 */
4687 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004688 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004689 * If set, when sending a broadcast the new broadcast will replace
4690 * any existing pending broadcast that matches it. Matching is defined
4691 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4692 * true for the intents of the two broadcasts. When a match is found,
4693 * the new broadcast (and receivers associated with it) will replace the
4694 * existing one in the pending broadcast list, remaining at the same
4695 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004696 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004697 * <p>This flag is most typically used with sticky broadcasts, which
4698 * only care about delivering the most recent values of the broadcast
4699 * to their receivers.
4700 */
4701 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4702 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004703 * If set, when sending a broadcast the recipient is allowed to run at
4704 * foreground priority, with a shorter timeout interval. During normal
4705 * broadcasts the receivers are not automatically hoisted out of the
4706 * background priority class.
4707 */
4708 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4709 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004710 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4711 * They can still propagate results through to later receivers, but they can not prevent
4712 * later receivers from seeing the broadcast.
4713 */
4714 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4715 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004716 * If set, when sending a broadcast <i>before boot has completed</i> only
4717 * registered receivers will be called -- no BroadcastReceiver components
4718 * will be launched. Sticky intent state will be recorded properly even
4719 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4720 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004721 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004722 * <p>This flag is only for use by system sevices as a convenience to
4723 * avoid having to implement a more complex mechanism around detection
4724 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004725 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004726 * @hide
4727 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004728 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004729 /**
4730 * Set when this broadcast is for a boot upgrade, a special mode that
4731 * allows the broadcast to be sent before the system is ready and launches
4732 * the app process with no providers running in it.
4733 * @hide
4734 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004735 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004736 /**
4737 * If set, the broadcast will always go to manifest receivers in background (cached
4738 * or not running) apps, regardless of whether that would be done by default. By
4739 * default they will only receive broadcasts if the broadcast has specified an
4740 * explicit component or package name.
4741 * @hide
4742 */
4743 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4744 /**
4745 * If set, the broadcast will never go to manifest receivers in background (cached
4746 * or not running) apps, regardless of whether that would be done by default. By
4747 * default they will receive broadcasts if the broadcast has specified an
4748 * explicit component or package name.
4749 * @hide
4750 */
4751 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004752
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004753 /**
4754 * @hide Flags that can't be changed with PendingIntent.
4755 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004756 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4757 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4758 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004759
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004760 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004761 // ---------------------------------------------------------------------
4762 // toUri() and parseUri() options.
4763
4764 /**
4765 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4766 * always has the "intent:" scheme. This syntax can be used when you want
4767 * to later disambiguate between URIs that are intended to describe an
4768 * Intent vs. all others that should be treated as raw URIs. When used
4769 * with {@link #parseUri}, any other scheme will result in a generic
4770 * VIEW action for that raw URI.
4771 */
4772 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004773
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004774 /**
4775 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4776 * always has the "android-app:" scheme. This is a variation of
4777 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4778 * http/https URI being delivered to a specific package name. The format
4779 * is:
4780 *
4781 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004782 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004783 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004784 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4785 * you must also include a scheme; including a path also requires both a host and a scheme.
4786 * The final #Intent; fragment can be used without a scheme, host, or path.
4787 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004788 * used with intents that have a {@link #setSelector}, since the base intent
4789 * will always have an explicit package name.</p>
4790 *
4791 * <p>Some examples of how this scheme maps to Intent objects:</p>
4792 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4793 * <colgroup align="left" />
4794 * <colgroup align="left" />
4795 * <thead>
4796 * <tr><th>URI</th> <th>Intent</th></tr>
4797 * </thead>
4798 *
4799 * <tbody>
4800 * <tr><td><code>android-app://com.example.app</code></td>
4801 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4802 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4803 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4804 * </table></td>
4805 * </tr>
4806 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4807 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4808 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4809 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4810 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4811 * </table></td>
4812 * </tr>
4813 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4814 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4815 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4816 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4817 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4818 * </table></td>
4819 * </tr>
4820 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4821 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4822 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4823 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4824 * </table></td>
4825 * </tr>
4826 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4827 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4828 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4829 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4830 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4831 * </table></td>
4832 * </tr>
4833 * <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>
4834 * <td><table border="" style="margin:0" >
4835 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4836 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4837 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4838 * </table></td>
4839 * </tr>
4840 * </tbody>
4841 * </table>
4842 */
4843 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4844
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004845 /**
4846 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4847 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4848 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4849 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4850 * generated Intent can not cause unexpected data access to happen.
4851 *
4852 * <p>If you do not trust the source of the URI being parsed, you should still do further
4853 * processing to protect yourself from it. In particular, when using it to start an
4854 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4855 * that can handle it.</p>
4856 */
4857 public static final int URI_ALLOW_UNSAFE = 1<<2;
4858
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004859 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004860
4861 private String mAction;
4862 private Uri mData;
4863 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004864 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004865 private ComponentName mComponent;
4866 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004867 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004868 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004869 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004870 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004871 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004872 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873
4874 // ---------------------------------------------------------------------
4875
4876 /**
4877 * Create an empty intent.
4878 */
4879 public Intent() {
4880 }
4881
4882 /**
4883 * Copy constructor.
4884 */
4885 public Intent(Intent o) {
4886 this.mAction = o.mAction;
4887 this.mData = o.mData;
4888 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004889 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004890 this.mComponent = o.mComponent;
4891 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004892 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004893 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004894 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004895 }
4896 if (o.mExtras != null) {
4897 this.mExtras = new Bundle(o.mExtras);
4898 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004899 if (o.mSourceBounds != null) {
4900 this.mSourceBounds = new Rect(o.mSourceBounds);
4901 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004902 if (o.mSelector != null) {
4903 this.mSelector = new Intent(o.mSelector);
4904 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004905 if (o.mClipData != null) {
4906 this.mClipData = new ClipData(o.mClipData);
4907 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004908 }
4909
4910 @Override
4911 public Object clone() {
4912 return new Intent(this);
4913 }
4914
4915 private Intent(Intent o, boolean all) {
4916 this.mAction = o.mAction;
4917 this.mData = o.mData;
4918 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004919 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004920 this.mComponent = o.mComponent;
4921 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004922 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004923 }
4924 }
4925
4926 /**
4927 * Make a clone of only the parts of the Intent that are relevant for
4928 * filter matching: the action, data, type, component, and categories.
4929 */
4930 public Intent cloneFilter() {
4931 return new Intent(this, false);
4932 }
4933
4934 /**
4935 * Create an intent with a given action. All other fields (data, type,
4936 * class) are null. Note that the action <em>must</em> be in a
4937 * namespace because Intents are used globally in the system -- for
4938 * example the system VIEW action is android.intent.action.VIEW; an
4939 * application's custom action would be something like
4940 * com.google.app.myapp.CUSTOM_ACTION.
4941 *
4942 * @param action The Intent action, such as ACTION_VIEW.
4943 */
4944 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004945 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004946 }
4947
4948 /**
4949 * Create an intent with a given action and for a given data url. Note
4950 * that the action <em>must</em> be in a namespace because Intents are
4951 * used globally in the system -- for example the system VIEW action is
4952 * android.intent.action.VIEW; an application's custom action would be
4953 * something like com.google.app.myapp.CUSTOM_ACTION.
4954 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004955 * <p><em>Note: scheme and host name matching in the Android framework is
4956 * case-sensitive, unlike the formal RFC. As a result,
4957 * you should always ensure that you write your Uri with these elements
4958 * using lower case letters, and normalize any Uris you receive from
4959 * outside of Android to ensure the scheme and host is lower case.</em></p>
4960 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004961 * @param action The Intent action, such as ACTION_VIEW.
4962 * @param uri The Intent data URI.
4963 */
4964 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004965 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004966 mData = uri;
4967 }
4968
4969 /**
4970 * Create an intent for a specific component. All other fields (action, data,
4971 * type, class) are null, though they can be modified later with explicit
4972 * calls. This provides a convenient way to create an intent that is
4973 * intended to execute a hard-coded class name, rather than relying on the
4974 * system to find an appropriate class for you; see {@link #setComponent}
4975 * for more information on the repercussions of this.
4976 *
4977 * @param packageContext A Context of the application package implementing
4978 * this class.
4979 * @param cls The component class that is to be used for the intent.
4980 *
4981 * @see #setClass
4982 * @see #setComponent
4983 * @see #Intent(String, android.net.Uri , Context, Class)
4984 */
4985 public Intent(Context packageContext, Class<?> cls) {
4986 mComponent = new ComponentName(packageContext, cls);
4987 }
4988
4989 /**
4990 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004991 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004992 * construct the Intent and then calling {@link #setClass} to set its
4993 * class.
4994 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004995 * <p><em>Note: scheme and host name matching in the Android framework is
4996 * case-sensitive, unlike the formal RFC. As a result,
4997 * you should always ensure that you write your Uri with these elements
4998 * using lower case letters, and normalize any Uris you receive from
4999 * outside of Android to ensure the scheme and host is lower case.</em></p>
5000 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005001 * @param action The Intent action, such as ACTION_VIEW.
5002 * @param uri The Intent data URI.
5003 * @param packageContext A Context of the application package implementing
5004 * this class.
5005 * @param cls The component class that is to be used for the intent.
5006 *
5007 * @see #Intent(String, android.net.Uri)
5008 * @see #Intent(Context, Class)
5009 * @see #setClass
5010 * @see #setComponent
5011 */
5012 public Intent(String action, Uri uri,
5013 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005014 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005015 mData = uri;
5016 mComponent = new ComponentName(packageContext, cls);
5017 }
5018
5019 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005020 * Create an intent to launch the main (root) activity of a task. This
5021 * is the Intent that is started when the application's is launched from
5022 * Home. For anything else that wants to launch an application in the
5023 * same way, it is important that they use an Intent structured the same
5024 * way, and can use this function to ensure this is the case.
5025 *
5026 * <p>The returned Intent has the given Activity component as its explicit
5027 * component, {@link #ACTION_MAIN} as its action, and includes the
5028 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5029 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5030 * to do that through {@link #addFlags(int)} on the returned Intent.
5031 *
5032 * @param mainActivity The main activity component that this Intent will
5033 * launch.
5034 * @return Returns a newly created Intent that can be used to launch the
5035 * activity as a main application entry.
5036 *
5037 * @see #setClass
5038 * @see #setComponent
5039 */
5040 public static Intent makeMainActivity(ComponentName mainActivity) {
5041 Intent intent = new Intent(ACTION_MAIN);
5042 intent.setComponent(mainActivity);
5043 intent.addCategory(CATEGORY_LAUNCHER);
5044 return intent;
5045 }
5046
5047 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005048 * Make an Intent for the main activity of an application, without
5049 * specifying a specific activity to run but giving a selector to find
5050 * the activity. This results in a final Intent that is structured
5051 * the same as when the application is launched from
5052 * Home. For anything else that wants to launch an application in the
5053 * same way, it is important that they use an Intent structured the same
5054 * way, and can use this function to ensure this is the case.
5055 *
5056 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5057 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5058 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5059 * to do that through {@link #addFlags(int)} on the returned Intent.
5060 *
5061 * @param selectorAction The action name of the Intent's selector.
5062 * @param selectorCategory The name of a category to add to the Intent's
5063 * selector.
5064 * @return Returns a newly created Intent that can be used to launch the
5065 * activity as a main application entry.
5066 *
5067 * @see #setSelector(Intent)
5068 */
5069 public static Intent makeMainSelectorActivity(String selectorAction,
5070 String selectorCategory) {
5071 Intent intent = new Intent(ACTION_MAIN);
5072 intent.addCategory(CATEGORY_LAUNCHER);
5073 Intent selector = new Intent();
5074 selector.setAction(selectorAction);
5075 selector.addCategory(selectorCategory);
5076 intent.setSelector(selector);
5077 return intent;
5078 }
5079
5080 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005081 * Make an Intent that can be used to re-launch an application's task
5082 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5083 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5084 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5085 *
5086 * @param mainActivity The activity component that is the root of the
5087 * task; this is the activity that has been published in the application's
5088 * manifest as the main launcher icon.
5089 *
5090 * @return Returns a newly created Intent that can be used to relaunch the
5091 * activity's task in its root state.
5092 */
5093 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5094 Intent intent = makeMainActivity(mainActivity);
5095 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5096 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5097 return intent;
5098 }
5099
5100 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005101 * Call {@link #parseUri} with 0 flags.
5102 * @deprecated Use {@link #parseUri} instead.
5103 */
5104 @Deprecated
5105 public static Intent getIntent(String uri) throws URISyntaxException {
5106 return parseUri(uri, 0);
5107 }
Tom Taylord4a47292009-12-21 13:59:18 -08005108
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005109 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005110 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005111 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005112 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005113 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005114 *
5115 * <p>The URI given here must not be relative -- that is, it must include
5116 * the scheme and full path.
5117 *
5118 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005119 * @param flags Additional processing flags. Either 0,
5120 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005121 *
5122 * @return Intent The newly created Intent object.
5123 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005124 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5125 * it bad (as parsed by the Uri class) or the Intent data within the
5126 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005127 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005128 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005129 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005130 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005131 int i = 0;
5132 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005133 final boolean androidApp = uri.startsWith("android-app:");
5134
5135 // Validate intent scheme if requested.
5136 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5137 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005138 Intent intent = new Intent(ACTION_VIEW);
5139 try {
5140 intent.setData(Uri.parse(uri));
5141 } catch (IllegalArgumentException e) {
5142 throw new URISyntaxException(uri, e.getMessage());
5143 }
5144 return intent;
5145 }
5146 }
Tom Taylord4a47292009-12-21 13:59:18 -08005147
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005148 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005149 // simple case
5150 if (i == -1) {
5151 if (!androidApp) {
5152 return new Intent(ACTION_VIEW, Uri.parse(uri));
5153 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005154
5155 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005156 } else if (!uri.startsWith("#Intent;", i)) {
5157 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005158 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005159 } else {
5160 i = -1;
5161 }
5162 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005163
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005164 // new format
5165 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005166 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005167 boolean explicitAction = false;
5168 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005169
5170 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005171 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005172 String data;
5173 if (i >= 0) {
5174 data = uri.substring(0, i);
5175 i += 8; // length of "#Intent;"
5176 } else {
5177 data = uri;
5178 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005179
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005180 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005181 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005182 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005183 if (eq < 0) eq = i-1;
5184 int semi = uri.indexOf(';', i);
5185 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005186
5187 // action
5188 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005189 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005190 if (!inSelector) {
5191 explicitAction = true;
5192 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005193 }
5194
5195 // categories
5196 else if (uri.startsWith("category=", i)) {
5197 intent.addCategory(value);
5198 }
5199
5200 // type
5201 else if (uri.startsWith("type=", i)) {
5202 intent.mType = value;
5203 }
5204
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005205 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005206 else if (uri.startsWith("launchFlags=", i)) {
5207 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005208 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5209 intent.mFlags &= ~IMMUTABLE_FLAGS;
5210 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005211 }
5212
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005213 // package
5214 else if (uri.startsWith("package=", i)) {
5215 intent.mPackage = value;
5216 }
5217
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005218 // component
5219 else if (uri.startsWith("component=", i)) {
5220 intent.mComponent = ComponentName.unflattenFromString(value);
5221 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005222
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005223 // scheme
5224 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005225 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005226 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005227 } else {
5228 scheme = value;
5229 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005230 }
5231
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005232 // source bounds
5233 else if (uri.startsWith("sourceBounds=", i)) {
5234 intent.mSourceBounds = Rect.unflattenFromString(value);
5235 }
5236
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005237 // selector
5238 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5239 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005240 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005241 }
5242
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005243 // extra
5244 else {
5245 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005246 // create Bundle if it doesn't already exist
5247 if (intent.mExtras == null) intent.mExtras = new Bundle();
5248 Bundle b = intent.mExtras;
5249 // add EXTRA
5250 if (uri.startsWith("S.", i)) b.putString(key, value);
5251 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5252 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5253 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5254 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5255 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5256 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5257 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5258 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5259 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5260 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005261
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005262 // move to the next item
5263 i = semi + 1;
5264 }
5265
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005266 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005267 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005268 if (baseIntent.mPackage == null) {
5269 baseIntent.setSelector(intent);
5270 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005271 intent = baseIntent;
5272 }
5273
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005274 if (data != null) {
5275 if (data.startsWith("intent:")) {
5276 data = data.substring(7);
5277 if (scheme != null) {
5278 data = scheme + ':' + data;
5279 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005280 } else if (data.startsWith("android-app:")) {
5281 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5282 // Correctly formed android-app, first part is package name.
5283 int end = data.indexOf('/', 14);
5284 if (end < 0) {
5285 // All we have is a package name.
5286 intent.mPackage = data.substring(14);
5287 if (!explicitAction) {
5288 intent.setAction(ACTION_MAIN);
5289 }
5290 data = "";
5291 } else {
5292 // Target the Intent at the given package name always.
5293 String authority = null;
5294 intent.mPackage = data.substring(14, end);
5295 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005296 if ((end+1) < data.length()) {
5297 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5298 // Found a scheme, remember it.
5299 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005300 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005301 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5302 // Found a authority, remember it.
5303 authority = data.substring(end+1, newEnd);
5304 end = newEnd;
5305 }
5306 } else {
5307 // All we have is a scheme.
5308 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005309 }
5310 }
5311 if (scheme == null) {
5312 // If there was no scheme, then this just targets the package.
5313 if (!explicitAction) {
5314 intent.setAction(ACTION_MAIN);
5315 }
5316 data = "";
5317 } else if (authority == null) {
5318 data = scheme + ":";
5319 } else {
5320 data = scheme + "://" + authority + data.substring(end);
5321 }
5322 }
5323 } else {
5324 data = "";
5325 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005326 }
Tom Taylord4a47292009-12-21 13:59:18 -08005327
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005328 if (data.length() > 0) {
5329 try {
5330 intent.mData = Uri.parse(data);
5331 } catch (IllegalArgumentException e) {
5332 throw new URISyntaxException(uri, e.getMessage());
5333 }
5334 }
5335 }
Tom Taylord4a47292009-12-21 13:59:18 -08005336
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005337 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005338
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005339 } catch (IndexOutOfBoundsException e) {
5340 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5341 }
5342 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005343
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005344 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005345 return getIntentOld(uri, 0);
5346 }
5347
5348 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005349 Intent intent;
5350
5351 int i = uri.lastIndexOf('#');
5352 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005353 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005354 final int intentFragmentStart = i;
5355 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005356
5357 i++;
5358
5359 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005360 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005361 i += 7;
5362 int j = uri.indexOf(')', i);
5363 action = uri.substring(i, j);
5364 i = j + 1;
5365 }
5366
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005367 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005368
5369 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005370 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005371 i += 11;
5372 int j = uri.indexOf(')', i);
5373 while (i < j) {
5374 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005375 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005376 if (i < sep) {
5377 intent.addCategory(uri.substring(i, sep));
5378 }
5379 i = sep + 1;
5380 }
5381 i = j + 1;
5382 }
5383
5384 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005385 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005386 i += 5;
5387 int j = uri.indexOf(')', i);
5388 intent.mType = uri.substring(i, j);
5389 i = j + 1;
5390 }
5391
5392 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005393 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005394 i += 12;
5395 int j = uri.indexOf(')', i);
5396 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005397 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5398 intent.mFlags &= ~IMMUTABLE_FLAGS;
5399 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005400 i = j + 1;
5401 }
5402
5403 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005404 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005405 i += 10;
5406 int j = uri.indexOf(')', i);
5407 int sep = uri.indexOf('!', i);
5408 if (sep >= 0 && sep < j) {
5409 String pkg = uri.substring(i, sep);
5410 String cls = uri.substring(sep + 1, j);
5411 intent.mComponent = new ComponentName(pkg, cls);
5412 }
5413 i = j + 1;
5414 }
5415
5416 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005417 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005418 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005420 final int closeParen = uri.indexOf(')', i);
5421 if (closeParen == -1) throw new URISyntaxException(uri,
5422 "EXTRA missing trailing ')'", i);
5423
5424 while (i < closeParen) {
5425 // fetch the key value
5426 int j = uri.indexOf('=', i);
5427 if (j <= i + 1 || i >= closeParen) {
5428 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5429 }
5430 char type = uri.charAt(i);
5431 i++;
5432 String key = uri.substring(i, j);
5433 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005434
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005435 // get type-value
5436 j = uri.indexOf('!', i);
5437 if (j == -1 || j >= closeParen) j = closeParen;
5438 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5439 String value = uri.substring(i, j);
5440 i = j;
5441
5442 // create Bundle if it doesn't already exist
5443 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005444
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005445 // add item to bundle
5446 try {
5447 switch (type) {
5448 case 'S':
5449 intent.mExtras.putString(key, Uri.decode(value));
5450 break;
5451 case 'B':
5452 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5453 break;
5454 case 'b':
5455 intent.mExtras.putByte(key, Byte.parseByte(value));
5456 break;
5457 case 'c':
5458 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5459 break;
5460 case 'd':
5461 intent.mExtras.putDouble(key, Double.parseDouble(value));
5462 break;
5463 case 'f':
5464 intent.mExtras.putFloat(key, Float.parseFloat(value));
5465 break;
5466 case 'i':
5467 intent.mExtras.putInt(key, Integer.parseInt(value));
5468 break;
5469 case 'l':
5470 intent.mExtras.putLong(key, Long.parseLong(value));
5471 break;
5472 case 's':
5473 intent.mExtras.putShort(key, Short.parseShort(value));
5474 break;
5475 default:
5476 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5477 }
5478 } catch (NumberFormatException e) {
5479 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5480 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005481
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005482 char ch = uri.charAt(i);
5483 if (ch == ')') break;
5484 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5485 i++;
5486 }
5487 }
5488
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005489 if (isIntentFragment) {
5490 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5491 } else {
5492 intent.mData = Uri.parse(uri);
5493 }
Tom Taylord4a47292009-12-21 13:59:18 -08005494
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005495 if (intent.mAction == null) {
5496 // By default, if no action is specified, then use VIEW.
5497 intent.mAction = ACTION_VIEW;
5498 }
5499
5500 } else {
5501 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5502 }
5503
5504 return intent;
5505 }
5506
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005507 /** @hide */
5508 public interface CommandOptionHandler {
5509 boolean handleOption(String opt, ShellCommand cmd);
5510 }
5511
5512 /** @hide */
5513 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5514 throws URISyntaxException {
5515 Intent intent = new Intent();
5516 Intent baseIntent = intent;
5517 boolean hasIntentInfo = false;
5518
5519 Uri data = null;
5520 String type = null;
5521
5522 String opt;
5523 while ((opt=cmd.getNextOption()) != null) {
5524 switch (opt) {
5525 case "-a":
5526 intent.setAction(cmd.getNextArgRequired());
5527 if (intent == baseIntent) {
5528 hasIntentInfo = true;
5529 }
5530 break;
5531 case "-d":
5532 data = Uri.parse(cmd.getNextArgRequired());
5533 if (intent == baseIntent) {
5534 hasIntentInfo = true;
5535 }
5536 break;
5537 case "-t":
5538 type = cmd.getNextArgRequired();
5539 if (intent == baseIntent) {
5540 hasIntentInfo = true;
5541 }
5542 break;
5543 case "-c":
5544 intent.addCategory(cmd.getNextArgRequired());
5545 if (intent == baseIntent) {
5546 hasIntentInfo = true;
5547 }
5548 break;
5549 case "-e":
5550 case "--es": {
5551 String key = cmd.getNextArgRequired();
5552 String value = cmd.getNextArgRequired();
5553 intent.putExtra(key, value);
5554 }
5555 break;
5556 case "--esn": {
5557 String key = cmd.getNextArgRequired();
5558 intent.putExtra(key, (String) null);
5559 }
5560 break;
5561 case "--ei": {
5562 String key = cmd.getNextArgRequired();
5563 String value = cmd.getNextArgRequired();
5564 intent.putExtra(key, Integer.decode(value));
5565 }
5566 break;
5567 case "--eu": {
5568 String key = cmd.getNextArgRequired();
5569 String value = cmd.getNextArgRequired();
5570 intent.putExtra(key, Uri.parse(value));
5571 }
5572 break;
5573 case "--ecn": {
5574 String key = cmd.getNextArgRequired();
5575 String value = cmd.getNextArgRequired();
5576 ComponentName cn = ComponentName.unflattenFromString(value);
5577 if (cn == null)
5578 throw new IllegalArgumentException("Bad component name: " + value);
5579 intent.putExtra(key, cn);
5580 }
5581 break;
5582 case "--eia": {
5583 String key = cmd.getNextArgRequired();
5584 String value = cmd.getNextArgRequired();
5585 String[] strings = value.split(",");
5586 int[] list = new int[strings.length];
5587 for (int i = 0; i < strings.length; i++) {
5588 list[i] = Integer.decode(strings[i]);
5589 }
5590 intent.putExtra(key, list);
5591 }
5592 break;
5593 case "--eial": {
5594 String key = cmd.getNextArgRequired();
5595 String value = cmd.getNextArgRequired();
5596 String[] strings = value.split(",");
5597 ArrayList<Integer> list = new ArrayList<>(strings.length);
5598 for (int i = 0; i < strings.length; i++) {
5599 list.add(Integer.decode(strings[i]));
5600 }
5601 intent.putExtra(key, list);
5602 }
5603 break;
5604 case "--el": {
5605 String key = cmd.getNextArgRequired();
5606 String value = cmd.getNextArgRequired();
5607 intent.putExtra(key, Long.valueOf(value));
5608 }
5609 break;
5610 case "--ela": {
5611 String key = cmd.getNextArgRequired();
5612 String value = cmd.getNextArgRequired();
5613 String[] strings = value.split(",");
5614 long[] list = new long[strings.length];
5615 for (int i = 0; i < strings.length; i++) {
5616 list[i] = Long.valueOf(strings[i]);
5617 }
5618 intent.putExtra(key, list);
5619 hasIntentInfo = true;
5620 }
5621 break;
5622 case "--elal": {
5623 String key = cmd.getNextArgRequired();
5624 String value = cmd.getNextArgRequired();
5625 String[] strings = value.split(",");
5626 ArrayList<Long> list = new ArrayList<>(strings.length);
5627 for (int i = 0; i < strings.length; i++) {
5628 list.add(Long.valueOf(strings[i]));
5629 }
5630 intent.putExtra(key, list);
5631 hasIntentInfo = true;
5632 }
5633 break;
5634 case "--ef": {
5635 String key = cmd.getNextArgRequired();
5636 String value = cmd.getNextArgRequired();
5637 intent.putExtra(key, Float.valueOf(value));
5638 hasIntentInfo = true;
5639 }
5640 break;
5641 case "--efa": {
5642 String key = cmd.getNextArgRequired();
5643 String value = cmd.getNextArgRequired();
5644 String[] strings = value.split(",");
5645 float[] list = new float[strings.length];
5646 for (int i = 0; i < strings.length; i++) {
5647 list[i] = Float.valueOf(strings[i]);
5648 }
5649 intent.putExtra(key, list);
5650 hasIntentInfo = true;
5651 }
5652 break;
5653 case "--efal": {
5654 String key = cmd.getNextArgRequired();
5655 String value = cmd.getNextArgRequired();
5656 String[] strings = value.split(",");
5657 ArrayList<Float> list = new ArrayList<>(strings.length);
5658 for (int i = 0; i < strings.length; i++) {
5659 list.add(Float.valueOf(strings[i]));
5660 }
5661 intent.putExtra(key, list);
5662 hasIntentInfo = true;
5663 }
5664 break;
5665 case "--esa": {
5666 String key = cmd.getNextArgRequired();
5667 String value = cmd.getNextArgRequired();
5668 // Split on commas unless they are preceeded by an escape.
5669 // The escape character must be escaped for the string and
5670 // again for the regex, thus four escape characters become one.
5671 String[] strings = value.split("(?<!\\\\),");
5672 intent.putExtra(key, strings);
5673 hasIntentInfo = true;
5674 }
5675 break;
5676 case "--esal": {
5677 String key = cmd.getNextArgRequired();
5678 String value = cmd.getNextArgRequired();
5679 // Split on commas unless they are preceeded by an escape.
5680 // The escape character must be escaped for the string and
5681 // again for the regex, thus four escape characters become one.
5682 String[] strings = value.split("(?<!\\\\),");
5683 ArrayList<String> list = new ArrayList<>(strings.length);
5684 for (int i = 0; i < strings.length; i++) {
5685 list.add(strings[i]);
5686 }
5687 intent.putExtra(key, list);
5688 hasIntentInfo = true;
5689 }
5690 break;
5691 case "--ez": {
5692 String key = cmd.getNextArgRequired();
5693 String value = cmd.getNextArgRequired().toLowerCase();
5694 // Boolean.valueOf() results in false for anything that is not "true", which is
5695 // error-prone in shell commands
5696 boolean arg;
5697 if ("true".equals(value) || "t".equals(value)) {
5698 arg = true;
5699 } else if ("false".equals(value) || "f".equals(value)) {
5700 arg = false;
5701 } else {
5702 try {
5703 arg = Integer.decode(value) != 0;
5704 } catch (NumberFormatException ex) {
5705 throw new IllegalArgumentException("Invalid boolean value: " + value);
5706 }
5707 }
5708
5709 intent.putExtra(key, arg);
5710 }
5711 break;
5712 case "-n": {
5713 String str = cmd.getNextArgRequired();
5714 ComponentName cn = ComponentName.unflattenFromString(str);
5715 if (cn == null)
5716 throw new IllegalArgumentException("Bad component name: " + str);
5717 intent.setComponent(cn);
5718 if (intent == baseIntent) {
5719 hasIntentInfo = true;
5720 }
5721 }
5722 break;
5723 case "-p": {
5724 String str = cmd.getNextArgRequired();
5725 intent.setPackage(str);
5726 if (intent == baseIntent) {
5727 hasIntentInfo = true;
5728 }
5729 }
5730 break;
5731 case "-f":
5732 String str = cmd.getNextArgRequired();
5733 intent.setFlags(Integer.decode(str).intValue());
5734 break;
5735 case "--grant-read-uri-permission":
5736 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5737 break;
5738 case "--grant-write-uri-permission":
5739 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5740 break;
5741 case "--grant-persistable-uri-permission":
5742 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5743 break;
5744 case "--grant-prefix-uri-permission":
5745 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5746 break;
5747 case "--exclude-stopped-packages":
5748 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5749 break;
5750 case "--include-stopped-packages":
5751 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5752 break;
5753 case "--debug-log-resolution":
5754 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5755 break;
5756 case "--activity-brought-to-front":
5757 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5758 break;
5759 case "--activity-clear-top":
5760 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5761 break;
5762 case "--activity-clear-when-task-reset":
5763 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5764 break;
5765 case "--activity-exclude-from-recents":
5766 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5767 break;
5768 case "--activity-launched-from-history":
5769 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5770 break;
5771 case "--activity-multiple-task":
5772 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5773 break;
5774 case "--activity-no-animation":
5775 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5776 break;
5777 case "--activity-no-history":
5778 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5779 break;
5780 case "--activity-no-user-action":
5781 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5782 break;
5783 case "--activity-previous-is-top":
5784 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5785 break;
5786 case "--activity-reorder-to-front":
5787 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5788 break;
5789 case "--activity-reset-task-if-needed":
5790 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5791 break;
5792 case "--activity-single-top":
5793 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5794 break;
5795 case "--activity-clear-task":
5796 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5797 break;
5798 case "--activity-task-on-home":
5799 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5800 break;
5801 case "--receiver-registered-only":
5802 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5803 break;
5804 case "--receiver-replace-pending":
5805 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5806 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005807 case "--receiver-foreground":
5808 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5809 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005810 case "--selector":
5811 intent.setDataAndType(data, type);
5812 intent = new Intent();
5813 break;
5814 default:
5815 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5816 // Okay, caller handled this option.
5817 } else {
5818 throw new IllegalArgumentException("Unknown option: " + opt);
5819 }
5820 break;
5821 }
5822 }
5823 intent.setDataAndType(data, type);
5824
5825 final boolean hasSelector = intent != baseIntent;
5826 if (hasSelector) {
5827 // A selector was specified; fix up.
5828 baseIntent.setSelector(intent);
5829 intent = baseIntent;
5830 }
5831
5832 String arg = cmd.getNextArg();
5833 baseIntent = null;
5834 if (arg == null) {
5835 if (hasSelector) {
5836 // If a selector has been specified, and no arguments
5837 // have been supplied for the main Intent, then we can
5838 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5839 // need to have a component name specified yet, the
5840 // selector will take care of that.
5841 baseIntent = new Intent(Intent.ACTION_MAIN);
5842 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5843 }
5844 } else if (arg.indexOf(':') >= 0) {
5845 // The argument is a URI. Fully parse it, and use that result
5846 // to fill in any data not specified so far.
5847 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5848 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5849 } else if (arg.indexOf('/') >= 0) {
5850 // The argument is a component name. Build an Intent to launch
5851 // it.
5852 baseIntent = new Intent(Intent.ACTION_MAIN);
5853 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5854 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5855 } else {
5856 // Assume the argument is a package name.
5857 baseIntent = new Intent(Intent.ACTION_MAIN);
5858 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5859 baseIntent.setPackage(arg);
5860 }
5861 if (baseIntent != null) {
5862 Bundle extras = intent.getExtras();
5863 intent.replaceExtras((Bundle)null);
5864 Bundle uriExtras = baseIntent.getExtras();
5865 baseIntent.replaceExtras((Bundle)null);
5866 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5867 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5868 for (String c : cats) {
5869 baseIntent.removeCategory(c);
5870 }
5871 }
5872 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5873 if (extras == null) {
5874 extras = uriExtras;
5875 } else if (uriExtras != null) {
5876 uriExtras.putAll(extras);
5877 extras = uriExtras;
5878 }
5879 intent.replaceExtras(extras);
5880 hasIntentInfo = true;
5881 }
5882
5883 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5884 return intent;
5885 }
5886
5887 /** @hide */
5888 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5889 final String[] lines = new String[] {
5890 "<INTENT> specifications include these flags and arguments:",
5891 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5892 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5893 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5894 " [--esn <EXTRA_KEY> ...]",
5895 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5896 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5897 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5898 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5899 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5900 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5901 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5902 " (mutiple extras passed as Integer[])",
5903 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5904 " (mutiple extras passed as List<Integer>)",
5905 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5906 " (mutiple extras passed as Long[])",
5907 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5908 " (mutiple extras passed as List<Long>)",
5909 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5910 " (mutiple extras passed as Float[])",
5911 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5912 " (mutiple extras passed as List<Float>)",
5913 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5914 " (mutiple extras passed as String[]; to embed a comma into a string,",
5915 " escape it using \"\\,\")",
5916 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5917 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5918 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08005919 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005920 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5921 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5922 " [--debug-log-resolution] [--exclude-stopped-packages]",
5923 " [--include-stopped-packages]",
5924 " [--activity-brought-to-front] [--activity-clear-top]",
5925 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5926 " [--activity-launched-from-history] [--activity-multiple-task]",
5927 " [--activity-no-animation] [--activity-no-history]",
5928 " [--activity-no-user-action] [--activity-previous-is-top]",
5929 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5930 " [--activity-single-top] [--activity-clear-task]",
5931 " [--activity-task-on-home]",
5932 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005933 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005934 " [--selector]",
5935 " [<URI> | <PACKAGE> | <COMPONENT>]"
5936 };
5937 for (String line : lines) {
5938 pw.print(prefix);
5939 pw.println(line);
5940 }
5941 }
5942
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005943 /**
5944 * Retrieve the general action to be performed, such as
5945 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5946 * the information in the intent should be interpreted -- most importantly,
5947 * what to do with the data returned by {@link #getData}.
5948 *
5949 * @return The action of this intent or null if none is specified.
5950 *
5951 * @see #setAction
5952 */
5953 public String getAction() {
5954 return mAction;
5955 }
5956
5957 /**
5958 * Retrieve data this intent is operating on. This URI specifies the name
5959 * of the data; often it uses the content: scheme, specifying data in a
5960 * content provider. Other schemes may be handled by specific activities,
5961 * such as http: by the web browser.
5962 *
5963 * @return The URI of the data this intent is targeting or null.
5964 *
5965 * @see #getScheme
5966 * @see #setData
5967 */
5968 public Uri getData() {
5969 return mData;
5970 }
5971
5972 /**
5973 * The same as {@link #getData()}, but returns the URI as an encoded
5974 * String.
5975 */
5976 public String getDataString() {
5977 return mData != null ? mData.toString() : null;
5978 }
5979
5980 /**
5981 * Return the scheme portion of the intent's data. If the data is null or
5982 * does not include a scheme, null is returned. Otherwise, the scheme
5983 * prefix without the final ':' is returned, i.e. "http".
5984 *
5985 * <p>This is the same as calling getData().getScheme() (and checking for
5986 * null data).
5987 *
5988 * @return The scheme of this intent.
5989 *
5990 * @see #getData
5991 */
5992 public String getScheme() {
5993 return mData != null ? mData.getScheme() : null;
5994 }
5995
5996 /**
5997 * Retrieve any explicit MIME type included in the intent. This is usually
5998 * null, as the type is determined by the intent data.
5999 *
6000 * @return If a type was manually set, it is returned; else null is
6001 * returned.
6002 *
6003 * @see #resolveType(ContentResolver)
6004 * @see #setType
6005 */
6006 public String getType() {
6007 return mType;
6008 }
6009
6010 /**
6011 * Return the MIME data type of this intent. If the type field is
6012 * explicitly set, that is simply returned. Otherwise, if the data is set,
6013 * the type of that data is returned. If neither fields are set, a null is
6014 * returned.
6015 *
6016 * @return The MIME type of this intent.
6017 *
6018 * @see #getType
6019 * @see #resolveType(ContentResolver)
6020 */
6021 public String resolveType(Context context) {
6022 return resolveType(context.getContentResolver());
6023 }
6024
6025 /**
6026 * Return the MIME data type of this intent. If the type field is
6027 * explicitly set, that is simply returned. Otherwise, if the data is set,
6028 * the type of that data is returned. If neither fields are set, a null is
6029 * returned.
6030 *
6031 * @param resolver A ContentResolver that can be used to determine the MIME
6032 * type of the intent's data.
6033 *
6034 * @return The MIME type of this intent.
6035 *
6036 * @see #getType
6037 * @see #resolveType(Context)
6038 */
6039 public String resolveType(ContentResolver resolver) {
6040 if (mType != null) {
6041 return mType;
6042 }
6043 if (mData != null) {
6044 if ("content".equals(mData.getScheme())) {
6045 return resolver.getType(mData);
6046 }
6047 }
6048 return null;
6049 }
6050
6051 /**
6052 * Return the MIME data type of this intent, only if it will be needed for
6053 * intent resolution. This is not generally useful for application code;
6054 * it is used by the frameworks for communicating with back-end system
6055 * services.
6056 *
6057 * @param resolver A ContentResolver that can be used to determine the MIME
6058 * type of the intent's data.
6059 *
6060 * @return The MIME type of this intent, or null if it is unknown or not
6061 * needed.
6062 */
6063 public String resolveTypeIfNeeded(ContentResolver resolver) {
6064 if (mComponent != null) {
6065 return mType;
6066 }
6067 return resolveType(resolver);
6068 }
6069
6070 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006071 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006072 *
6073 * @param category The category to check.
6074 *
6075 * @return boolean True if the intent contains the category, else false.
6076 *
6077 * @see #getCategories
6078 * @see #addCategory
6079 */
6080 public boolean hasCategory(String category) {
6081 return mCategories != null && mCategories.contains(category);
6082 }
6083
6084 /**
6085 * Return the set of all categories in the intent. If there are no categories,
6086 * returns NULL.
6087 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006088 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006089 *
6090 * @see #hasCategory
6091 * @see #addCategory
6092 */
6093 public Set<String> getCategories() {
6094 return mCategories;
6095 }
6096
6097 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006098 * Return the specific selector associated with this Intent. If there is
6099 * none, returns null. See {@link #setSelector} for more information.
6100 *
6101 * @see #setSelector
6102 */
6103 public Intent getSelector() {
6104 return mSelector;
6105 }
6106
6107 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006108 * Return the {@link ClipData} associated with this Intent. If there is
6109 * none, returns null. See {@link #setClipData} for more information.
6110 *
John Spurlock125d1332013-11-25 11:58:37 -05006111 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006112 */
6113 public ClipData getClipData() {
6114 return mClipData;
6115 }
6116
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006117 /** @hide */
6118 public int getContentUserHint() {
6119 return mContentUserHint;
6120 }
6121
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006122 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006123 * Sets the ClassLoader that will be used when unmarshalling
6124 * any Parcelable values from the extras of this Intent.
6125 *
6126 * @param loader a ClassLoader, or null to use the default loader
6127 * at the time of unmarshalling.
6128 */
6129 public void setExtrasClassLoader(ClassLoader loader) {
6130 if (mExtras != null) {
6131 mExtras.setClassLoader(loader);
6132 }
6133 }
6134
6135 /**
6136 * Returns true if an extra value is associated with the given name.
6137 * @param name the extra's name
6138 * @return true if the given extra is present.
6139 */
6140 public boolean hasExtra(String name) {
6141 return mExtras != null && mExtras.containsKey(name);
6142 }
6143
6144 /**
6145 * Returns true if the Intent's extras contain a parcelled file descriptor.
6146 * @return true if the Intent contains a parcelled file descriptor.
6147 */
6148 public boolean hasFileDescriptors() {
6149 return mExtras != null && mExtras.hasFileDescriptors();
6150 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006151
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006152 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006153 public void setAllowFds(boolean allowFds) {
6154 if (mExtras != null) {
6155 mExtras.setAllowFds(allowFds);
6156 }
6157 }
6158
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006159 /** {@hide} */
6160 public void setDefusable(boolean defusable) {
6161 if (mExtras != null) {
6162 mExtras.setDefusable(defusable);
6163 }
6164 }
6165
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006166 /**
6167 * Retrieve extended data from the intent.
6168 *
6169 * @param name The name of the desired item.
6170 *
6171 * @return the value of an item that previously added with putExtra()
6172 * or null if none was found.
6173 *
6174 * @deprecated
6175 * @hide
6176 */
6177 @Deprecated
6178 public Object getExtra(String name) {
6179 return getExtra(name, null);
6180 }
6181
6182 /**
6183 * Retrieve extended data from the intent.
6184 *
6185 * @param name The name of the desired item.
6186 * @param defaultValue the value to be returned if no value of the desired
6187 * type is stored with the given name.
6188 *
6189 * @return the value of an item that previously added with putExtra()
6190 * or the default value if none was found.
6191 *
6192 * @see #putExtra(String, boolean)
6193 */
6194 public boolean getBooleanExtra(String name, boolean defaultValue) {
6195 return mExtras == null ? defaultValue :
6196 mExtras.getBoolean(name, defaultValue);
6197 }
6198
6199 /**
6200 * Retrieve extended data from the intent.
6201 *
6202 * @param name The name of the desired item.
6203 * @param defaultValue the value to be returned if no value of the desired
6204 * type is stored with the given name.
6205 *
6206 * @return the value of an item that previously added with putExtra()
6207 * or the default value if none was found.
6208 *
6209 * @see #putExtra(String, byte)
6210 */
6211 public byte getByteExtra(String name, byte defaultValue) {
6212 return mExtras == null ? defaultValue :
6213 mExtras.getByte(name, defaultValue);
6214 }
6215
6216 /**
6217 * Retrieve extended data from the intent.
6218 *
6219 * @param name The name of the desired item.
6220 * @param defaultValue the value to be returned if no value of the desired
6221 * type is stored with the given name.
6222 *
6223 * @return the value of an item that previously added with putExtra()
6224 * or the default value if none was found.
6225 *
6226 * @see #putExtra(String, short)
6227 */
6228 public short getShortExtra(String name, short defaultValue) {
6229 return mExtras == null ? defaultValue :
6230 mExtras.getShort(name, defaultValue);
6231 }
6232
6233 /**
6234 * Retrieve extended data from the intent.
6235 *
6236 * @param name The name of the desired item.
6237 * @param defaultValue the value to be returned if no value of the desired
6238 * type is stored with the given name.
6239 *
6240 * @return the value of an item that previously added with putExtra()
6241 * or the default value if none was found.
6242 *
6243 * @see #putExtra(String, char)
6244 */
6245 public char getCharExtra(String name, char defaultValue) {
6246 return mExtras == null ? defaultValue :
6247 mExtras.getChar(name, defaultValue);
6248 }
6249
6250 /**
6251 * Retrieve extended data from the intent.
6252 *
6253 * @param name The name of the desired item.
6254 * @param defaultValue the value to be returned if no value of the desired
6255 * type is stored with the given name.
6256 *
6257 * @return the value of an item that previously added with putExtra()
6258 * or the default value if none was found.
6259 *
6260 * @see #putExtra(String, int)
6261 */
6262 public int getIntExtra(String name, int defaultValue) {
6263 return mExtras == null ? defaultValue :
6264 mExtras.getInt(name, defaultValue);
6265 }
6266
6267 /**
6268 * Retrieve extended data from the intent.
6269 *
6270 * @param name The name of the desired item.
6271 * @param defaultValue the value to be returned if no value of the desired
6272 * type is stored with the given name.
6273 *
6274 * @return the value of an item that previously added with putExtra()
6275 * or the default value if none was found.
6276 *
6277 * @see #putExtra(String, long)
6278 */
6279 public long getLongExtra(String name, long defaultValue) {
6280 return mExtras == null ? defaultValue :
6281 mExtras.getLong(name, defaultValue);
6282 }
6283
6284 /**
6285 * Retrieve extended data from the intent.
6286 *
6287 * @param name The name of the desired item.
6288 * @param defaultValue the value to be returned if no value of the desired
6289 * type is stored with the given name.
6290 *
6291 * @return the value of an item that previously added with putExtra(),
6292 * or the default value if no such item is present
6293 *
6294 * @see #putExtra(String, float)
6295 */
6296 public float getFloatExtra(String name, float defaultValue) {
6297 return mExtras == null ? defaultValue :
6298 mExtras.getFloat(name, defaultValue);
6299 }
6300
6301 /**
6302 * Retrieve extended data from the intent.
6303 *
6304 * @param name The name of the desired item.
6305 * @param defaultValue the value to be returned if no value of the desired
6306 * type is stored with the given name.
6307 *
6308 * @return the value of an item that previously added with putExtra()
6309 * or the default value if none was found.
6310 *
6311 * @see #putExtra(String, double)
6312 */
6313 public double getDoubleExtra(String name, double defaultValue) {
6314 return mExtras == null ? defaultValue :
6315 mExtras.getDouble(name, defaultValue);
6316 }
6317
6318 /**
6319 * Retrieve extended data from the intent.
6320 *
6321 * @param name The name of the desired item.
6322 *
6323 * @return the value of an item that previously added with putExtra()
6324 * or null if no String value was found.
6325 *
6326 * @see #putExtra(String, String)
6327 */
6328 public String getStringExtra(String name) {
6329 return mExtras == null ? null : mExtras.getString(name);
6330 }
6331
6332 /**
6333 * Retrieve extended data from the intent.
6334 *
6335 * @param name The name of the desired item.
6336 *
6337 * @return the value of an item that previously added with putExtra()
6338 * or null if no CharSequence value was found.
6339 *
6340 * @see #putExtra(String, CharSequence)
6341 */
6342 public CharSequence getCharSequenceExtra(String name) {
6343 return mExtras == null ? null : mExtras.getCharSequence(name);
6344 }
6345
6346 /**
6347 * Retrieve extended data from the intent.
6348 *
6349 * @param name The name of the desired item.
6350 *
6351 * @return the value of an item that previously added with putExtra()
6352 * or null if no Parcelable value was found.
6353 *
6354 * @see #putExtra(String, Parcelable)
6355 */
6356 public <T extends Parcelable> T getParcelableExtra(String name) {
6357 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6358 }
6359
6360 /**
6361 * Retrieve extended data from the intent.
6362 *
6363 * @param name The name of the desired item.
6364 *
6365 * @return the value of an item that previously added with putExtra()
6366 * or null if no Parcelable[] value was found.
6367 *
6368 * @see #putExtra(String, Parcelable[])
6369 */
6370 public Parcelable[] getParcelableArrayExtra(String name) {
6371 return mExtras == null ? null : mExtras.getParcelableArray(name);
6372 }
6373
6374 /**
6375 * Retrieve extended data from the intent.
6376 *
6377 * @param name The name of the desired item.
6378 *
6379 * @return the value of an item that previously added with putExtra()
6380 * or null if no ArrayList<Parcelable> value was found.
6381 *
6382 * @see #putParcelableArrayListExtra(String, ArrayList)
6383 */
6384 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6385 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6386 }
6387
6388 /**
6389 * Retrieve extended data from the intent.
6390 *
6391 * @param name The name of the desired item.
6392 *
6393 * @return the value of an item that previously added with putExtra()
6394 * or null if no Serializable value was found.
6395 *
6396 * @see #putExtra(String, Serializable)
6397 */
6398 public Serializable getSerializableExtra(String name) {
6399 return mExtras == null ? null : mExtras.getSerializable(name);
6400 }
6401
6402 /**
6403 * Retrieve extended data from the intent.
6404 *
6405 * @param name The name of the desired item.
6406 *
6407 * @return the value of an item that previously added with putExtra()
6408 * or null if no ArrayList<Integer> value was found.
6409 *
6410 * @see #putIntegerArrayListExtra(String, ArrayList)
6411 */
6412 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6413 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6414 }
6415
6416 /**
6417 * Retrieve extended data from the intent.
6418 *
6419 * @param name The name of the desired item.
6420 *
6421 * @return the value of an item that previously added with putExtra()
6422 * or null if no ArrayList<String> value was found.
6423 *
6424 * @see #putStringArrayListExtra(String, ArrayList)
6425 */
6426 public ArrayList<String> getStringArrayListExtra(String name) {
6427 return mExtras == null ? null : mExtras.getStringArrayList(name);
6428 }
6429
6430 /**
6431 * Retrieve extended data from the intent.
6432 *
6433 * @param name The name of the desired item.
6434 *
6435 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006436 * or null if no ArrayList<CharSequence> value was found.
6437 *
6438 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6439 */
6440 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6441 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6442 }
6443
6444 /**
6445 * Retrieve extended data from the intent.
6446 *
6447 * @param name The name of the desired item.
6448 *
6449 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006450 * or null if no boolean array value was found.
6451 *
6452 * @see #putExtra(String, boolean[])
6453 */
6454 public boolean[] getBooleanArrayExtra(String name) {
6455 return mExtras == null ? null : mExtras.getBooleanArray(name);
6456 }
6457
6458 /**
6459 * Retrieve extended data from the intent.
6460 *
6461 * @param name The name of the desired item.
6462 *
6463 * @return the value of an item that previously added with putExtra()
6464 * or null if no byte array value was found.
6465 *
6466 * @see #putExtra(String, byte[])
6467 */
6468 public byte[] getByteArrayExtra(String name) {
6469 return mExtras == null ? null : mExtras.getByteArray(name);
6470 }
6471
6472 /**
6473 * Retrieve extended data from the intent.
6474 *
6475 * @param name The name of the desired item.
6476 *
6477 * @return the value of an item that previously added with putExtra()
6478 * or null if no short array value was found.
6479 *
6480 * @see #putExtra(String, short[])
6481 */
6482 public short[] getShortArrayExtra(String name) {
6483 return mExtras == null ? null : mExtras.getShortArray(name);
6484 }
6485
6486 /**
6487 * Retrieve extended data from the intent.
6488 *
6489 * @param name The name of the desired item.
6490 *
6491 * @return the value of an item that previously added with putExtra()
6492 * or null if no char array value was found.
6493 *
6494 * @see #putExtra(String, char[])
6495 */
6496 public char[] getCharArrayExtra(String name) {
6497 return mExtras == null ? null : mExtras.getCharArray(name);
6498 }
6499
6500 /**
6501 * Retrieve extended data from the intent.
6502 *
6503 * @param name The name of the desired item.
6504 *
6505 * @return the value of an item that previously added with putExtra()
6506 * or null if no int array value was found.
6507 *
6508 * @see #putExtra(String, int[])
6509 */
6510 public int[] getIntArrayExtra(String name) {
6511 return mExtras == null ? null : mExtras.getIntArray(name);
6512 }
6513
6514 /**
6515 * Retrieve extended data from the intent.
6516 *
6517 * @param name The name of the desired item.
6518 *
6519 * @return the value of an item that previously added with putExtra()
6520 * or null if no long array value was found.
6521 *
6522 * @see #putExtra(String, long[])
6523 */
6524 public long[] getLongArrayExtra(String name) {
6525 return mExtras == null ? null : mExtras.getLongArray(name);
6526 }
6527
6528 /**
6529 * Retrieve extended data from the intent.
6530 *
6531 * @param name The name of the desired item.
6532 *
6533 * @return the value of an item that previously added with putExtra()
6534 * or null if no float array value was found.
6535 *
6536 * @see #putExtra(String, float[])
6537 */
6538 public float[] getFloatArrayExtra(String name) {
6539 return mExtras == null ? null : mExtras.getFloatArray(name);
6540 }
6541
6542 /**
6543 * Retrieve extended data from the intent.
6544 *
6545 * @param name The name of the desired item.
6546 *
6547 * @return the value of an item that previously added with putExtra()
6548 * or null if no double array value was found.
6549 *
6550 * @see #putExtra(String, double[])
6551 */
6552 public double[] getDoubleArrayExtra(String name) {
6553 return mExtras == null ? null : mExtras.getDoubleArray(name);
6554 }
6555
6556 /**
6557 * Retrieve extended data from the intent.
6558 *
6559 * @param name The name of the desired item.
6560 *
6561 * @return the value of an item that previously added with putExtra()
6562 * or null if no String array value was found.
6563 *
6564 * @see #putExtra(String, String[])
6565 */
6566 public String[] getStringArrayExtra(String name) {
6567 return mExtras == null ? null : mExtras.getStringArray(name);
6568 }
6569
6570 /**
6571 * Retrieve extended data from the intent.
6572 *
6573 * @param name The name of the desired item.
6574 *
6575 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006576 * or null if no CharSequence array value was found.
6577 *
6578 * @see #putExtra(String, CharSequence[])
6579 */
6580 public CharSequence[] getCharSequenceArrayExtra(String name) {
6581 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6582 }
6583
6584 /**
6585 * Retrieve extended data from the intent.
6586 *
6587 * @param name The name of the desired item.
6588 *
6589 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006590 * or null if no Bundle value was found.
6591 *
6592 * @see #putExtra(String, Bundle)
6593 */
6594 public Bundle getBundleExtra(String name) {
6595 return mExtras == null ? null : mExtras.getBundle(name);
6596 }
6597
6598 /**
6599 * Retrieve extended data from the intent.
6600 *
6601 * @param name The name of the desired item.
6602 *
6603 * @return the value of an item that previously added with putExtra()
6604 * or null if no IBinder value was found.
6605 *
6606 * @see #putExtra(String, IBinder)
6607 *
6608 * @deprecated
6609 * @hide
6610 */
6611 @Deprecated
6612 public IBinder getIBinderExtra(String name) {
6613 return mExtras == null ? null : mExtras.getIBinder(name);
6614 }
6615
6616 /**
6617 * Retrieve extended data from the intent.
6618 *
6619 * @param name The name of the desired item.
6620 * @param defaultValue The default value to return in case no item is
6621 * associated with the key 'name'
6622 *
6623 * @return the value of an item that previously added with putExtra()
6624 * or defaultValue if none was found.
6625 *
6626 * @see #putExtra
6627 *
6628 * @deprecated
6629 * @hide
6630 */
6631 @Deprecated
6632 public Object getExtra(String name, Object defaultValue) {
6633 Object result = defaultValue;
6634 if (mExtras != null) {
6635 Object result2 = mExtras.get(name);
6636 if (result2 != null) {
6637 result = result2;
6638 }
6639 }
6640
6641 return result;
6642 }
6643
6644 /**
6645 * Retrieves a map of extended data from the intent.
6646 *
6647 * @return the map of all extras previously added with putExtra(),
6648 * or null if none have been added.
6649 */
6650 public Bundle getExtras() {
6651 return (mExtras != null)
6652 ? new Bundle(mExtras)
6653 : null;
6654 }
6655
6656 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006657 * Filter extras to only basic types.
6658 * @hide
6659 */
6660 public void removeUnsafeExtras() {
6661 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006662 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006663 }
6664 }
6665
6666 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006667 * Retrieve any special flags associated with this intent. You will
6668 * normally just set them with {@link #setFlags} and let the system
6669 * take the appropriate action with them.
6670 *
6671 * @return int The currently set flags.
6672 *
6673 * @see #setFlags
6674 */
6675 public int getFlags() {
6676 return mFlags;
6677 }
6678
Dianne Hackborne7f97212011-02-24 14:40:20 -08006679 /** @hide */
6680 public boolean isExcludingStopped() {
6681 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6682 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6683 }
6684
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006685 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006686 * Retrieve the application package name this Intent is limited to. When
6687 * resolving an Intent, if non-null this limits the resolution to only
6688 * components in the given application package.
6689 *
6690 * @return The name of the application package for the Intent.
6691 *
6692 * @see #resolveActivity
6693 * @see #setPackage
6694 */
6695 public String getPackage() {
6696 return mPackage;
6697 }
6698
6699 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006700 * Retrieve the concrete component associated with the intent. When receiving
6701 * an intent, this is the component that was found to best handle it (that is,
6702 * yourself) and will always be non-null; in all other cases it will be
6703 * null unless explicitly set.
6704 *
6705 * @return The name of the application component to handle the intent.
6706 *
6707 * @see #resolveActivity
6708 * @see #setComponent
6709 */
6710 public ComponentName getComponent() {
6711 return mComponent;
6712 }
6713
6714 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006715 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6716 * used as a hint to the receiver for animations and the like. Null means that there
6717 * is no source bounds.
6718 */
6719 public Rect getSourceBounds() {
6720 return mSourceBounds;
6721 }
6722
6723 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006724 * Return the Activity component that should be used to handle this intent.
6725 * The appropriate component is determined based on the information in the
6726 * intent, evaluated as follows:
6727 *
6728 * <p>If {@link #getComponent} returns an explicit class, that is returned
6729 * without any further consideration.
6730 *
6731 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6732 * category to be considered.
6733 *
6734 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6735 * action.
6736 *
6737 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6738 * this type.
6739 *
6740 * <p>If {@link #addCategory} has added any categories, the activity must
6741 * handle ALL of the categories specified.
6742 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006743 * <p>If {@link #getPackage} is non-NULL, only activity components in
6744 * that application package will be considered.
6745 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006746 * <p>If there are no activities that satisfy all of these conditions, a
6747 * null string is returned.
6748 *
6749 * <p>If multiple activities are found to satisfy the intent, the one with
6750 * the highest priority will be used. If there are multiple activities
6751 * with the same priority, the system will either pick the best activity
6752 * based on user preference, or resolve to a system class that will allow
6753 * the user to pick an activity and forward from there.
6754 *
6755 * <p>This method is implemented simply by calling
6756 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6757 * true.</p>
6758 * <p> This API is called for you as part of starting an activity from an
6759 * intent. You do not normally need to call it yourself.</p>
6760 *
6761 * @param pm The package manager with which to resolve the Intent.
6762 *
6763 * @return Name of the component implementing an activity that can
6764 * display the intent.
6765 *
6766 * @see #setComponent
6767 * @see #getComponent
6768 * @see #resolveActivityInfo
6769 */
6770 public ComponentName resolveActivity(PackageManager pm) {
6771 if (mComponent != null) {
6772 return mComponent;
6773 }
6774
6775 ResolveInfo info = pm.resolveActivity(
6776 this, PackageManager.MATCH_DEFAULT_ONLY);
6777 if (info != null) {
6778 return new ComponentName(
6779 info.activityInfo.applicationInfo.packageName,
6780 info.activityInfo.name);
6781 }
6782
6783 return null;
6784 }
6785
6786 /**
6787 * Resolve the Intent into an {@link ActivityInfo}
6788 * describing the activity that should execute the intent. Resolution
6789 * follows the same rules as described for {@link #resolveActivity}, but
6790 * you get back the completely information about the resolved activity
6791 * instead of just its class name.
6792 *
6793 * @param pm The package manager with which to resolve the Intent.
6794 * @param flags Addition information to retrieve as per
6795 * {@link PackageManager#getActivityInfo(ComponentName, int)
6796 * PackageManager.getActivityInfo()}.
6797 *
6798 * @return PackageManager.ActivityInfo
6799 *
6800 * @see #resolveActivity
6801 */
6802 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6803 ActivityInfo ai = null;
6804 if (mComponent != null) {
6805 try {
6806 ai = pm.getActivityInfo(mComponent, flags);
6807 } catch (PackageManager.NameNotFoundException e) {
6808 // ignore
6809 }
6810 } else {
6811 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006812 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006813 if (info != null) {
6814 ai = info.activityInfo;
6815 }
6816 }
6817
6818 return ai;
6819 }
6820
6821 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006822 * Special function for use by the system to resolve service
6823 * intents to system apps. Throws an exception if there are
6824 * multiple potential matches to the Intent. Returns null if
6825 * there are no matches.
6826 * @hide
6827 */
6828 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6829 if (mComponent != null) {
6830 return mComponent;
6831 }
6832
6833 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6834 if (results == null) {
6835 return null;
6836 }
6837 ComponentName comp = null;
6838 for (int i=0; i<results.size(); i++) {
6839 ResolveInfo ri = results.get(i);
6840 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6841 continue;
6842 }
6843 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6844 ri.serviceInfo.name);
6845 if (comp != null) {
6846 throw new IllegalStateException("Multiple system services handle " + this
6847 + ": " + comp + ", " + foundComp);
6848 }
6849 comp = foundComp;
6850 }
6851 return comp;
6852 }
6853
6854 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006855 * Set the general action to be performed.
6856 *
6857 * @param action An action name, such as ACTION_VIEW. Application-specific
6858 * actions should be prefixed with the vendor's package name.
6859 *
6860 * @return Returns the same Intent object, for chaining multiple calls
6861 * into a single statement.
6862 *
6863 * @see #getAction
6864 */
6865 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006866 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006867 return this;
6868 }
6869
6870 /**
6871 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006872 * clears any type that was previously set by {@link #setType} or
6873 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 *
Nick Pellyccae4122012-01-09 14:12:58 -08006875 * <p><em>Note: scheme matching in the Android framework is
6876 * case-sensitive, unlike the formal RFC. As a result,
6877 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006878 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006879 * {@link #setDataAndNormalize}
6880 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006881 *
Nick Pellyccae4122012-01-09 14:12:58 -08006882 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006883 *
6884 * @return Returns the same Intent object, for chaining multiple calls
6885 * into a single statement.
6886 *
6887 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006888 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006889 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006890 */
6891 public Intent setData(Uri data) {
6892 mData = data;
6893 mType = null;
6894 return this;
6895 }
6896
6897 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006898 * Normalize and set the data this intent is operating on.
6899 *
6900 * <p>This method automatically clears any type that was
6901 * previously set (for example, by {@link #setType}).
6902 *
6903 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006904 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006905 * so really this is just a convenience method for
6906 * <pre>
6907 * setData(data.normalize())
6908 * </pre>
6909 *
6910 * @param data The Uri of the data this intent is now targeting.
6911 *
6912 * @return Returns the same Intent object, for chaining multiple calls
6913 * into a single statement.
6914 *
6915 * @see #getData
6916 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006917 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006918 */
6919 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006920 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006921 }
6922
6923 /**
6924 * Set an explicit MIME data type.
6925 *
6926 * <p>This is used to create intents that only specify a type and not data,
6927 * for example to indicate the type of data to return.
6928 *
6929 * <p>This method automatically clears any data that was
6930 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006931 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006932 * <p><em>Note: MIME type matching in the Android framework is
6933 * case-sensitive, unlike formal RFC MIME types. As a result,
6934 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006935 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6936 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006937 *
6938 * @param type The MIME type of the data being handled by this intent.
6939 *
6940 * @return Returns the same Intent object, for chaining multiple calls
6941 * into a single statement.
6942 *
6943 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006944 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006945 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006946 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006947 */
6948 public Intent setType(String type) {
6949 mData = null;
6950 mType = type;
6951 return this;
6952 }
6953
6954 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006955 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006956 *
Nick Pellyccae4122012-01-09 14:12:58 -08006957 * <p>This is used to create intents that only specify a type and not data,
6958 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006959 *
Nick Pellyccae4122012-01-09 14:12:58 -08006960 * <p>This method automatically clears any data that was
6961 * previously set (for example by {@link #setData}).
6962 *
6963 * <p>The MIME type is normalized using
6964 * {@link #normalizeMimeType} before it is set,
6965 * so really this is just a convenience method for
6966 * <pre>
6967 * setType(Intent.normalizeMimeType(type))
6968 * </pre>
6969 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006970 * @param type The MIME type of the data being handled by this intent.
6971 *
6972 * @return Returns the same Intent object, for chaining multiple calls
6973 * into a single statement.
6974 *
Nick Pellyccae4122012-01-09 14:12:58 -08006975 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006976 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006977 * @see #normalizeMimeType
6978 */
6979 public Intent setTypeAndNormalize(String type) {
6980 return setType(normalizeMimeType(type));
6981 }
6982
6983 /**
6984 * (Usually optional) Set the data for the intent along with an explicit
6985 * MIME data type. This method should very rarely be used -- it allows you
6986 * to override the MIME type that would ordinarily be inferred from the
6987 * data with your own type given here.
6988 *
6989 * <p><em>Note: MIME type and Uri scheme matching in the
6990 * Android framework is case-sensitive, unlike the formal RFC definitions.
6991 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006992 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006993 * {@link #setDataAndTypeAndNormalize}
6994 * to ensure that they are converted to lower case.</em>
6995 *
6996 * @param data The Uri of the data this intent is now targeting.
6997 * @param type The MIME type of the data being handled by this intent.
6998 *
6999 * @return Returns the same Intent object, for chaining multiple calls
7000 * into a single statement.
7001 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007002 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007003 * @see #setData
7004 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007005 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007006 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007007 */
7008 public Intent setDataAndType(Uri data, String type) {
7009 mData = data;
7010 mType = type;
7011 return this;
7012 }
7013
7014 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007015 * (Usually optional) Normalize and set both the data Uri and an explicit
7016 * MIME data type. This method should very rarely be used -- it allows you
7017 * to override the MIME type that would ordinarily be inferred from the
7018 * data with your own type given here.
7019 *
7020 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007021 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007022 * before they are set, so really this is just a convenience method for
7023 * <pre>
7024 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7025 * </pre>
7026 *
7027 * @param data The Uri of the data this intent is now targeting.
7028 * @param type The MIME type of the data being handled by this intent.
7029 *
7030 * @return Returns the same Intent object, for chaining multiple calls
7031 * into a single statement.
7032 *
7033 * @see #setType
7034 * @see #setData
7035 * @see #setDataAndType
7036 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007037 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007038 */
7039 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007040 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007041 }
7042
7043 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007044 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007045 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007046 * activities that provide <em>all</em> of the requested categories will be
7047 * used.
7048 *
7049 * @param category The desired category. This can be either one of the
7050 * predefined Intent categories, or a custom category in your own
7051 * namespace.
7052 *
7053 * @return Returns the same Intent object, for chaining multiple calls
7054 * into a single statement.
7055 *
7056 * @see #hasCategory
7057 * @see #removeCategory
7058 */
7059 public Intent addCategory(String category) {
7060 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007061 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007062 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007063 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007064 return this;
7065 }
7066
7067 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007068 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007069 *
7070 * @param category The category to remove.
7071 *
7072 * @see #addCategory
7073 */
7074 public void removeCategory(String category) {
7075 if (mCategories != null) {
7076 mCategories.remove(category);
7077 if (mCategories.size() == 0) {
7078 mCategories = null;
7079 }
7080 }
7081 }
7082
7083 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007084 * Set a selector for this Intent. This is a modification to the kinds of
7085 * things the Intent will match. If the selector is set, it will be used
7086 * when trying to find entities that can handle the Intent, instead of the
7087 * main contents of the Intent. This allows you build an Intent containing
7088 * a generic protocol while targeting it more specifically.
7089 *
7090 * <p>An example of where this may be used is with things like
7091 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7092 * Intent that will launch the Browser application. However, the correct
7093 * main entry point of an application is actually {@link #ACTION_MAIN}
7094 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7095 * used to specify the actual Activity to launch. If you launch the browser
7096 * with something different, undesired behavior may happen if the user has
7097 * previously or later launches it the normal way, since they do not match.
7098 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7099 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7100 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7101 *
7102 * <p>Setting a selector does not impact the behavior of
7103 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7104 * desired behavior of a selector -- it does not impact the base meaning
7105 * of the Intent, just what kinds of things will be matched against it
7106 * when determining who can handle it.</p>
7107 *
7108 * <p>You can not use both a selector and {@link #setPackage(String)} on
7109 * the same base Intent.</p>
7110 *
7111 * @param selector The desired selector Intent; set to null to not use
7112 * a special selector.
7113 */
7114 public void setSelector(Intent selector) {
7115 if (selector == this) {
7116 throw new IllegalArgumentException(
7117 "Intent being set as a selector of itself");
7118 }
7119 if (selector != null && mPackage != null) {
7120 throw new IllegalArgumentException(
7121 "Can't set selector when package name is already set");
7122 }
7123 mSelector = selector;
7124 }
7125
7126 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007127 * Set a {@link ClipData} associated with this Intent. This replaces any
7128 * previously set ClipData.
7129 *
7130 * <p>The ClipData in an intent is not used for Intent matching or other
7131 * such operations. Semantically it is like extras, used to transmit
7132 * additional data with the Intent. The main feature of using this over
7133 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7134 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7135 * items included in the clip data. This is useful, in particular, if
7136 * you want to transmit an Intent containing multiple <code>content:</code>
7137 * URIs for which the recipient may not have global permission to access the
7138 * content provider.
7139 *
7140 * <p>If the ClipData contains items that are themselves Intents, any
7141 * grant flags in those Intents will be ignored. Only the top-level flags
7142 * of the main Intent are respected, and will be applied to all Uri or
7143 * Intent items in the clip (or sub-items of the clip).
7144 *
7145 * <p>The MIME type, label, and icon in the ClipData object are not
7146 * directly used by Intent. Applications should generally rely on the
7147 * MIME type of the Intent itself, not what it may find in the ClipData.
7148 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007149 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007150 *
7151 * @param clip The new clip to set. May be null to clear the current clip.
7152 */
7153 public void setClipData(ClipData clip) {
7154 mClipData = clip;
7155 }
7156
7157 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007158 * This is NOT a secure mechanism to identify the user who sent the intent.
7159 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7160 * who sent the intent.
7161 * @hide
7162 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007163 public void prepareToLeaveUser(int userId) {
7164 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7165 // We want mContentUserHint to refer to the original user, so don't do anything.
7166 if (mContentUserHint == UserHandle.USER_CURRENT) {
7167 mContentUserHint = userId;
7168 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007169 }
7170
7171 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007172 * Add extended data to the intent. The name must include a package
7173 * prefix, for example the app com.android.contacts would use names
7174 * like "com.android.contacts.ShowAll".
7175 *
7176 * @param name The name of the extra data, with package prefix.
7177 * @param value The boolean data value.
7178 *
7179 * @return Returns the same Intent object, for chaining multiple calls
7180 * into a single statement.
7181 *
7182 * @see #putExtras
7183 * @see #removeExtra
7184 * @see #getBooleanExtra(String, boolean)
7185 */
7186 public Intent putExtra(String name, boolean value) {
7187 if (mExtras == null) {
7188 mExtras = new Bundle();
7189 }
7190 mExtras.putBoolean(name, value);
7191 return this;
7192 }
7193
7194 /**
7195 * Add extended data to the intent. The name must include a package
7196 * prefix, for example the app com.android.contacts would use names
7197 * like "com.android.contacts.ShowAll".
7198 *
7199 * @param name The name of the extra data, with package prefix.
7200 * @param value The byte data value.
7201 *
7202 * @return Returns the same Intent object, for chaining multiple calls
7203 * into a single statement.
7204 *
7205 * @see #putExtras
7206 * @see #removeExtra
7207 * @see #getByteExtra(String, byte)
7208 */
7209 public Intent putExtra(String name, byte value) {
7210 if (mExtras == null) {
7211 mExtras = new Bundle();
7212 }
7213 mExtras.putByte(name, value);
7214 return this;
7215 }
7216
7217 /**
7218 * Add extended data to the intent. The name must include a package
7219 * prefix, for example the app com.android.contacts would use names
7220 * like "com.android.contacts.ShowAll".
7221 *
7222 * @param name The name of the extra data, with package prefix.
7223 * @param value The char data value.
7224 *
7225 * @return Returns the same Intent object, for chaining multiple calls
7226 * into a single statement.
7227 *
7228 * @see #putExtras
7229 * @see #removeExtra
7230 * @see #getCharExtra(String, char)
7231 */
7232 public Intent putExtra(String name, char value) {
7233 if (mExtras == null) {
7234 mExtras = new Bundle();
7235 }
7236 mExtras.putChar(name, value);
7237 return this;
7238 }
7239
7240 /**
7241 * Add extended data to the intent. The name must include a package
7242 * prefix, for example the app com.android.contacts would use names
7243 * like "com.android.contacts.ShowAll".
7244 *
7245 * @param name The name of the extra data, with package prefix.
7246 * @param value The short data value.
7247 *
7248 * @return Returns the same Intent object, for chaining multiple calls
7249 * into a single statement.
7250 *
7251 * @see #putExtras
7252 * @see #removeExtra
7253 * @see #getShortExtra(String, short)
7254 */
7255 public Intent putExtra(String name, short value) {
7256 if (mExtras == null) {
7257 mExtras = new Bundle();
7258 }
7259 mExtras.putShort(name, value);
7260 return this;
7261 }
7262
7263 /**
7264 * Add extended data to the intent. The name must include a package
7265 * prefix, for example the app com.android.contacts would use names
7266 * like "com.android.contacts.ShowAll".
7267 *
7268 * @param name The name of the extra data, with package prefix.
7269 * @param value The integer data value.
7270 *
7271 * @return Returns the same Intent object, for chaining multiple calls
7272 * into a single statement.
7273 *
7274 * @see #putExtras
7275 * @see #removeExtra
7276 * @see #getIntExtra(String, int)
7277 */
7278 public Intent putExtra(String name, int value) {
7279 if (mExtras == null) {
7280 mExtras = new Bundle();
7281 }
7282 mExtras.putInt(name, value);
7283 return this;
7284 }
7285
7286 /**
7287 * Add extended data to the intent. The name must include a package
7288 * prefix, for example the app com.android.contacts would use names
7289 * like "com.android.contacts.ShowAll".
7290 *
7291 * @param name The name of the extra data, with package prefix.
7292 * @param value The long data value.
7293 *
7294 * @return Returns the same Intent object, for chaining multiple calls
7295 * into a single statement.
7296 *
7297 * @see #putExtras
7298 * @see #removeExtra
7299 * @see #getLongExtra(String, long)
7300 */
7301 public Intent putExtra(String name, long value) {
7302 if (mExtras == null) {
7303 mExtras = new Bundle();
7304 }
7305 mExtras.putLong(name, value);
7306 return this;
7307 }
7308
7309 /**
7310 * Add extended data to the intent. The name must include a package
7311 * prefix, for example the app com.android.contacts would use names
7312 * like "com.android.contacts.ShowAll".
7313 *
7314 * @param name The name of the extra data, with package prefix.
7315 * @param value The float data value.
7316 *
7317 * @return Returns the same Intent object, for chaining multiple calls
7318 * into a single statement.
7319 *
7320 * @see #putExtras
7321 * @see #removeExtra
7322 * @see #getFloatExtra(String, float)
7323 */
7324 public Intent putExtra(String name, float value) {
7325 if (mExtras == null) {
7326 mExtras = new Bundle();
7327 }
7328 mExtras.putFloat(name, value);
7329 return this;
7330 }
7331
7332 /**
7333 * Add extended data to the intent. The name must include a package
7334 * prefix, for example the app com.android.contacts would use names
7335 * like "com.android.contacts.ShowAll".
7336 *
7337 * @param name The name of the extra data, with package prefix.
7338 * @param value The double data value.
7339 *
7340 * @return Returns the same Intent object, for chaining multiple calls
7341 * into a single statement.
7342 *
7343 * @see #putExtras
7344 * @see #removeExtra
7345 * @see #getDoubleExtra(String, double)
7346 */
7347 public Intent putExtra(String name, double value) {
7348 if (mExtras == null) {
7349 mExtras = new Bundle();
7350 }
7351 mExtras.putDouble(name, value);
7352 return this;
7353 }
7354
7355 /**
7356 * Add extended data to the intent. The name must include a package
7357 * prefix, for example the app com.android.contacts would use names
7358 * like "com.android.contacts.ShowAll".
7359 *
7360 * @param name The name of the extra data, with package prefix.
7361 * @param value The String data value.
7362 *
7363 * @return Returns the same Intent object, for chaining multiple calls
7364 * into a single statement.
7365 *
7366 * @see #putExtras
7367 * @see #removeExtra
7368 * @see #getStringExtra(String)
7369 */
7370 public Intent putExtra(String name, String value) {
7371 if (mExtras == null) {
7372 mExtras = new Bundle();
7373 }
7374 mExtras.putString(name, value);
7375 return this;
7376 }
7377
7378 /**
7379 * Add extended data to the intent. The name must include a package
7380 * prefix, for example the app com.android.contacts would use names
7381 * like "com.android.contacts.ShowAll".
7382 *
7383 * @param name The name of the extra data, with package prefix.
7384 * @param value The CharSequence data value.
7385 *
7386 * @return Returns the same Intent object, for chaining multiple calls
7387 * into a single statement.
7388 *
7389 * @see #putExtras
7390 * @see #removeExtra
7391 * @see #getCharSequenceExtra(String)
7392 */
7393 public Intent putExtra(String name, CharSequence value) {
7394 if (mExtras == null) {
7395 mExtras = new Bundle();
7396 }
7397 mExtras.putCharSequence(name, value);
7398 return this;
7399 }
7400
7401 /**
7402 * Add extended data to the intent. The name must include a package
7403 * prefix, for example the app com.android.contacts would use names
7404 * like "com.android.contacts.ShowAll".
7405 *
7406 * @param name The name of the extra data, with package prefix.
7407 * @param value The Parcelable data value.
7408 *
7409 * @return Returns the same Intent object, for chaining multiple calls
7410 * into a single statement.
7411 *
7412 * @see #putExtras
7413 * @see #removeExtra
7414 * @see #getParcelableExtra(String)
7415 */
7416 public Intent putExtra(String name, Parcelable value) {
7417 if (mExtras == null) {
7418 mExtras = new Bundle();
7419 }
7420 mExtras.putParcelable(name, value);
7421 return this;
7422 }
7423
7424 /**
7425 * Add extended data to the intent. The name must include a package
7426 * prefix, for example the app com.android.contacts would use names
7427 * like "com.android.contacts.ShowAll".
7428 *
7429 * @param name The name of the extra data, with package prefix.
7430 * @param value The Parcelable[] data value.
7431 *
7432 * @return Returns the same Intent object, for chaining multiple calls
7433 * into a single statement.
7434 *
7435 * @see #putExtras
7436 * @see #removeExtra
7437 * @see #getParcelableArrayExtra(String)
7438 */
7439 public Intent putExtra(String name, Parcelable[] value) {
7440 if (mExtras == null) {
7441 mExtras = new Bundle();
7442 }
7443 mExtras.putParcelableArray(name, value);
7444 return this;
7445 }
7446
7447 /**
7448 * Add extended data to the intent. The name must include a package
7449 * prefix, for example the app com.android.contacts would use names
7450 * like "com.android.contacts.ShowAll".
7451 *
7452 * @param name The name of the extra data, with package prefix.
7453 * @param value The ArrayList<Parcelable> data value.
7454 *
7455 * @return Returns the same Intent object, for chaining multiple calls
7456 * into a single statement.
7457 *
7458 * @see #putExtras
7459 * @see #removeExtra
7460 * @see #getParcelableArrayListExtra(String)
7461 */
7462 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7463 if (mExtras == null) {
7464 mExtras = new Bundle();
7465 }
7466 mExtras.putParcelableArrayList(name, value);
7467 return this;
7468 }
7469
7470 /**
7471 * Add extended data to the intent. The name must include a package
7472 * prefix, for example the app com.android.contacts would use names
7473 * like "com.android.contacts.ShowAll".
7474 *
7475 * @param name The name of the extra data, with package prefix.
7476 * @param value The ArrayList<Integer> data value.
7477 *
7478 * @return Returns the same Intent object, for chaining multiple calls
7479 * into a single statement.
7480 *
7481 * @see #putExtras
7482 * @see #removeExtra
7483 * @see #getIntegerArrayListExtra(String)
7484 */
7485 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7486 if (mExtras == null) {
7487 mExtras = new Bundle();
7488 }
7489 mExtras.putIntegerArrayList(name, value);
7490 return this;
7491 }
7492
7493 /**
7494 * Add extended data to the intent. The name must include a package
7495 * prefix, for example the app com.android.contacts would use names
7496 * like "com.android.contacts.ShowAll".
7497 *
7498 * @param name The name of the extra data, with package prefix.
7499 * @param value The ArrayList<String> data value.
7500 *
7501 * @return Returns the same Intent object, for chaining multiple calls
7502 * into a single statement.
7503 *
7504 * @see #putExtras
7505 * @see #removeExtra
7506 * @see #getStringArrayListExtra(String)
7507 */
7508 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7509 if (mExtras == null) {
7510 mExtras = new Bundle();
7511 }
7512 mExtras.putStringArrayList(name, value);
7513 return this;
7514 }
7515
7516 /**
7517 * Add extended data to the intent. The name must include a package
7518 * prefix, for example the app com.android.contacts would use names
7519 * like "com.android.contacts.ShowAll".
7520 *
7521 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007522 * @param value The ArrayList<CharSequence> data value.
7523 *
7524 * @return Returns the same Intent object, for chaining multiple calls
7525 * into a single statement.
7526 *
7527 * @see #putExtras
7528 * @see #removeExtra
7529 * @see #getCharSequenceArrayListExtra(String)
7530 */
7531 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7532 if (mExtras == null) {
7533 mExtras = new Bundle();
7534 }
7535 mExtras.putCharSequenceArrayList(name, value);
7536 return this;
7537 }
7538
7539 /**
7540 * Add extended data to the intent. The name must include a package
7541 * prefix, for example the app com.android.contacts would use names
7542 * like "com.android.contacts.ShowAll".
7543 *
7544 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007545 * @param value The Serializable data value.
7546 *
7547 * @return Returns the same Intent object, for chaining multiple calls
7548 * into a single statement.
7549 *
7550 * @see #putExtras
7551 * @see #removeExtra
7552 * @see #getSerializableExtra(String)
7553 */
7554 public Intent putExtra(String name, Serializable value) {
7555 if (mExtras == null) {
7556 mExtras = new Bundle();
7557 }
7558 mExtras.putSerializable(name, value);
7559 return this;
7560 }
7561
7562 /**
7563 * Add extended data to the intent. The name must include a package
7564 * prefix, for example the app com.android.contacts would use names
7565 * like "com.android.contacts.ShowAll".
7566 *
7567 * @param name The name of the extra data, with package prefix.
7568 * @param value The boolean array data value.
7569 *
7570 * @return Returns the same Intent object, for chaining multiple calls
7571 * into a single statement.
7572 *
7573 * @see #putExtras
7574 * @see #removeExtra
7575 * @see #getBooleanArrayExtra(String)
7576 */
7577 public Intent putExtra(String name, boolean[] value) {
7578 if (mExtras == null) {
7579 mExtras = new Bundle();
7580 }
7581 mExtras.putBooleanArray(name, value);
7582 return this;
7583 }
7584
7585 /**
7586 * Add extended data to the intent. The name must include a package
7587 * prefix, for example the app com.android.contacts would use names
7588 * like "com.android.contacts.ShowAll".
7589 *
7590 * @param name The name of the extra data, with package prefix.
7591 * @param value The byte array data value.
7592 *
7593 * @return Returns the same Intent object, for chaining multiple calls
7594 * into a single statement.
7595 *
7596 * @see #putExtras
7597 * @see #removeExtra
7598 * @see #getByteArrayExtra(String)
7599 */
7600 public Intent putExtra(String name, byte[] value) {
7601 if (mExtras == null) {
7602 mExtras = new Bundle();
7603 }
7604 mExtras.putByteArray(name, value);
7605 return this;
7606 }
7607
7608 /**
7609 * Add extended data to the intent. The name must include a package
7610 * prefix, for example the app com.android.contacts would use names
7611 * like "com.android.contacts.ShowAll".
7612 *
7613 * @param name The name of the extra data, with package prefix.
7614 * @param value The short array data value.
7615 *
7616 * @return Returns the same Intent object, for chaining multiple calls
7617 * into a single statement.
7618 *
7619 * @see #putExtras
7620 * @see #removeExtra
7621 * @see #getShortArrayExtra(String)
7622 */
7623 public Intent putExtra(String name, short[] value) {
7624 if (mExtras == null) {
7625 mExtras = new Bundle();
7626 }
7627 mExtras.putShortArray(name, value);
7628 return this;
7629 }
7630
7631 /**
7632 * Add extended data to the intent. The name must include a package
7633 * prefix, for example the app com.android.contacts would use names
7634 * like "com.android.contacts.ShowAll".
7635 *
7636 * @param name The name of the extra data, with package prefix.
7637 * @param value The char array data value.
7638 *
7639 * @return Returns the same Intent object, for chaining multiple calls
7640 * into a single statement.
7641 *
7642 * @see #putExtras
7643 * @see #removeExtra
7644 * @see #getCharArrayExtra(String)
7645 */
7646 public Intent putExtra(String name, char[] value) {
7647 if (mExtras == null) {
7648 mExtras = new Bundle();
7649 }
7650 mExtras.putCharArray(name, value);
7651 return this;
7652 }
7653
7654 /**
7655 * Add extended data to the intent. The name must include a package
7656 * prefix, for example the app com.android.contacts would use names
7657 * like "com.android.contacts.ShowAll".
7658 *
7659 * @param name The name of the extra data, with package prefix.
7660 * @param value The int array data value.
7661 *
7662 * @return Returns the same Intent object, for chaining multiple calls
7663 * into a single statement.
7664 *
7665 * @see #putExtras
7666 * @see #removeExtra
7667 * @see #getIntArrayExtra(String)
7668 */
7669 public Intent putExtra(String name, int[] value) {
7670 if (mExtras == null) {
7671 mExtras = new Bundle();
7672 }
7673 mExtras.putIntArray(name, value);
7674 return this;
7675 }
7676
7677 /**
7678 * Add extended data to the intent. The name must include a package
7679 * prefix, for example the app com.android.contacts would use names
7680 * like "com.android.contacts.ShowAll".
7681 *
7682 * @param name The name of the extra data, with package prefix.
7683 * @param value The byte array data value.
7684 *
7685 * @return Returns the same Intent object, for chaining multiple calls
7686 * into a single statement.
7687 *
7688 * @see #putExtras
7689 * @see #removeExtra
7690 * @see #getLongArrayExtra(String)
7691 */
7692 public Intent putExtra(String name, long[] value) {
7693 if (mExtras == null) {
7694 mExtras = new Bundle();
7695 }
7696 mExtras.putLongArray(name, value);
7697 return this;
7698 }
7699
7700 /**
7701 * Add extended data to the intent. The name must include a package
7702 * prefix, for example the app com.android.contacts would use names
7703 * like "com.android.contacts.ShowAll".
7704 *
7705 * @param name The name of the extra data, with package prefix.
7706 * @param value The float array data value.
7707 *
7708 * @return Returns the same Intent object, for chaining multiple calls
7709 * into a single statement.
7710 *
7711 * @see #putExtras
7712 * @see #removeExtra
7713 * @see #getFloatArrayExtra(String)
7714 */
7715 public Intent putExtra(String name, float[] value) {
7716 if (mExtras == null) {
7717 mExtras = new Bundle();
7718 }
7719 mExtras.putFloatArray(name, value);
7720 return this;
7721 }
7722
7723 /**
7724 * Add extended data to the intent. The name must include a package
7725 * prefix, for example the app com.android.contacts would use names
7726 * like "com.android.contacts.ShowAll".
7727 *
7728 * @param name The name of the extra data, with package prefix.
7729 * @param value The double array data value.
7730 *
7731 * @return Returns the same Intent object, for chaining multiple calls
7732 * into a single statement.
7733 *
7734 * @see #putExtras
7735 * @see #removeExtra
7736 * @see #getDoubleArrayExtra(String)
7737 */
7738 public Intent putExtra(String name, double[] value) {
7739 if (mExtras == null) {
7740 mExtras = new Bundle();
7741 }
7742 mExtras.putDoubleArray(name, value);
7743 return this;
7744 }
7745
7746 /**
7747 * Add extended data to the intent. The name must include a package
7748 * prefix, for example the app com.android.contacts would use names
7749 * like "com.android.contacts.ShowAll".
7750 *
7751 * @param name The name of the extra data, with package prefix.
7752 * @param value The String array data value.
7753 *
7754 * @return Returns the same Intent object, for chaining multiple calls
7755 * into a single statement.
7756 *
7757 * @see #putExtras
7758 * @see #removeExtra
7759 * @see #getStringArrayExtra(String)
7760 */
7761 public Intent putExtra(String name, String[] value) {
7762 if (mExtras == null) {
7763 mExtras = new Bundle();
7764 }
7765 mExtras.putStringArray(name, value);
7766 return this;
7767 }
7768
7769 /**
7770 * Add extended data to the intent. The name must include a package
7771 * prefix, for example the app com.android.contacts would use names
7772 * like "com.android.contacts.ShowAll".
7773 *
7774 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007775 * @param value The CharSequence array data value.
7776 *
7777 * @return Returns the same Intent object, for chaining multiple calls
7778 * into a single statement.
7779 *
7780 * @see #putExtras
7781 * @see #removeExtra
7782 * @see #getCharSequenceArrayExtra(String)
7783 */
7784 public Intent putExtra(String name, CharSequence[] value) {
7785 if (mExtras == null) {
7786 mExtras = new Bundle();
7787 }
7788 mExtras.putCharSequenceArray(name, value);
7789 return this;
7790 }
7791
7792 /**
7793 * Add extended data to the intent. The name must include a package
7794 * prefix, for example the app com.android.contacts would use names
7795 * like "com.android.contacts.ShowAll".
7796 *
7797 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007798 * @param value The Bundle data value.
7799 *
7800 * @return Returns the same Intent object, for chaining multiple calls
7801 * into a single statement.
7802 *
7803 * @see #putExtras
7804 * @see #removeExtra
7805 * @see #getBundleExtra(String)
7806 */
7807 public Intent putExtra(String name, Bundle value) {
7808 if (mExtras == null) {
7809 mExtras = new Bundle();
7810 }
7811 mExtras.putBundle(name, value);
7812 return this;
7813 }
7814
7815 /**
7816 * Add extended data to the intent. The name must include a package
7817 * prefix, for example the app com.android.contacts would use names
7818 * like "com.android.contacts.ShowAll".
7819 *
7820 * @param name The name of the extra data, with package prefix.
7821 * @param value The IBinder data value.
7822 *
7823 * @return Returns the same Intent object, for chaining multiple calls
7824 * into a single statement.
7825 *
7826 * @see #putExtras
7827 * @see #removeExtra
7828 * @see #getIBinderExtra(String)
7829 *
7830 * @deprecated
7831 * @hide
7832 */
7833 @Deprecated
7834 public Intent putExtra(String name, IBinder value) {
7835 if (mExtras == null) {
7836 mExtras = new Bundle();
7837 }
7838 mExtras.putIBinder(name, value);
7839 return this;
7840 }
7841
7842 /**
7843 * Copy all extras in 'src' in to this intent.
7844 *
7845 * @param src Contains the extras to copy.
7846 *
7847 * @see #putExtra
7848 */
7849 public Intent putExtras(Intent src) {
7850 if (src.mExtras != null) {
7851 if (mExtras == null) {
7852 mExtras = new Bundle(src.mExtras);
7853 } else {
7854 mExtras.putAll(src.mExtras);
7855 }
7856 }
7857 return this;
7858 }
7859
7860 /**
7861 * Add a set of extended data to the intent. The keys must include a package
7862 * prefix, for example the app com.android.contacts would use names
7863 * like "com.android.contacts.ShowAll".
7864 *
7865 * @param extras The Bundle of extras to add to this intent.
7866 *
7867 * @see #putExtra
7868 * @see #removeExtra
7869 */
7870 public Intent putExtras(Bundle extras) {
7871 if (mExtras == null) {
7872 mExtras = new Bundle();
7873 }
7874 mExtras.putAll(extras);
7875 return this;
7876 }
7877
7878 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007879 * Completely replace the extras in the Intent with the extras in the
7880 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007881 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007882 * @param src The exact extras contained in this Intent are copied
7883 * into the target intent, replacing any that were previously there.
7884 */
7885 public Intent replaceExtras(Intent src) {
7886 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7887 return this;
7888 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007889
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007890 /**
7891 * Completely replace the extras in the Intent with the given Bundle of
7892 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007893 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007894 * @param extras The new set of extras in the Intent, or null to erase
7895 * all extras.
7896 */
7897 public Intent replaceExtras(Bundle extras) {
7898 mExtras = extras != null ? new Bundle(extras) : null;
7899 return this;
7900 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007901
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007902 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007903 * Remove extended data from the intent.
7904 *
7905 * @see #putExtra
7906 */
7907 public void removeExtra(String name) {
7908 if (mExtras != null) {
7909 mExtras.remove(name);
7910 if (mExtras.size() == 0) {
7911 mExtras = null;
7912 }
7913 }
7914 }
7915
7916 /**
7917 * Set special flags controlling how this intent is handled. Most values
7918 * here depend on the type of component being executed by the Intent,
7919 * specifically the FLAG_ACTIVITY_* flags are all for use with
7920 * {@link Context#startActivity Context.startActivity()} and the
7921 * FLAG_RECEIVER_* flags are all for use with
7922 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7923 *
Scott Main7aee61f2011-02-08 11:25:01 -08007924 * <p>See the
7925 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7926 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007927 * the behavior of your application.
7928 *
7929 * @param flags The desired flags.
7930 *
7931 * @return Returns the same Intent object, for chaining multiple calls
7932 * into a single statement.
7933 *
7934 * @see #getFlags
7935 * @see #addFlags
7936 *
7937 * @see #FLAG_GRANT_READ_URI_PERMISSION
7938 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007939 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7940 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007941 * @see #FLAG_DEBUG_LOG_RESOLUTION
7942 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007943 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007944 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007945 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007946 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007947 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7948 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007949 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007950 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007951 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007952 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007953 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007954 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007955 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007956 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7957 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007958 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007959 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007960 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007961 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7962 */
7963 public Intent setFlags(int flags) {
7964 mFlags = flags;
7965 return this;
7966 }
7967
7968 /**
7969 * Add additional flags to the intent (or with existing flags
7970 * value).
7971 *
7972 * @param flags The new flags to set.
7973 *
7974 * @return Returns the same Intent object, for chaining multiple calls
7975 * into a single statement.
7976 *
7977 * @see #setFlags
7978 */
7979 public Intent addFlags(int flags) {
7980 mFlags |= flags;
7981 return this;
7982 }
7983
7984 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007985 * (Usually optional) Set an explicit application package name that limits
7986 * the components this Intent will resolve to. If left to the default
7987 * value of null, all components in all applications will considered.
7988 * If non-null, the Intent can only match the components in the given
7989 * application package.
7990 *
7991 * @param packageName The name of the application package to handle the
7992 * intent, or null to allow any application package.
7993 *
7994 * @return Returns the same Intent object, for chaining multiple calls
7995 * into a single statement.
7996 *
7997 * @see #getPackage
7998 * @see #resolveActivity
7999 */
8000 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008001 if (packageName != null && mSelector != null) {
8002 throw new IllegalArgumentException(
8003 "Can't set package name when selector is already set");
8004 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008005 mPackage = packageName;
8006 return this;
8007 }
8008
8009 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008010 * (Usually optional) Explicitly set the component to handle the intent.
8011 * If left with the default value of null, the system will determine the
8012 * appropriate class to use based on the other fields (action, data,
8013 * type, categories) in the Intent. If this class is defined, the
8014 * specified class will always be used regardless of the other fields. You
8015 * should only set this value when you know you absolutely want a specific
8016 * class to be used; otherwise it is better to let the system find the
8017 * appropriate class so that you will respect the installed applications
8018 * and user preferences.
8019 *
8020 * @param component The name of the application component to handle the
8021 * intent, or null to let the system find one for you.
8022 *
8023 * @return Returns the same Intent object, for chaining multiple calls
8024 * into a single statement.
8025 *
8026 * @see #setClass
8027 * @see #setClassName(Context, String)
8028 * @see #setClassName(String, String)
8029 * @see #getComponent
8030 * @see #resolveActivity
8031 */
8032 public Intent setComponent(ComponentName component) {
8033 mComponent = component;
8034 return this;
8035 }
8036
8037 /**
8038 * Convenience for calling {@link #setComponent} with an
8039 * explicit class name.
8040 *
8041 * @param packageContext A Context of the application package implementing
8042 * this class.
8043 * @param className The name of a class inside of the application package
8044 * that will be used as the component for this Intent.
8045 *
8046 * @return Returns the same Intent object, for chaining multiple calls
8047 * into a single statement.
8048 *
8049 * @see #setComponent
8050 * @see #setClass
8051 */
8052 public Intent setClassName(Context packageContext, String className) {
8053 mComponent = new ComponentName(packageContext, className);
8054 return this;
8055 }
8056
8057 /**
8058 * Convenience for calling {@link #setComponent} with an
8059 * explicit application package name and class name.
8060 *
8061 * @param packageName The name of the package implementing the desired
8062 * component.
8063 * @param className The name of a class inside of the application package
8064 * that will be used as the component for this Intent.
8065 *
8066 * @return Returns the same Intent object, for chaining multiple calls
8067 * into a single statement.
8068 *
8069 * @see #setComponent
8070 * @see #setClass
8071 */
8072 public Intent setClassName(String packageName, String className) {
8073 mComponent = new ComponentName(packageName, className);
8074 return this;
8075 }
8076
8077 /**
8078 * Convenience for calling {@link #setComponent(ComponentName)} with the
8079 * name returned by a {@link Class} object.
8080 *
8081 * @param packageContext A Context of the application package implementing
8082 * this class.
8083 * @param cls The class name to set, equivalent to
8084 * <code>setClassName(context, cls.getName())</code>.
8085 *
8086 * @return Returns the same Intent object, for chaining multiple calls
8087 * into a single statement.
8088 *
8089 * @see #setComponent
8090 */
8091 public Intent setClass(Context packageContext, Class<?> cls) {
8092 mComponent = new ComponentName(packageContext, cls);
8093 return this;
8094 }
8095
8096 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008097 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8098 * used as a hint to the receiver for animations and the like. Null means that there
8099 * is no source bounds.
8100 */
8101 public void setSourceBounds(Rect r) {
8102 if (r != null) {
8103 mSourceBounds = new Rect(r);
8104 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008105 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008106 }
8107 }
8108
Tor Norbyed9273d62013-05-30 15:59:53 -07008109 /** @hide */
8110 @IntDef(flag = true,
8111 value = {
8112 FILL_IN_ACTION,
8113 FILL_IN_DATA,
8114 FILL_IN_CATEGORIES,
8115 FILL_IN_COMPONENT,
8116 FILL_IN_PACKAGE,
8117 FILL_IN_SOURCE_BOUNDS,
8118 FILL_IN_SELECTOR,
8119 FILL_IN_CLIP_DATA
8120 })
8121 @Retention(RetentionPolicy.SOURCE)
8122 public @interface FillInFlags {}
8123
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008124 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008125 * Use with {@link #fillIn} to allow the current action value to be
8126 * overwritten, even if it is already set.
8127 */
8128 public static final int FILL_IN_ACTION = 1<<0;
8129
8130 /**
8131 * Use with {@link #fillIn} to allow the current data or type value
8132 * overwritten, even if it is already set.
8133 */
8134 public static final int FILL_IN_DATA = 1<<1;
8135
8136 /**
8137 * Use with {@link #fillIn} to allow the current categories to be
8138 * overwritten, even if they are already set.
8139 */
8140 public static final int FILL_IN_CATEGORIES = 1<<2;
8141
8142 /**
8143 * Use with {@link #fillIn} to allow the current component value to be
8144 * overwritten, even if it is already set.
8145 */
8146 public static final int FILL_IN_COMPONENT = 1<<3;
8147
8148 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008149 * Use with {@link #fillIn} to allow the current package value to be
8150 * overwritten, even if it is already set.
8151 */
8152 public static final int FILL_IN_PACKAGE = 1<<4;
8153
8154 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008155 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008156 * overwritten, even if it is already set.
8157 */
8158 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8159
8160 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008161 * Use with {@link #fillIn} to allow the current selector to be
8162 * overwritten, even if it is already set.
8163 */
8164 public static final int FILL_IN_SELECTOR = 1<<6;
8165
8166 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008167 * Use with {@link #fillIn} to allow the current ClipData to be
8168 * overwritten, even if it is already set.
8169 */
8170 public static final int FILL_IN_CLIP_DATA = 1<<7;
8171
8172 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008173 * Copy the contents of <var>other</var> in to this object, but only
8174 * where fields are not defined by this object. For purposes of a field
8175 * being defined, the following pieces of data in the Intent are
8176 * considered to be separate fields:
8177 *
8178 * <ul>
8179 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008180 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008181 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8182 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008183 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008184 * <li> component, as set by {@link #setComponent(ComponentName)} or
8185 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008186 * <li> source bounds, as set by {@link #setSourceBounds}.
8187 * <li> selector, as set by {@link #setSelector(Intent)}.
8188 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008189 * <li> each top-level name in the associated extras.
8190 * </ul>
8191 *
8192 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008193 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008194 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8195 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8196 * the restriction where the corresponding field will not be replaced if
8197 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008198 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008199 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8200 * is explicitly specified. The selector will only be copied if
8201 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008202 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008203 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8204 * and Intent B with {action="gotit", data-type="some/thing",
8205 * categories="one","two"}.
8206 *
8207 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8208 * containing: {action="gotit", data-type="some/thing",
8209 * categories="bar"}.
8210 *
8211 * @param other Another Intent whose values are to be used to fill in
8212 * the current one.
8213 * @param flags Options to control which fields can be filled in.
8214 *
8215 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008216 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008217 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8218 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8219 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008220 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008221 @FillInFlags
8222 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008223 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008224 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008225 if (other.mAction != null
8226 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008227 mAction = other.mAction;
8228 changes |= FILL_IN_ACTION;
8229 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008230 if ((other.mData != null || other.mType != null)
8231 && ((mData == null && mType == null)
8232 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008233 mData = other.mData;
8234 mType = other.mType;
8235 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008236 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008237 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008238 if (other.mCategories != null
8239 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008240 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008241 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008242 }
8243 changes |= FILL_IN_CATEGORIES;
8244 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008245 if (other.mPackage != null
8246 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008247 // Only do this if mSelector is not set.
8248 if (mSelector == null) {
8249 mPackage = other.mPackage;
8250 changes |= FILL_IN_PACKAGE;
8251 }
8252 }
8253 // Selector is special: it can only be set if explicitly allowed,
8254 // for the same reason as the component name.
8255 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8256 if (mPackage == null) {
8257 mSelector = new Intent(other.mSelector);
8258 mPackage = null;
8259 changes |= FILL_IN_SELECTOR;
8260 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008261 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008262 if (other.mClipData != null
8263 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8264 mClipData = other.mClipData;
8265 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008266 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008267 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008268 // Component is special: it can -only- be set if explicitly allowed,
8269 // since otherwise the sender could force the intent somewhere the
8270 // originator didn't intend.
8271 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008272 mComponent = other.mComponent;
8273 changes |= FILL_IN_COMPONENT;
8274 }
8275 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008276 if (other.mSourceBounds != null
8277 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8278 mSourceBounds = new Rect(other.mSourceBounds);
8279 changes |= FILL_IN_SOURCE_BOUNDS;
8280 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008281 if (mExtras == null) {
8282 if (other.mExtras != null) {
8283 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008284 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008285 }
8286 } else if (other.mExtras != null) {
8287 try {
8288 Bundle newb = new Bundle(other.mExtras);
8289 newb.putAll(mExtras);
8290 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008291 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008292 } catch (RuntimeException e) {
8293 // Modifying the extras can cause us to unparcel the contents
8294 // of the bundle, and if we do this in the system process that
8295 // may fail. We really should handle this (i.e., the Bundle
8296 // impl shouldn't be on top of a plain map), but for now just
8297 // ignore it and keep the original contents. :(
8298 Log.w("Intent", "Failure filling in extras", e);
8299 }
8300 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008301 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8302 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8303 mContentUserHint = other.mContentUserHint;
8304 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008305 return changes;
8306 }
8307
8308 /**
8309 * Wrapper class holding an Intent and implementing comparisons on it for
8310 * the purpose of filtering. The class implements its
8311 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8312 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8313 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8314 * on the wrapped Intent.
8315 */
8316 public static final class FilterComparison {
8317 private final Intent mIntent;
8318 private final int mHashCode;
8319
8320 public FilterComparison(Intent intent) {
8321 mIntent = intent;
8322 mHashCode = intent.filterHashCode();
8323 }
8324
8325 /**
8326 * Return the Intent that this FilterComparison represents.
8327 * @return Returns the Intent held by the FilterComparison. Do
8328 * not modify!
8329 */
8330 public Intent getIntent() {
8331 return mIntent;
8332 }
8333
8334 @Override
8335 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008336 if (obj instanceof FilterComparison) {
8337 Intent other = ((FilterComparison)obj).mIntent;
8338 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008339 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008340 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008341 }
8342
8343 @Override
8344 public int hashCode() {
8345 return mHashCode;
8346 }
8347 }
8348
8349 /**
8350 * Determine if two intents are the same for the purposes of intent
8351 * resolution (filtering). That is, if their action, data, type,
8352 * class, and categories are the same. This does <em>not</em> compare
8353 * any extra data included in the intents.
8354 *
8355 * @param other The other Intent to compare against.
8356 *
8357 * @return Returns true if action, data, type, class, and categories
8358 * are the same.
8359 */
8360 public boolean filterEquals(Intent other) {
8361 if (other == null) {
8362 return false;
8363 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008364 if (!Objects.equals(this.mAction, other.mAction)) return false;
8365 if (!Objects.equals(this.mData, other.mData)) return false;
8366 if (!Objects.equals(this.mType, other.mType)) return false;
8367 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8368 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8369 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008370
8371 return true;
8372 }
8373
8374 /**
8375 * Generate hash code that matches semantics of filterEquals().
8376 *
8377 * @return Returns the hash value of the action, data, type, class, and
8378 * categories.
8379 *
8380 * @see #filterEquals
8381 */
8382 public int filterHashCode() {
8383 int code = 0;
8384 if (mAction != null) {
8385 code += mAction.hashCode();
8386 }
8387 if (mData != null) {
8388 code += mData.hashCode();
8389 }
8390 if (mType != null) {
8391 code += mType.hashCode();
8392 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008393 if (mPackage != null) {
8394 code += mPackage.hashCode();
8395 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008396 if (mComponent != null) {
8397 code += mComponent.hashCode();
8398 }
8399 if (mCategories != null) {
8400 code += mCategories.hashCode();
8401 }
8402 return code;
8403 }
8404
8405 @Override
8406 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008407 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008408
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008409 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008410 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008411 b.append(" }");
8412
8413 return b.toString();
8414 }
8415
8416 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008417 public String toInsecureString() {
8418 StringBuilder b = new StringBuilder(128);
8419
8420 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008421 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008422 b.append(" }");
8423
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008424 return b.toString();
8425 }
Romain Guy4969af72009-06-17 10:53:19 -07008426
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008427 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008428 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008429 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008430
8431 b.append("Intent { ");
8432 toShortString(b, false, true, true, true);
8433 b.append(" }");
8434
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008435 return b.toString();
8436 }
8437
8438 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008439 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8440 StringBuilder b = new StringBuilder(128);
8441 toShortString(b, secure, comp, extras, clip);
8442 return b.toString();
8443 }
8444
8445 /** @hide */
8446 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8447 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008448 boolean first = true;
8449 if (mAction != null) {
8450 b.append("act=").append(mAction);
8451 first = false;
8452 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008453 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008454 if (!first) {
8455 b.append(' ');
8456 }
8457 first = false;
8458 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008459 for (int i=0; i<mCategories.size(); i++) {
8460 if (i > 0) b.append(',');
8461 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008462 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008463 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008464 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008465 if (mData != null) {
8466 if (!first) {
8467 b.append(' ');
8468 }
8469 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008470 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008471 if (secure) {
8472 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008473 } else {
8474 b.append(mData);
8475 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008476 }
8477 if (mType != null) {
8478 if (!first) {
8479 b.append(' ');
8480 }
8481 first = false;
8482 b.append("typ=").append(mType);
8483 }
8484 if (mFlags != 0) {
8485 if (!first) {
8486 b.append(' ');
8487 }
8488 first = false;
8489 b.append("flg=0x").append(Integer.toHexString(mFlags));
8490 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008491 if (mPackage != null) {
8492 if (!first) {
8493 b.append(' ');
8494 }
8495 first = false;
8496 b.append("pkg=").append(mPackage);
8497 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008498 if (comp && mComponent != null) {
8499 if (!first) {
8500 b.append(' ');
8501 }
8502 first = false;
8503 b.append("cmp=").append(mComponent.flattenToShortString());
8504 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008505 if (mSourceBounds != null) {
8506 if (!first) {
8507 b.append(' ');
8508 }
8509 first = false;
8510 b.append("bnds=").append(mSourceBounds.toShortString());
8511 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008512 if (mClipData != null) {
8513 if (!first) {
8514 b.append(' ');
8515 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008516 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008517 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008518 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008519 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008520 if (mClipData.getDescription() != null) {
8521 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8522 } else {
8523 first = true;
8524 }
8525 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008526 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008527 first = false;
8528 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008529 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008530 if (extras && mExtras != null) {
8531 if (!first) {
8532 b.append(' ');
8533 }
8534 first = false;
8535 b.append("(has extras)");
8536 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008537 if (mContentUserHint != UserHandle.USER_CURRENT) {
8538 if (!first) {
8539 b.append(' ');
8540 }
8541 first = false;
8542 b.append("u=").append(mContentUserHint);
8543 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008544 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008545 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008546 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008547 b.append("}");
8548 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008549 }
8550
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008551 /**
8552 * Call {@link #toUri} with 0 flags.
8553 * @deprecated Use {@link #toUri} instead.
8554 */
8555 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008556 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008557 return toUri(0);
8558 }
8559
8560 /**
8561 * Convert this Intent into a String holding a URI representation of it.
8562 * The returned URI string has been properly URI encoded, so it can be
8563 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8564 * Intent's data as the base URI, with an additional fragment describing
8565 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008566 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008567 * <p>You can convert the returned string back to an Intent with
8568 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008569 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008570 * @param flags Additional operating flags. Either 0,
8571 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008572 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008573 * @return Returns a URI encoding URI string describing the entire contents
8574 * of the Intent.
8575 */
8576 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008577 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008578 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8579 if (mPackage == null) {
8580 throw new IllegalArgumentException(
8581 "Intent must include an explicit package name to build an android-app: "
8582 + this);
8583 }
8584 uri.append("android-app://");
8585 uri.append(mPackage);
8586 String scheme = null;
8587 if (mData != null) {
8588 scheme = mData.getScheme();
8589 if (scheme != null) {
8590 uri.append('/');
8591 uri.append(scheme);
8592 String authority = mData.getEncodedAuthority();
8593 if (authority != null) {
8594 uri.append('/');
8595 uri.append(authority);
8596 String path = mData.getEncodedPath();
8597 if (path != null) {
8598 uri.append(path);
8599 }
8600 String queryParams = mData.getEncodedQuery();
8601 if (queryParams != null) {
8602 uri.append('?');
8603 uri.append(queryParams);
8604 }
8605 String fragment = mData.getEncodedFragment();
8606 if (fragment != null) {
8607 uri.append('#');
8608 uri.append(fragment);
8609 }
8610 }
8611 }
8612 }
8613 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8614 mPackage, flags);
8615 return uri.toString();
8616 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008617 String scheme = null;
8618 if (mData != null) {
8619 String data = mData.toString();
8620 if ((flags&URI_INTENT_SCHEME) != 0) {
8621 final int N = data.length();
8622 for (int i=0; i<N; i++) {
8623 char c = data.charAt(i);
8624 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8625 || c == '.' || c == '-') {
8626 continue;
8627 }
8628 if (c == ':' && i > 0) {
8629 // Valid scheme.
8630 scheme = data.substring(0, i);
8631 uri.append("intent:");
8632 data = data.substring(i+1);
8633 break;
8634 }
Tom Taylord4a47292009-12-21 13:59:18 -08008635
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008636 // No scheme.
8637 break;
8638 }
8639 }
8640 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008641
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008642 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8643 uri.append("intent:");
8644 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008645
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008646 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008647
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008648 return uri.toString();
8649 }
8650
8651 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8652 String defPackage, int flags) {
8653 StringBuilder frag = new StringBuilder(128);
8654
8655 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008656 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008657 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008658 // Note that for now we are not going to try to handle the
8659 // data part; not clear how to represent this as a URI, and
8660 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008661 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8662 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008663 }
8664
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008665 if (frag.length() > 0) {
8666 uri.append("#Intent;");
8667 uri.append(frag);
8668 uri.append("end");
8669 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008670 }
8671
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008672 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8673 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008674 if (scheme != null) {
8675 uri.append("scheme=").append(scheme).append(';');
8676 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008677 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008678 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 }
8680 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008681 for (int i=0; i<mCategories.size(); i++) {
8682 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008683 }
8684 }
8685 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008686 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008687 }
8688 if (mFlags != 0) {
8689 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8690 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008691 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008692 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8693 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008694 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008695 uri.append("component=").append(Uri.encode(
8696 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008697 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008698 if (mSourceBounds != null) {
8699 uri.append("sourceBounds=")
8700 .append(Uri.encode(mSourceBounds.flattenToString()))
8701 .append(';');
8702 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008703 if (mExtras != null) {
8704 for (String key : mExtras.keySet()) {
8705 final Object value = mExtras.get(key);
8706 char entryType =
8707 value instanceof String ? 'S' :
8708 value instanceof Boolean ? 'B' :
8709 value instanceof Byte ? 'b' :
8710 value instanceof Character ? 'c' :
8711 value instanceof Double ? 'd' :
8712 value instanceof Float ? 'f' :
8713 value instanceof Integer ? 'i' :
8714 value instanceof Long ? 'l' :
8715 value instanceof Short ? 's' :
8716 '\0';
8717
8718 if (entryType != '\0') {
8719 uri.append(entryType);
8720 uri.append('.');
8721 uri.append(Uri.encode(key));
8722 uri.append('=');
8723 uri.append(Uri.encode(value.toString()));
8724 uri.append(';');
8725 }
8726 }
8727 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008728 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008729
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008730 public int describeContents() {
8731 return (mExtras != null) ? mExtras.describeContents() : 0;
8732 }
8733
8734 public void writeToParcel(Parcel out, int flags) {
8735 out.writeString(mAction);
8736 Uri.writeToParcel(out, mData);
8737 out.writeString(mType);
8738 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008739 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008740 ComponentName.writeToParcel(mComponent, out);
8741
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008742 if (mSourceBounds != null) {
8743 out.writeInt(1);
8744 mSourceBounds.writeToParcel(out, flags);
8745 } else {
8746 out.writeInt(0);
8747 }
8748
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008749 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008750 final int N = mCategories.size();
8751 out.writeInt(N);
8752 for (int i=0; i<N; i++) {
8753 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008754 }
8755 } else {
8756 out.writeInt(0);
8757 }
8758
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008759 if (mSelector != null) {
8760 out.writeInt(1);
8761 mSelector.writeToParcel(out, flags);
8762 } else {
8763 out.writeInt(0);
8764 }
8765
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008766 if (mClipData != null) {
8767 out.writeInt(1);
8768 mClipData.writeToParcel(out, flags);
8769 } else {
8770 out.writeInt(0);
8771 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008772 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008773 out.writeBundle(mExtras);
8774 }
8775
8776 public static final Parcelable.Creator<Intent> CREATOR
8777 = new Parcelable.Creator<Intent>() {
8778 public Intent createFromParcel(Parcel in) {
8779 return new Intent(in);
8780 }
8781 public Intent[] newArray(int size) {
8782 return new Intent[size];
8783 }
8784 };
8785
Dianne Hackborneb034652009-09-07 00:49:58 -07008786 /** @hide */
8787 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008788 readFromParcel(in);
8789 }
8790
8791 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008792 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008793 mData = Uri.CREATOR.createFromParcel(in);
8794 mType = in.readString();
8795 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008796 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008797 mComponent = ComponentName.readFromParcel(in);
8798
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008799 if (in.readInt() != 0) {
8800 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8801 }
8802
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008803 int N = in.readInt();
8804 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008805 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008806 int i;
8807 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008808 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008809 }
8810 } else {
8811 mCategories = null;
8812 }
8813
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008814 if (in.readInt() != 0) {
8815 mSelector = new Intent(in);
8816 }
8817
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008818 if (in.readInt() != 0) {
8819 mClipData = new ClipData(in);
8820 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008821 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008822 mExtras = in.readBundle();
8823 }
8824
8825 /**
8826 * Parses the "intent" element (and its children) from XML and instantiates
8827 * an Intent object. The given XML parser should be located at the tag
8828 * where parsing should start (often named "intent"), from which the
8829 * basic action, data, type, and package and class name will be
8830 * retrieved. The function will then parse in to any child elements,
8831 * looking for <category android:name="xxx"> tags to add categories and
8832 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8833 * to the intent.
8834 *
8835 * @param resources The Resources to use when inflating resources.
8836 * @param parser The XML parser pointing at an "intent" tag.
8837 * @param attrs The AttributeSet interface for retrieving extended
8838 * attribute data at the current <var>parser</var> location.
8839 * @return An Intent object matching the XML data.
8840 * @throws XmlPullParserException If there was an XML parsing error.
8841 * @throws IOException If there was an I/O error.
8842 */
8843 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8844 throws XmlPullParserException, IOException {
8845 Intent intent = new Intent();
8846
8847 TypedArray sa = resources.obtainAttributes(attrs,
8848 com.android.internal.R.styleable.Intent);
8849
8850 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8851
8852 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8853 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8854 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8855
8856 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8857 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8858 if (packageName != null && className != null) {
8859 intent.setComponent(new ComponentName(packageName, className));
8860 }
8861
8862 sa.recycle();
8863
8864 int outerDepth = parser.getDepth();
8865 int type;
8866 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8867 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8868 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8869 continue;
8870 }
8871
8872 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008873 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008874 sa = resources.obtainAttributes(attrs,
8875 com.android.internal.R.styleable.IntentCategory);
8876 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8877 sa.recycle();
8878
8879 if (cat != null) {
8880 intent.addCategory(cat);
8881 }
8882 XmlUtils.skipCurrentTag(parser);
8883
Craig Mautner21d24a22014-04-23 11:45:37 -07008884 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008885 if (intent.mExtras == null) {
8886 intent.mExtras = new Bundle();
8887 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008888 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008889 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008890
8891 } else {
8892 XmlUtils.skipCurrentTag(parser);
8893 }
8894 }
8895
8896 return intent;
8897 }
Nick Pellyccae4122012-01-09 14:12:58 -08008898
Craig Mautner21d24a22014-04-23 11:45:37 -07008899 /** @hide */
8900 public void saveToXml(XmlSerializer out) throws IOException {
8901 if (mAction != null) {
8902 out.attribute(null, ATTR_ACTION, mAction);
8903 }
8904 if (mData != null) {
8905 out.attribute(null, ATTR_DATA, mData.toString());
8906 }
8907 if (mType != null) {
8908 out.attribute(null, ATTR_TYPE, mType);
8909 }
8910 if (mComponent != null) {
8911 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8912 }
8913 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8914
8915 if (mCategories != null) {
8916 out.startTag(null, TAG_CATEGORIES);
8917 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8918 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8919 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008920 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008921 }
8922 }
8923
8924 /** @hide */
8925 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8926 XmlPullParserException {
8927 Intent intent = new Intent();
8928 final int outerDepth = in.getDepth();
8929
8930 int attrCount = in.getAttributeCount();
8931 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8932 final String attrName = in.getAttributeName(attrNdx);
8933 final String attrValue = in.getAttributeValue(attrNdx);
8934 if (ATTR_ACTION.equals(attrName)) {
8935 intent.setAction(attrValue);
8936 } else if (ATTR_DATA.equals(attrName)) {
8937 intent.setData(Uri.parse(attrValue));
8938 } else if (ATTR_TYPE.equals(attrName)) {
8939 intent.setType(attrValue);
8940 } else if (ATTR_COMPONENT.equals(attrName)) {
8941 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8942 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008943 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008944 } else {
8945 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8946 }
8947 }
8948
8949 int event;
8950 String name;
8951 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8952 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8953 if (event == XmlPullParser.START_TAG) {
8954 name = in.getName();
8955 if (TAG_CATEGORIES.equals(name)) {
8956 attrCount = in.getAttributeCount();
8957 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8958 intent.addCategory(in.getAttributeValue(attrNdx));
8959 }
8960 } else {
8961 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8962 XmlUtils.skipCurrentTag(in);
8963 }
8964 }
8965 }
8966
8967 return intent;
8968 }
8969
Nick Pellyccae4122012-01-09 14:12:58 -08008970 /**
8971 * Normalize a MIME data type.
8972 *
8973 * <p>A normalized MIME type has white-space trimmed,
8974 * content-type parameters removed, and is lower-case.
8975 * This aligns the type with Android best practices for
8976 * intent filtering.
8977 *
8978 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8979 * "text/x-vCard" becomes "text/x-vcard".
8980 *
8981 * <p>All MIME types received from outside Android (such as user input,
8982 * or external sources like Bluetooth, NFC, or the Internet) should
8983 * be normalized before they are used to create an Intent.
8984 *
8985 * @param type MIME data type to normalize
8986 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008987 * @see #setType
8988 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008989 */
8990 public static String normalizeMimeType(String type) {
8991 if (type == null) {
8992 return null;
8993 }
8994
Elliott Hughescb64d432013-08-02 10:00:44 -07008995 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008996
8997 final int semicolonIndex = type.indexOf(';');
8998 if (semicolonIndex != -1) {
8999 type = type.substring(0, semicolonIndex);
9000 }
9001 return type;
9002 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009003
9004 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009005 * Prepare this {@link Intent} to leave an app process.
9006 *
9007 * @hide
9008 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009009 public void prepareToLeaveProcess(Context context) {
9010 final boolean leavingPackage = (mComponent == null)
9011 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9012 prepareToLeaveProcess(leavingPackage);
9013 }
9014
9015 /**
9016 * Prepare this {@link Intent} to leave an app process.
9017 *
9018 * @hide
9019 */
9020 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009021 setAllowFds(false);
9022
9023 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009024 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009025 }
9026 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009027 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009028 }
9029
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009030 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9031 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009032 switch (mAction) {
9033 case ACTION_MEDIA_REMOVED:
9034 case ACTION_MEDIA_UNMOUNTED:
9035 case ACTION_MEDIA_CHECKING:
9036 case ACTION_MEDIA_NOFS:
9037 case ACTION_MEDIA_MOUNTED:
9038 case ACTION_MEDIA_SHARED:
9039 case ACTION_MEDIA_UNSHARED:
9040 case ACTION_MEDIA_BAD_REMOVAL:
9041 case ACTION_MEDIA_UNMOUNTABLE:
9042 case ACTION_MEDIA_EJECT:
9043 case ACTION_MEDIA_SCANNER_STARTED:
9044 case ACTION_MEDIA_SCANNER_FINISHED:
9045 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009046 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9047 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009048 // Ignore legacy actions
9049 break;
9050 default:
9051 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009052 }
9053 }
9054 }
9055
9056 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009057 * @hide
9058 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009059 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009060 // We just entered destination process, so we should be able to read all
9061 // parcelables inside.
9062 setDefusable(true);
9063
9064 if (mSelector != null) {
9065 mSelector.prepareToEnterProcess();
9066 }
9067 if (mClipData != null) {
9068 mClipData.prepareToEnterProcess();
9069 }
9070
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009071 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009072 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9073 fixUris(mContentUserHint);
9074 mContentUserHint = UserHandle.USER_CURRENT;
9075 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009076 }
9077 }
9078
9079 /**
9080 * @hide
9081 */
9082 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009083 Uri data = getData();
9084 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009085 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009086 }
9087 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009088 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009089 }
9090 String action = getAction();
9091 if (ACTION_SEND.equals(action)) {
9092 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9093 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009094 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009095 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009096 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009097 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9098 if (streams != null) {
9099 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9100 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009101 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009102 }
9103 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9104 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009105 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9106 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9107 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9108 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9109 if (output != null) {
9110 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9111 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009112 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009113 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009114
9115 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009116 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009117 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9118 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009119 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009120 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009121 * @hide
9122 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009123 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009124 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009125 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009126
9127 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009128 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009129
9130 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009131 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009132 // Inspect contained intents to see if we need to migrate extras. We
9133 // don't promote ClipData to the parent, since ChooserActivity will
9134 // already start the picked item as the caller, and we can't combine
9135 // the flags in a safe way.
9136
9137 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009138 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009139 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9140 if (intent != null) {
9141 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009142 }
9143 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009144 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009145 try {
9146 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9147 if (intents != null) {
9148 for (int i = 0; i < intents.length; i++) {
9149 final Intent intent = (Intent) intents[i];
9150 if (intent != null) {
9151 migrated |= intent.migrateExtraStreamToClipData();
9152 }
9153 }
9154 }
9155 } catch (ClassCastException e) {
9156 }
9157 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009158
9159 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009160 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009161 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9162 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9163 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9164 if (stream != null || text != null || htmlText != null) {
9165 final ClipData clipData = new ClipData(
9166 null, new String[] { getType() },
9167 new ClipData.Item(text, htmlText, null, stream));
9168 setClipData(clipData);
9169 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009170 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009171 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009172 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009173 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009174
9175 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009176 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009177 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9178 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9179 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9180 int num = -1;
9181 if (streams != null) {
9182 num = streams.size();
9183 }
9184 if (texts != null) {
9185 if (num >= 0 && num != texts.size()) {
9186 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009187 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009188 }
9189 num = texts.size();
9190 }
9191 if (htmlTexts != null) {
9192 if (num >= 0 && num != htmlTexts.size()) {
9193 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009194 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009195 }
9196 num = htmlTexts.size();
9197 }
9198 if (num > 0) {
9199 final ClipData clipData = new ClipData(
9200 null, new String[] { getType() },
9201 makeClipItem(streams, texts, htmlTexts, 0));
9202
9203 for (int i = 1; i < num; i++) {
9204 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9205 }
9206
9207 setClipData(clipData);
9208 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009209 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009210 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009211 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009212 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009213 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9214 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9215 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9216 final Uri output;
9217 try {
9218 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9219 } catch (ClassCastException e) {
9220 return false;
9221 }
9222 if (output != null) {
9223 setClipData(ClipData.newRawUri("", output));
9224 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9225 return true;
9226 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009227 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009228
9229 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009230 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009231
9232 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9233 ArrayList<String> htmlTexts, int which) {
9234 Uri uri = streams != null ? streams.get(which) : null;
9235 CharSequence text = texts != null ? texts.get(which) : null;
9236 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9237 return new ClipData.Item(text, htmlText, null, uri);
9238 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009239
9240 /** @hide */
9241 public boolean isDocument() {
9242 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9243 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009244}