blob: 28068c54744ca8e92ff2d90cfcf618a32eb03934 [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}
Zak Cohendb6ca492017-01-26 14:09:00 -0800572 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700573 * </ul>
574 *
575 * <h3>Standard Extra Data</h3>
576 *
577 * <p>These are the current standard fields that can be used as extra data via
578 * {@link #putExtra}.
579 *
580 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800581 * <li> {@link #EXTRA_ALARM_COUNT}
582 * <li> {@link #EXTRA_BCC}
583 * <li> {@link #EXTRA_CC}
584 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
585 * <li> {@link #EXTRA_DATA_REMOVED}
586 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500587 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
588 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_DOCK_STATE_CAR}
590 * <li> {@link #EXTRA_DOCK_STATE_DESK}
591 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
592 * <li> {@link #EXTRA_DONT_KILL_APP}
593 * <li> {@link #EXTRA_EMAIL}
594 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800596 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700597 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800598 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700599 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
601 * <li> {@link #EXTRA_REPLACING}
602 * <li> {@link #EXTRA_SHORTCUT_ICON}
603 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
604 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_SHORTCUT_NAME}
607 * <li> {@link #EXTRA_SUBJECT}
608 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800610 * <li> {@link #EXTRA_TITLE}
611 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * </ul>
613 *
614 * <h3>Flags</h3>
615 *
616 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
618 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800620public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700621 private static final String ATTR_ACTION = "action";
622 private static final String TAG_CATEGORIES = "categories";
623 private static final String ATTR_CATEGORY = "category";
624 private static final String TAG_EXTRA = "extra";
625 private static final String ATTR_TYPE = "type";
626 private static final String ATTR_COMPONENT = "component";
627 private static final String ATTR_DATA = "data";
628 private static final String ATTR_FLAGS = "flags";
629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 // ---------------------------------------------------------------------
631 // ---------------------------------------------------------------------
632 // Standard intent activity actions (see action variable).
633
634 /**
635 * Activity Action: Start as a main entry point, does not expect to
636 * receive data.
637 * <p>Input: nothing
638 * <p>Output: nothing
639 */
640 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
641 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700643 /**
644 * Activity Action: Display the data to the user. This is the most common
645 * action performed on data -- it is the generic action you can use on
646 * a piece of data to get the most reasonable thing to occur. For example,
647 * when used on a contacts entry it will view the entry; when used on a
648 * mailto: URI it will bring up a compose window filled with the information
649 * supplied by the URI; when used with a tel: URI it will invoke the
650 * dialer.
651 * <p>Input: {@link #getData} is URI from which to retrieve data.
652 * <p>Output: nothing.
653 */
654 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
655 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700657 /**
658 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
659 * performed on a piece of data.
660 */
661 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900664 * Activity Action: Quick view the data. Launches a quick viewer for
665 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900666 * <p>Activities handling this intent action should handle the vast majority of
667 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900668 * <p>Input: {@link #getData} is a mandatory content URI of the item to
669 * preview. {@link #getClipData} contains an optional list of content URIs
670 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
671 * optional index of the URI in the clip data to show first.
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +0900672 * <p>By default quick viewers are supposed to be lightweight and focus on
673 * previewing the content only. They should not expose features such as printing,
674 * opening in an external app, deleting, rotating, casting, etc.
675 * However, if {@link #EXTRA_QUICK_VIEW_ADVANCED} is true, then the quick viewer
676 * may show advanced UI which includes convenience actions suitable for the passed
677 * Uris.
Steve McKayc78bcb82015-07-31 14:35:22 -0700678 * <p>Output: nothing.
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +0900679 * @see #EXTRA_QUICK_VIEW_ADVANCED
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900680 * @see #EXTRA_INDEX
Steve McKayc78bcb82015-07-31 14:35:22 -0700681 */
682 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
683 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
684
685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700686 * Used to indicate that some piece of data should be attached to some other
687 * place. For example, image data could be attached to a contact. It is up
688 * to the recipient to decide where the data should be attached; the intent
689 * does not specify the ultimate destination.
690 * <p>Input: {@link #getData} is URI of data to be attached.
691 * <p>Output: nothing.
692 */
693 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
694 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700696 /**
697 * Activity Action: Provide explicit editable access to the given data.
698 * <p>Input: {@link #getData} is URI of data to be edited.
699 * <p>Output: nothing.
700 */
701 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
702 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800703
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 /**
705 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
706 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
707 * The extras can contain type specific data to pass through to the editing/creating
708 * activity.
709 * <p>Output: The URI of the item that was picked. This must be a content:
710 * URI so that any receiver can access it.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
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: Pick an item from the data, returning what was selected.
717 * <p>Input: {@link #getData} is URI containing a directory of data
718 * (vnd.android.cursor.dir/*) from which to pick an item.
719 * <p>Output: The URI of the item that was picked.
720 */
721 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
722 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800723
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700724 /**
725 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800726 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800727 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
728 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700729 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
730 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800731 * (value: ShortcutIconResource).</p>
732 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800733 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700734 * @see #EXTRA_SHORTCUT_INTENT
735 * @see #EXTRA_SHORTCUT_NAME
736 * @see #EXTRA_SHORTCUT_ICON
737 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
738 * @see android.content.Intent.ShortcutIconResource
739 */
740 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
741 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
742
743 /**
744 * The name of the extra used to define the Intent of a shortcut.
745 *
746 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800747 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800749 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700750 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
751 /**
752 * The name of the extra used to define the name of a shortcut.
753 *
754 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800755 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700756 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800757 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700758 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
759 /**
760 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
761 *
762 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800765 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700766 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
767 /**
768 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
769 *
770 * @see #ACTION_CREATE_SHORTCUT
771 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800772 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700773 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800774 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700775 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
776 "android.intent.extra.shortcut.ICON_RESOURCE";
777
778 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500779 * An activity that provides a user interface for adjusting application preferences.
780 * Optional but recommended settings for all applications which have settings.
781 */
782 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
783 public static final String ACTION_APPLICATION_PREFERENCES
784 = "android.intent.action.APPLICATION_PREFERENCES";
785
786 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700787 * Activity Action: Launch an activity showing the app information.
788 * For applications which install other applications (such as app stores), it is recommended
789 * to handle this action for providing the app information to the user.
790 *
791 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
792 * to be displayed.
793 * <p>Output: Nothing.
794 */
795 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
796 public static final String ACTION_SHOW_APP_INFO
797 = "android.intent.action.SHOW_APP_INFO";
798
799 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800800 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700801 *
802 * @see Intent#ACTION_CREATE_SHORTCUT
803 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800804 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
805 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700806 */
807 public static class ShortcutIconResource implements Parcelable {
808 /**
809 * The package name of the application containing the icon.
810 */
811 public String packageName;
812
813 /**
814 * The resource name of the icon, including package, name and type.
815 */
816 public String resourceName;
817
818 /**
819 * Creates a new ShortcutIconResource for the specified context and resource
820 * identifier.
821 *
822 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700823 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700825 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700826 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700827 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700828 ShortcutIconResource icon = new ShortcutIconResource();
829 icon.packageName = context.getPackageName();
830 icon.resourceName = context.getResources().getResourceName(resourceId);
831 return icon;
832 }
833
834 /**
835 * Used to read a ShortcutIconResource from a Parcel.
836 */
837 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
838 new Parcelable.Creator<ShortcutIconResource>() {
839
840 public ShortcutIconResource createFromParcel(Parcel source) {
841 ShortcutIconResource icon = new ShortcutIconResource();
842 icon.packageName = source.readString();
843 icon.resourceName = source.readString();
844 return icon;
845 }
846
847 public ShortcutIconResource[] newArray(int size) {
848 return new ShortcutIconResource[size];
849 }
850 };
851
852 /**
853 * No special parcel contents.
854 */
855 public int describeContents() {
856 return 0;
857 }
858
859 public void writeToParcel(Parcel dest, int flags) {
860 dest.writeString(packageName);
861 dest.writeString(resourceName);
862 }
863
864 @Override
865 public String toString() {
866 return resourceName;
867 }
868 }
869
870 /**
871 * Activity Action: Display an activity chooser, allowing the user to pick
872 * what they want to before proceeding. This can be used as an alternative
873 * to the standard activity picker that is displayed by the system when
874 * you try to start an activity with multiple possible matches, with these
875 * differences in behavior:
876 * <ul>
877 * <li>You can specify the title that will appear in the activity chooser.
878 * <li>The user does not have the option to make one of the matching
879 * activities a preferred activity, and all possible activities will
880 * always be shown even if one of them is currently marked as the
881 * preferred activity.
882 * </ul>
883 * <p>
884 * This action should be used when the user will naturally expect to
885 * select an activity in order to proceed. An example if when not to use
886 * it is when the user clicks on a "mailto:" link. They would naturally
887 * expect to go directly to their mail app, so startActivity() should be
888 * called directly: it will
889 * either launch the current preferred app, or put up a dialog allowing the
890 * user to pick an app to use and optionally marking that as preferred.
891 * <p>
892 * In contrast, if the user is selecting a menu item to send a picture
893 * they are viewing to someone else, there are many different things they
894 * may want to do at this point: send it through e-mail, upload it to a
895 * web service, etc. In this case the CHOOSER action should be used, to
896 * always present to the user a list of the things they can do, with a
897 * nice title given by the caller such as "Send this photo with:".
898 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700899 * If you need to grant URI permissions through a chooser, you must specify
900 * the permissions to be granted on the ACTION_CHOOSER Intent
901 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
902 * {@link #setClipData} to specify the URIs to be granted as well as
903 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
904 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
905 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700906 * As a convenience, an Intent of this form can be created with the
907 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700908 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700909 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
911 * and can optionally have a {@link #EXTRA_TITLE} field containing the
912 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700913 * <p>
914 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700915 */
916 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
917 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
918
919 /**
920 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
921 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700922 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
923 * target intent, also optionally supplying a title. If the target
924 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
925 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
926 * set in the returned chooser intent, with its ClipData set appropriately:
927 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500928 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700929 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700930 * @param target The Intent that the user will be selecting an activity
931 * to perform.
932 * @param title Optional title that will be displayed in the chooser.
933 * @return Return a new Intent object that you can hand to
934 * {@link Context#startActivity(Intent) Context.startActivity()} and
935 * related methods.
936 */
937 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700938 return createChooser(target, title, null);
939 }
940
941 /**
942 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
943 *
944 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
945 * target intent, also optionally supplying a title. If the target
946 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
947 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
948 * set in the returned chooser intent, with its ClipData set appropriately:
949 * either a direct reflection of {@link #getClipData()} if that is non-null,
950 * or a new ClipData built from {@link #getData()}.</p>
951 *
952 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
953 * when the user makes a choice. This can be useful if the calling application wants
954 * to remember the last chosen target and surface it as a more prominent or one-touch
955 * affordance elsewhere in the UI for next time.</p>
956 *
957 * @param target The Intent that the user will be selecting an activity
958 * to perform.
959 * @param title Optional title that will be displayed in the chooser.
960 * @param sender Optional IntentSender to be called when a choice is made.
961 * @return Return a new Intent object that you can hand to
962 * {@link Context#startActivity(Intent) Context.startActivity()} and
963 * related methods.
964 */
965 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700966 Intent intent = new Intent(ACTION_CHOOSER);
967 intent.putExtra(EXTRA_INTENT, target);
968 if (title != null) {
969 intent.putExtra(EXTRA_TITLE, title);
970 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700971
Adam Powell0b3c1122014-10-09 12:50:14 -0700972 if (sender != null) {
973 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
974 }
975
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700976 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700977 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
978 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
979 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700980 if (permFlags != 0) {
981 ClipData targetClipData = target.getClipData();
982 if (targetClipData == null && target.getData() != null) {
983 ClipData.Item item = new ClipData.Item(target.getData());
984 String[] mimeTypes;
985 if (target.getType() != null) {
986 mimeTypes = new String[] { target.getType() };
987 } else {
988 mimeTypes = new String[] { };
989 }
990 targetClipData = new ClipData(null, mimeTypes, item);
991 }
992 if (targetClipData != null) {
993 intent.setClipData(targetClipData);
994 intent.addFlags(permFlags);
995 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700996 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700997
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700998 return intent;
999 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07001000
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001001 /**
1002 * Activity Action: Allow the user to select a particular kind of data and
1003 * return it. This is different than {@link #ACTION_PICK} in that here we
1004 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001005 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001006 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001007 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001008 * etc.
1009 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001010 * 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 -07001011 * of data, such as a person contact, you set the MIME type to the kind of
1012 * data you want and launch it with {@link Context#startActivity(Intent)}.
1013 * The system will then launch the best application to select that kind
1014 * of data for you.
1015 * <p>
1016 * You may also be interested in any of a set of types of content the user
1017 * can pick. For example, an e-mail application that wants to allow the
1018 * user to add an attachment to an e-mail message can use this action to
1019 * bring up a list of all of the types of content the user can attach.
1020 * <p>
1021 * In this case, you should wrap the GET_CONTENT intent with a chooser
1022 * (through {@link #createChooser}), which will give the proper interface
1023 * for the user to pick how to send your data and allow you to specify
1024 * a prompt indicating what they are doing. You will usually specify a
1025 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1026 * broad range of content types the user can select from.
1027 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001028 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001029 * only pick from data that can be represented as a stream. This is
1030 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1031 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001032 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001033 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001034 * is locally available on the device. For example, if this extra is set
1035 * to true then an image picker should not show any pictures that are available
1036 * from a remote server but not already on the local device (thus requiring
1037 * they be downloaded when opened).
1038 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001039 * If the caller can handle multiple returned items (the user performing
1040 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1041 * to indicate this.
1042 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001043 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1044 * that no URI is supplied in the intent, as there are no constraints on
1045 * where the returned data originally comes from. You may also include the
1046 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001047 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001048 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1049 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001050 * <p>
1051 * Output: The URI of the item that was picked. This must be a content:
1052 * URI so that any receiver can access it.
1053 */
1054 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1055 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1056 /**
1057 * Activity Action: Dial a number as specified by the data. This shows a
1058 * UI with the number being dialed, allowing the user to explicitly
1059 * initiate the call.
1060 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1061 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1062 * number.
1063 * <p>Output: nothing.
1064 */
1065 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1066 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1067 /**
1068 * Activity Action: Perform a call to someone specified by the data.
1069 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1070 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1071 * number.
1072 * <p>Output: nothing.
1073 *
1074 * <p>Note: there will be restrictions on which applications can initiate a
1075 * call; most applications should use the {@link #ACTION_DIAL}.
1076 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1077 * numbers. Applications can <strong>dial</strong> emergency numbers using
1078 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001079 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001080 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001081 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001082 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001083 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_CALL = "android.intent.action.CALL";
1087 /**
1088 * Activity Action: Perform a call to an emergency number specified by the
1089 * data.
1090 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1091 * tel: URI of an explicit phone number.
1092 * <p>Output: nothing.
1093 * @hide
1094 */
1095 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1096 /**
1097 * Activity action: Perform a call to any number (emergency or not)
1098 * specified by the data.
1099 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1100 * tel: URI of an explicit phone number.
1101 * <p>Output: nothing.
1102 * @hide
1103 */
1104 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1105 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001106 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1107 * sending this intent is a no-op.
1108 * <p>Input: No data should be specified. get*Extra may have an optional
1109 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1110 * send the activation result.
1111 * <p>Output: nothing.
1112 * @hide
1113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1116 "android.intent.action.SIM_ACTIVATION_REQUEST";
1117 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001118 * Activity Action: Send a message to someone specified by the data.
1119 * <p>Input: {@link #getData} is URI describing the target.
1120 * <p>Output: nothing.
1121 */
1122 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1123 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1124 /**
1125 * Activity Action: Deliver some data to someone else. Who the data is
1126 * being delivered to is not specified; it is up to the receiver of this
1127 * action to ask the user where the data should be sent.
1128 * <p>
1129 * When launching a SEND intent, you should usually wrap it in a chooser
1130 * (through {@link #createChooser}), which will give the proper interface
1131 * for the user to pick how to send your data and allow you to specify
1132 * a prompt indicating what they are doing.
1133 * <p>
1134 * Input: {@link #getType} is the MIME type of the data being sent.
1135 * get*Extra can have either a {@link #EXTRA_TEXT}
1136 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1137 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1138 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1139 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001140 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1141 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1142 * your text with HTML formatting.
1143 * <p>
1144 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1145 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1146 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1147 * content: URIs and other advanced features of {@link ClipData}. If
1148 * using this approach, you still must supply the same data through the
1149 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1150 * for compatibility with old applications. If you don't set a ClipData,
1151 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001153 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1154 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1155 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1156 * be openable only as asset typed files using
1157 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1158 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001159 * Optional standard extras, which may be interpreted by some recipients as
1160 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1161 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1162 * <p>
1163 * Output: nothing.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_SEND = "android.intent.action.SEND";
1167 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001168 * Activity Action: Deliver multiple data to someone else.
1169 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001170 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001171 * <p>
1172 * Input: {@link #getType} is the MIME type of the data being sent.
1173 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001174 * #EXTRA_STREAM} field, containing the data to be sent. If using
1175 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1176 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001177 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001178 * Multiple types are supported, and receivers should handle mixed types
1179 * whenever possible. The right way for the receiver to check them is to
1180 * use the content resolver on each URI. The intent sender should try to
1181 * put the most concrete mime type in the intent type, but it can fall
1182 * back to {@literal <type>/*} or {@literal *}/* as needed.
1183 * <p>
1184 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1185 * be image/jpg, but if you are sending image/jpg and image/png, then the
1186 * intent's type should be image/*.
1187 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001188 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1189 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1190 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1191 * content: URIs and other advanced features of {@link ClipData}. If
1192 * using this approach, you still must supply the same data through the
1193 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1194 * for compatibility with old applications. If you don't set a ClipData,
1195 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1196 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001197 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1198 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1199 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1200 * be openable only as asset typed files using
1201 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1202 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001203 * Optional standard extras, which may be interpreted by some recipients as
1204 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1205 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1206 * <p>
1207 * Output: nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1211 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001212 * Activity Action: Handle an incoming phone call.
1213 * <p>Input: nothing.
1214 * <p>Output: nothing.
1215 */
1216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1217 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1218 /**
1219 * Activity Action: Insert an empty item into the given container.
1220 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1221 * in which to place the data.
1222 * <p>Output: URI of the new data that was created.
1223 */
1224 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1225 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1226 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001227 * Activity Action: Create a new item in the given container, initializing it
1228 * from the current contents of the clipboard.
1229 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1230 * in which to place the data.
1231 * <p>Output: URI of the new data that was created.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1235 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001236 * Activity Action: Delete the given data from its container.
1237 * <p>Input: {@link #getData} is URI of data to be deleted.
1238 * <p>Output: nothing.
1239 */
1240 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1241 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1242 /**
1243 * Activity Action: Run the data, whatever that means.
1244 * <p>Input: ? (Note: this is currently specific to the test harness.)
1245 * <p>Output: nothing.
1246 */
1247 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1248 public static final String ACTION_RUN = "android.intent.action.RUN";
1249 /**
1250 * Activity Action: Perform a data synchronization.
1251 * <p>Input: ?
1252 * <p>Output: ?
1253 */
1254 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1255 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1256 /**
1257 * Activity Action: Pick an activity given an intent, returning the class
1258 * selected.
1259 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1260 * used with {@link PackageManager#queryIntentActivities} to determine the
1261 * set of activities from which to pick.
1262 * <p>Output: Class name of the activity that was selected.
1263 */
1264 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1265 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1266 /**
1267 * Activity Action: Perform a search.
1268 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1269 * is the text to search for. If empty, simply
1270 * enter your search results Activity with the search UI activated.
1271 * <p>Output: nothing.
1272 */
1273 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1274 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1275 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001276 * Activity Action: Start the platform-defined tutorial
1277 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1278 * is the text to search for. If empty, simply
1279 * enter your search results Activity with the search UI activated.
1280 * <p>Output: nothing.
1281 */
1282 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1283 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1284 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001285 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001286 * <p>
1287 * Input: {@link android.app.SearchManager#QUERY
1288 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1289 * a url starts with http or https, the site will be opened. If it is plain
1290 * text, Google search will be applied.
1291 * <p>
1292 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001293 */
1294 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1295 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001296
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001297 /**
Jim Miller07994402012-05-02 14:22:27 -07001298 * Activity Action: Perform assist action.
1299 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001300 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1301 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001302 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1303 * information.
Jim Miller07994402012-05-02 14:22:27 -07001304 * Output: nothing.
1305 */
1306 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1307 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001308
1309 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001310 * Activity Action: Perform voice assist action.
1311 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001312 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1313 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001314 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001315 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001316 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001317 */
1318 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1319 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1320
1321 /**
Adam Skory7140a252013-09-11 12:04:58 +01001322 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1323 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001324 */
1325 public static final String EXTRA_ASSIST_PACKAGE
1326 = "android.intent.extra.ASSIST_PACKAGE";
1327
1328 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001329 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1330 * application package at the time the assist was invoked.
1331 */
1332 public static final String EXTRA_ASSIST_UID
1333 = "android.intent.extra.ASSIST_UID";
1334
1335 /**
Adam Skory7140a252013-09-11 12:04:58 +01001336 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1337 * information supplied by the current foreground app at the time of the assist request.
1338 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001339 */
1340 public static final String EXTRA_ASSIST_CONTEXT
1341 = "android.intent.extra.ASSIST_CONTEXT";
1342
Jim Miller07994402012-05-02 14:22:27 -07001343 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001344 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1345 * keyboard as the primary input device for assistance.
1346 */
1347 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1348 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1349
1350 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001351 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1352 * that was used to invoke the assist.
1353 */
1354 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1355 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1356
1357 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001358 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001359 * <p>Input: Nothing.
1360 * <p>Output: nothing.
1361 */
1362 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1363 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1364 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001365 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001366 * <p>Input: Nothing.
1367 * <p>Output: Nothing.
1368 */
1369 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1370 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1371
1372 /**
1373 * Activity Action: Show activity for reporting a bug.
1374 * <p>Input: Nothing.
1375 * <p>Output: Nothing.
1376 */
1377 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1378 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1379
1380 /**
1381 * Activity Action: Main entry point for factory tests. Only used when
1382 * the device is booting in factory test node. The implementing package
1383 * must be installed in the system image.
1384 * <p>Input: nothing
1385 * <p>Output: nothing
1386 */
1387 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1388
1389 /**
1390 * Activity Action: The user pressed the "call" button to go to the dialer
1391 * or other appropriate UI for placing a call.
1392 * <p>Input: Nothing.
1393 * <p>Output: Nothing.
1394 */
1395 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1396 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1397
1398 /**
1399 * Activity Action: Start Voice Command.
1400 * <p>Input: Nothing.
1401 * <p>Output: Nothing.
1402 */
1403 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1404 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001405
1406 /**
1407 * Activity Action: Start action associated with long pressing on the
1408 * search key.
1409 * <p>Input: Nothing.
1410 * <p>Output: Nothing.
1411 */
1412 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1413 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001414
Jacek Surazski86b6c532009-05-13 14:38:28 +02001415 /**
1416 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1417 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001418 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001419 * <p>Input: No data is specified. The bug report is passed in using
1420 * an {@link #EXTRA_BUG_REPORT} field.
1421 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001422 *
1423 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001424 */
1425 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1426 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001427
1428 /**
1429 * Activity Action: Show power usage information to the user.
1430 * <p>Input: Nothing.
1431 * <p>Output: Nothing.
1432 */
1433 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1434 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001435
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001436 /**
1437 * Activity Action: Setup wizard to launch after a platform update. This
1438 * activity should have a string meta-data field associated with it,
1439 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1440 * the platform for setup. The activity will be launched only if
1441 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1442 * same value.
1443 * <p>Input: Nothing.
1444 * <p>Output: Nothing.
1445 * @hide
1446 */
1447 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1448 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001449
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001450 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001451 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1452 * <p>Input: Nothing.
1453 * <p>Output: Nothing.
1454 * @hide
1455 */
1456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1457 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1458 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1459
1460 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001461 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1462 * <p>Input: Nothing.
1463 * <p>Output: Nothing.
1464 * @hide
1465 */
1466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1467 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1468 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1469
1470 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001471 * Activity Action: Show settings for managing network data usage of a
1472 * specific application. Applications should define an activity that offers
1473 * options to control data usage.
1474 */
1475 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1476 public static final String ACTION_MANAGE_NETWORK_USAGE =
1477 "android.intent.action.MANAGE_NETWORK_USAGE";
1478
1479 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001480 * Activity Action: Launch application installer.
1481 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001482 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001483 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1484 * you can also use "package:<package-name>" to install an application for the
1485 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001486 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1487 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1488 * <p>
1489 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1490 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001491 * <p>
1492 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1493 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1494 * in order to launch the application installer.
1495 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001496 *
1497 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1498 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1499 * @see #EXTRA_RETURN_RESULT
1500 */
1501 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1502 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1503
1504 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001505 * Activity Action: Launch ephemeral installer.
1506 * <p>
1507 * Input: The data must be a http: URI that the ephemeral application is registered
1508 * to handle.
1509 * <p class="note">
1510 * This is a protected intent that can only be sent by the system.
1511 * </p>
1512 *
1513 * @hide
1514 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001515 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1516 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1517 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1518
1519 /**
1520 * Service Action: Resolve ephemeral application.
1521 * <p>
1522 * The system will have a persistent connection to this service.
1523 * This is a protected intent that can only be sent by the system.
1524 * </p>
1525 *
1526 * @hide
1527 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001528 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1529 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1530 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1531
1532 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001533 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1534 * package. Specifies the installer package name; this package will receive the
1535 * {@link #ACTION_APP_ERROR} intent.
1536 */
1537 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1538 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1539
1540 /**
1541 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1542 * package. Specifies that the application being installed should not be
1543 * treated as coming from an unknown source, but as coming from the app
1544 * invoking the Intent. For this to work you must start the installer with
1545 * startActivityForResult().
1546 */
1547 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1548 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1549
1550 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001551 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1552 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001553 * data field originated from.
1554 */
rich cannings706e8ba2012-08-20 13:20:14 -07001555 public static final String EXTRA_ORIGINATING_URI
1556 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001557
1558 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001559 * This extra can be used with any Intent used to launch an activity, supplying information
1560 * about who is launching that activity. This field contains a {@link android.net.Uri}
1561 * object, typically an http: or https: URI of the web site that the referral came from;
1562 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1563 * a native application that it came from.
1564 *
1565 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1566 * instead of directly retrieving the extra. It is also valid for applications to
1567 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1568 * a string, not a Uri; the field here, if supplied, will always take precedence,
1569 * however.</p>
1570 *
1571 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001572 */
1573 public static final String EXTRA_REFERRER
1574 = "android.intent.extra.REFERRER";
1575
1576 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001577 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1578 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1579 * not be created, in particular when Intent extras are supplied through the
1580 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1581 * schemes.
1582 *
1583 * @see #EXTRA_REFERRER
1584 */
1585 public static final String EXTRA_REFERRER_NAME
1586 = "android.intent.extra.REFERRER_NAME";
1587
1588 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001589 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001590 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001591 * @hide
1592 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001593 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001594 public static final String EXTRA_ORIGINATING_UID
1595 = "android.intent.extra.ORIGINATING_UID";
1596
1597 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001598 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1599 * package. Tells the installer UI to skip the confirmation with the user
1600 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001601 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1602 * will no longer show an interstitial message about updating existing
1603 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001604 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001605 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001606 public static final String EXTRA_ALLOW_REPLACE
1607 = "android.intent.extra.ALLOW_REPLACE";
1608
1609 /**
1610 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1611 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1612 * return to the application the result code of the install/uninstall. The returned result
1613 * code will be {@link android.app.Activity#RESULT_OK} on success or
1614 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1615 */
1616 public static final String EXTRA_RETURN_RESULT
1617 = "android.intent.extra.RETURN_RESULT";
1618
1619 /**
1620 * Package manager install result code. @hide because result codes are not
1621 * yet ready to be exposed.
1622 */
1623 public static final String EXTRA_INSTALL_RESULT
1624 = "android.intent.extra.INSTALL_RESULT";
1625
1626 /**
1627 * Activity Action: Launch application uninstaller.
1628 * <p>
1629 * Input: The data must be a package: URI whose scheme specific part is
1630 * the package name of the current installed package to be uninstalled.
1631 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1632 * <p>
1633 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1634 * succeeded.
1635 */
1636 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1637 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1638
1639 /**
msnider3c191b82017-01-23 14:23:16 -08001640 * Activity Action: Launch application uninstaller.
1641 * <p>
1642 * Input: The data must be a package: URI whose scheme specific part is
1643 * the package name of the current installed package to be uninstalled.
1644 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1645 * <p>
1646 * Output: Nothing.
1647 * </p>
1648 */
1649 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1650 public static final String ACTION_CLEAR_PACKAGE = "android.intent.action.CLEAR_PACKAGE";
1651
1652 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001653 * Specify whether the package should be uninstalled for all users.
1654 * @hide because these should not be part of normal application flow.
1655 */
1656 public static final String EXTRA_UNINSTALL_ALL_USERS
1657 = "android.intent.extra.UNINSTALL_ALL_USERS";
1658
1659 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001660 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1661 * describing the last run version of the platform that was setup.
1662 * @hide
1663 */
1664 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1665
Svet Ganov3695b8a2015-03-24 16:30:25 -07001666 /**
1667 * Activity action: Launch UI to manage the permissions of an app.
1668 * <p>
1669 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1670 * will be managed by the launched UI.
1671 * </p>
1672 * <p>
1673 * Output: Nothing.
1674 * </p>
1675 *
1676 * @see #EXTRA_PACKAGE_NAME
1677 *
1678 * @hide
1679 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001680 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001681 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1682 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1683 "android.intent.action.MANAGE_APP_PERMISSIONS";
1684
1685 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001686 * Activity action: Launch UI to manage permissions.
1687 * <p>
1688 * Input: Nothing.
1689 * </p>
1690 * <p>
1691 * Output: Nothing.
1692 * </p>
1693 *
1694 * @hide
1695 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001696 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001697 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1698 public static final String ACTION_MANAGE_PERMISSIONS =
1699 "android.intent.action.MANAGE_PERMISSIONS";
1700
1701 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001702 * Activity action: Launch UI to review permissions for an app.
1703 * The system uses this intent if permission review for apps not
1704 * supporting the new runtime permissions model is enabled. In
1705 * this mode a permission review is required before any of the
1706 * app components can run.
1707 * <p>
1708 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1709 * permissions will be reviewed (mandatory).
1710 * </p>
1711 * <p>
1712 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1713 * be fired after the permission review (optional).
1714 * </p>
1715 * <p>
1716 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1717 * be invoked after the permission review (optional).
1718 * </p>
1719 * <p>
1720 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1721 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1722 * </p>
1723 * <p>
1724 * Output: Nothing.
1725 * </p>
1726 *
1727 * @see #EXTRA_PACKAGE_NAME
1728 * @see #EXTRA_INTENT
1729 * @see #EXTRA_REMOTE_CALLBACK
1730 * @see #EXTRA_RESULT_NEEDED
1731 *
1732 * @hide
1733 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001734 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001735 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1736 public static final String ACTION_REVIEW_PERMISSIONS =
1737 "android.intent.action.REVIEW_PERMISSIONS";
1738
1739 /**
1740 * Intent extra: A callback for reporting remote result as a bundle.
1741 * <p>
1742 * Type: IRemoteCallback
1743 * </p>
1744 *
1745 * @hide
1746 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001747 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001748 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1749
1750 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001751 * Intent extra: An app package name.
1752 * <p>
1753 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001754 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001755 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001756 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001757 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1758
1759 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001760 * Intent extra: An app split name.
1761 * <p>
1762 * Type: String
1763 * </p>
1764 * @hide
1765 */
1766 @SystemApi
1767 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1768
1769 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001770 * Intent extra: An extra for specifying whether a result is needed.
1771 * <p>
1772 * Type: boolean
1773 * </p>
1774 *
1775 * @hide
1776 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001777 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001778 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1779
1780 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001781 * Activity action: Launch UI to manage which apps have a given permission.
1782 * <p>
1783 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1784 * to which will be managed by the launched UI.
1785 * </p>
1786 * <p>
1787 * Output: Nothing.
1788 * </p>
1789 *
1790 * @see #EXTRA_PERMISSION_NAME
1791 *
1792 * @hide
1793 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001794 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001795 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1796 public static final String ACTION_MANAGE_PERMISSION_APPS =
1797 "android.intent.action.MANAGE_PERMISSION_APPS";
1798
1799 /**
1800 * Intent extra: The name of a permission.
1801 * <p>
1802 * Type: String
1803 * </p>
1804 *
1805 * @hide
1806 */
1807 @SystemApi
1808 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1809
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001810 // ---------------------------------------------------------------------
1811 // ---------------------------------------------------------------------
1812 // Standard intent broadcast actions (see action variable).
1813
1814 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001815 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1816 * <p>
1817 * For historical reasons, the name of this broadcast action refers to the power
1818 * state of the screen but it is actually sent in response to changes in the
1819 * overall interactive state of the device.
1820 * </p><p>
1821 * This broadcast is sent when the device becomes non-interactive which may have
1822 * nothing to do with the screen turning off. To determine the
1823 * actual state of the screen, use {@link android.view.Display#getState}.
1824 * </p><p>
1825 * See {@link android.os.PowerManager#isInteractive} for details.
1826 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001827 * You <em>cannot</em> receive this through components declared in
1828 * manifests, only by explicitly registering for it with
1829 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1830 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001831 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001832 * <p class="note">This is a protected intent that can only be sent
1833 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001834 */
1835 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1836 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001837
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001838 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001839 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1840 * <p>
1841 * For historical reasons, the name of this broadcast action refers to the power
1842 * state of the screen but it is actually sent in response to changes in the
1843 * overall interactive state of the device.
1844 * </p><p>
1845 * This broadcast is sent when the device becomes interactive which may have
1846 * nothing to do with the screen turning on. To determine the
1847 * actual state of the screen, use {@link android.view.Display#getState}.
1848 * </p><p>
1849 * See {@link android.os.PowerManager#isInteractive} for details.
1850 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001851 * You <em>cannot</em> receive this through components declared in
1852 * manifests, only by explicitly registering for it with
1853 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1854 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001855 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001856 * <p class="note">This is a protected intent that can only be sent
1857 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001861
1862 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001863 * Broadcast Action: Sent after the system stops dreaming.
1864 *
1865 * <p class="note">This is a protected intent that can only be sent by the system.
1866 * It is only sent to registered receivers.</p>
1867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1870
1871 /**
1872 * Broadcast Action: Sent after the system starts dreaming.
1873 *
1874 * <p class="note">This is a protected intent that can only be sent by the system.
1875 * It is only sent to registered receivers.</p>
1876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1878 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1879
1880 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001881 * 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 -07001882 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001888 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001889
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001890 /**
1891 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001892 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001893 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001894 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1895 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001896 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * <p class="note">This is a protected intent that can only be sent
1898 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001899 */
1900 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1901 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1902 /**
1903 * Broadcast Action: The time was set.
1904 */
1905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1906 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1907 /**
1908 * Broadcast Action: The date has changed.
1909 */
1910 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1911 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1912 /**
1913 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1914 * <ul>
1915 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1916 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001917 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001918 * <p class="note">This is a protected intent that can only be sent
1919 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001920 */
1921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1923 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001924 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1925 * DNS entries should be tossed.
1926 * @hide
1927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1930 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001931 * Alarm Changed Action: This is broadcast when the AlarmClock
1932 * application's alarm is set or unset. It is used by the
1933 * AlarmClock application and the StatusBar service.
1934 * @hide
1935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1937 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001938
1939 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001940 * Broadcast Action: This is broadcast once, after the user has finished
1941 * booting, but while still in the "locked" state. It can be used to perform
1942 * application-specific initialization, such as installing alarms. You must
1943 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1944 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001945 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001946 * This broadcast is sent immediately at boot by all devices (regardless of
1947 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1948 * higher. Upon receipt of this broadcast, the user is still locked and only
1949 * device-protected storage can be accessed safely. If you want to access
1950 * credential-protected storage, you need to wait for the user to be
1951 * unlocked (typically by entering their lock pattern or PIN for the first
1952 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1953 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1954 * <p>
1955 * To receive this broadcast, your receiver component must be marked as
1956 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001957 * <p class="note">
1958 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001959 *
1960 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1964
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001965 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001966 * Broadcast Action: This is broadcast once, after the user has finished
1967 * booting. It can be used to perform application-specific initialization,
1968 * such as installing alarms. You must hold the
1969 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1970 * order to receive this broadcast.
1971 * <p>
1972 * This broadcast is sent at boot by all devices (both with and without
1973 * direct boot support). Upon receipt of this broadcast, the user is
1974 * unlocked and both device-protected and credential-protected storage can
1975 * accessed safely.
1976 * <p>
1977 * If you need to run while the user is still locked (before they've entered
1978 * their lock pattern or PIN for the first time), you can listen for the
1979 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1980 * <p class="note">
1981 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001982 */
1983 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1984 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001985
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001986 /**
1987 * Broadcast Action: This is broadcast when a user action should request a
1988 * temporary system dialog to dismiss. Some examples of temporary system
1989 * dialogs are the notification window-shade and the recent tasks dialog.
1990 */
1991 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1992 /**
1993 * Broadcast Action: Trigger the download and eventual installation
1994 * of a package.
1995 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001996 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001997 * <p class="note">This is a protected intent that can only be sent
1998 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001999 *
2000 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002001 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002002 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2004 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2005 /**
2006 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002007 * device. The data contains the name of the package. Note that the
2008 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002009 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002010 * <ul>
2011 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2012 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2013 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2014 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002015 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002016 * <p class="note">This is a protected intent that can only be sent
2017 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 */
2019 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2020 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2021 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002022 * Broadcast Action: A new version of an application package has been
2023 * installed, replacing an existing version that was previously installed.
2024 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002025 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002026 * <ul>
2027 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2028 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002029 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002030 * <p class="note">This is a protected intent that can only be sent
2031 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2035 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002036 * Broadcast Action: A new version of your application has been installed
2037 * over an existing one. This is only sent to the application that was
2038 * replaced. It does not contain any additional data; to receive it, just
2039 * use an intent filter for this action.
2040 *
2041 * <p class="note">This is a protected intent that can only be sent
2042 * by the system.
2043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2046 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002047 * Broadcast Action: An existing application package has been removed from
2048 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002049 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002050 * <ul>
2051 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2052 * to the package.
2053 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2054 * application -- data and code -- is being removed.
2055 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2056 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2057 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002058 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002059 * <p class="note">This is a protected intent that can only be sent
2060 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002061 */
2062 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2063 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2064 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002065 * Broadcast Action: An existing application package has been completely
2066 * removed from the device. The data contains the name of the package.
2067 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2068 * {@link #EXTRA_DATA_REMOVED} is true and
2069 * {@link #EXTRA_REPLACING} is false of that broadcast.
2070 *
2071 * <ul>
2072 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2073 * to the package.
2074 * </ul>
2075 *
2076 * <p class="note">This is a protected intent that can only be sent
2077 * by the system.
2078 */
2079 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2080 public static final String ACTION_PACKAGE_FULLY_REMOVED
2081 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2082 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002083 * Broadcast Action: An existing application package has been changed (for
2084 * example, a component has been enabled or disabled). The data contains
2085 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002086 * <ul>
2087 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002088 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002089 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002090 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2091 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002092 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002093 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002094 * <p class="note">This is a protected intent that can only be sent
2095 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 */
2097 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2098 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2099 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002100 * @hide
2101 * Broadcast Action: Ask system services if there is any reason to
2102 * restart the given package. The data contains the name of the
2103 * package.
2104 * <ul>
2105 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2106 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2107 * </ul>
2108 *
2109 * <p class="note">This is a protected intent that can only be sent
2110 * by the system.
2111 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002112 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2115 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002116 * Broadcast Action: The user has restarted a package, and all of its
2117 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002118 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002119 * be removed. Note that the restarted package does <em>not</em>
2120 * receive this broadcast.
2121 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002122 * <ul>
2123 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2124 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002125 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002126 * <p class="note">This is a protected intent that can only be sent
2127 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2131 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002132 * Broadcast Action: The user has cleared the data of a package. This should
2133 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002134 * its persistent data is erased and this broadcast sent.
2135 * Note that the cleared package does <em>not</em>
2136 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002137 * <ul>
2138 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2139 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002140 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002141 * <p class="note">This is a protected intent that can only be sent
2142 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2146 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002147 * Broadcast Action: Packages have been suspended.
2148 * <p>Includes the following extras:
2149 * <ul>
2150 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2151 * </ul>
2152 *
2153 * <p class="note">This is a protected intent that can only be sent
2154 * by the system. It is only sent to registered receivers.
2155 */
2156 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2157 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2158 /**
2159 * Broadcast Action: Packages have been unsuspended.
2160 * <p>Includes the following extras:
2161 * <ul>
2162 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2163 * </ul>
2164 *
2165 * <p class="note">This is a protected intent that can only be sent
2166 * by the system. It is only sent to registered receivers.
2167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2170 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002171 * Broadcast Action: A user ID has been removed from the system. The user
2172 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002173 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002174 * <p class="note">This is a protected intent that can only be sent
2175 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002176 */
2177 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2178 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002179
2180 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002181 * Broadcast Action: Sent to the installer package of an application when
2182 * that application is first launched (that is the first time it is moved
2183 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002184 *
2185 * <p class="note">This is a protected intent that can only be sent
2186 * by the system.
2187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2189 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2190
2191 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002192 * Broadcast Action: Sent to the system package verifier when a package
2193 * needs to be verified. The data contains the package URI.
2194 * <p class="note">
2195 * This is a protected intent that can only be sent by the system.
2196 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002197 */
2198 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2199 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2200
2201 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002202 * Broadcast Action: Sent to the system package verifier when a package is
2203 * verified. The data contains the package URI.
2204 * <p class="note">
2205 * This is a protected intent that can only be sent by the system.
2206 */
2207 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2208 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2209
2210 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002211 * Broadcast Action: Sent to the system intent filter verifier when an
2212 * intent filter needs to be verified. The data contains the filter data
2213 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002214 * <p class="note">
2215 * This is a protected intent that can only be sent by the system.
2216 * </p>
2217 *
2218 * @hide
2219 */
2220 @SystemApi
2221 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2222 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2223
2224 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002225 * Broadcast Action: Resources for a set of packages (which were
2226 * previously unavailable) are currently
2227 * available since the media on which they exist is available.
2228 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2229 * list of packages whose availability changed.
2230 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2231 * list of uids of packages whose availability changed.
2232 * Note that the
2233 * packages in this list do <em>not</em> receive this broadcast.
2234 * The specified set of packages are now available on the system.
2235 * <p>Includes the following extras:
2236 * <ul>
2237 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2238 * whose resources(were previously unavailable) are currently available.
2239 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2240 * packages whose resources(were previously unavailable)
2241 * are currently available.
2242 * </ul>
2243 *
2244 * <p class="note">This is a protected intent that can only be sent
2245 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002248 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2249 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002250
2251 /**
2252 * Broadcast Action: Resources for a set of packages are currently
2253 * unavailable since the media on which they exist is unavailable.
2254 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2255 * list of packages whose availability changed.
2256 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2257 * list of uids of packages whose availability changed.
2258 * The specified set of packages can no longer be
2259 * launched and are practically unavailable on the system.
2260 * <p>Inclues the following extras:
2261 * <ul>
2262 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2263 * whose resources are no longer available.
2264 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2265 * whose resources are no longer available.
2266 * </ul>
2267 *
2268 * <p class="note">This is a protected intent that can only be sent
2269 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002270 */
2271 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002272 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002273 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002274
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002276 * Broadcast Action: preferred activities have changed *explicitly*.
2277 *
2278 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2279 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2280 * be sent.
2281 *
2282 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2283 *
2284 * @hide
2285 */
2286 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2287 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2288 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2289
2290
2291 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002292 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002293 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002294 * This should <em>only</em> be used to determine when the wallpaper
2295 * has changed to show the new wallpaper to the user. You should certainly
2296 * never, in response to this, change the wallpaper or other attributes of
2297 * it such as the suggested size. That would be crazy, right? You'd cause
2298 * all kinds of loops, especially if other apps are doing similar things,
2299 * right? Of course. So please don't do this.
2300 *
2301 * @deprecated Modern applications should use
2302 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2303 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2304 * shown behind their UI, rather than watching for this broadcast and
2305 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002306 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002307 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002308 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2309 /**
2310 * Broadcast Action: The current device {@link android.content.res.Configuration}
2311 * (orientation, locale, etc) has changed. When such a change happens, the
2312 * UIs (view hierarchy) will need to be rebuilt based on this new
2313 * information; for the most part, applications don't need to worry about
2314 * this, because the system will take care of stopping and restarting the
2315 * application to make sure it sees the new changes. Some system code that
2316 * can not be restarted will need to watch for this action and handle it
2317 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002318 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002319 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002320 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002321 * in manifests, only by explicitly registering for it with
2322 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2323 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002324 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002325 * <p class="note">This is a protected intent that can only be sent
2326 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002327 *
2328 * @see android.content.res.Configuration
2329 */
2330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2331 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2332 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002333 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002334 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002335 * <p class="note">This is a protected intent that can only be sent
2336 * by the system.
2337 */
2338 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2339 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2340 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002341 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2342 * charging state, level, and other information about the battery.
2343 * See {@link android.os.BatteryManager} for documentation on the
2344 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002345 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002346 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002347 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002348 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002349 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002350 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2351 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2352 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2353 * broadcasts that are sent and can be received through manifest
2354 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002355 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002356 * <p class="note">This is a protected intent that can only be sent
2357 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002358 */
2359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2360 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2361 /**
2362 * Broadcast Action: Indicates low battery condition on the device.
2363 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002364 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002365 * <p class="note">This is a protected intent that can only be sent
2366 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002367 */
2368 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2369 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2370 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002371 * Broadcast Action: Indicates the battery is now okay after being low.
2372 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2373 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002374 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002375 * <p class="note">This is a protected intent that can only be sent
2376 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002377 */
2378 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2379 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2380 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002381 * Broadcast Action: External power has been connected to the device.
2382 * This is intended for applications that wish to register specifically to this notification.
2383 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2384 * stay active to receive this notification. This action can be used to implement actions
2385 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002386 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002387 * <p class="note">This is a protected intent that can only be sent
2388 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002389 */
2390 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002391 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002392 /**
2393 * Broadcast Action: External power has been removed from the device.
2394 * This is intended for applications that wish to register specifically to this notification.
2395 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2396 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002397 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002398 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002399 * <p class="note">This is a protected intent that can only be sent
2400 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002401 */
2402 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002403 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002404 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002405 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002406 * Broadcast Action: Device is shutting down.
2407 * This is broadcast when the device is being shut down (completely turned
2408 * off, not sleeping). Once the broadcast is complete, the final shutdown
2409 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002410 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002411 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002412 * <p class="note">This is a protected intent that can only be sent
2413 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002414 * <p>May include the following extras:
2415 * <ul>
2416 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2417 * shutdown is only for userspace processes. If not set, assumed to be false.
2418 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002419 */
2420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002421 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002422 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002423 * Activity Action: Start this activity to request system shutdown.
2424 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002425 * to request confirmation from the user before shutting down. The optional boolean
2426 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2427 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002428 *
2429 * <p class="note">This is a protected intent that can only be sent
2430 * by the system.
2431 *
2432 * {@hide}
2433 */
2434 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2435 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002436 * Broadcast Action: A sticky broadcast that indicates low memory
2437 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002438 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002439 * <p class="note">This is a protected intent that can only be sent
2440 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002441 */
2442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2443 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2444 /**
2445 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002446 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002447 * <p class="note">This is a protected intent that can only be sent
2448 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002449 */
2450 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2451 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2452 /**
Jake Hambybb371632010-08-23 18:16:48 -07002453 * Broadcast Action: A sticky broadcast that indicates a memory full
2454 * condition on the device. This is intended for activities that want
2455 * to be able to fill the data partition completely, leaving only
2456 * enough free space to prevent system-wide SQLite failures.
2457 *
2458 * <p class="note">This is a protected intent that can only be sent
2459 * by the system.
2460 *
2461 * {@hide}
2462 */
2463 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2464 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2465 /**
2466 * Broadcast Action: Indicates memory full condition on the device
2467 * no longer exists.
2468 *
2469 * <p class="note">This is a protected intent that can only be sent
2470 * by the system.
2471 *
2472 * {@hide}
2473 */
2474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2475 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2476 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002477 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2478 * and package management should be started.
2479 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2480 * notification.
2481 */
2482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2483 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2484 /**
2485 * Broadcast Action: The device has entered USB Mass Storage mode.
2486 * This is used mainly for the USB Settings panel.
2487 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2488 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002489 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002490 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002491 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002492 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2493
2494 /**
2495 * Broadcast Action: The device has exited USB Mass Storage mode.
2496 * This is used mainly for the USB Settings panel.
2497 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2498 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002499 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002500 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002501 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002502 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2503
2504 /**
2505 * Broadcast Action: External media has been removed.
2506 * The path to the mount point for the removed media is contained in the Intent.mData field.
2507 */
2508 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2509 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2510
2511 /**
2512 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002513 * 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 -07002514 */
2515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2516 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2517
2518 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002519 * Broadcast Action: External media is present, and being disk-checked
2520 * 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 -08002521 */
2522 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2523 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2524
2525 /**
2526 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2527 * 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 -08002528 */
2529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2530 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2531
2532 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002533 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002534 * 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 -07002535 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2536 * media was mounted read only.
2537 */
2538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2539 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2540
2541 /**
2542 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002543 * 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 -07002544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2547
2548 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002549 * Broadcast Action: External media is no longer being shared via USB mass storage.
2550 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2551 *
2552 * @hide
2553 */
2554 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2555
2556 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002557 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2558 * The path to the mount point for the removed media is contained in the Intent.mData field.
2559 */
2560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2561 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2562
2563 /**
2564 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002565 * 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 -07002566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2569
2570 /**
2571 * Broadcast Action: User has expressed the desire to remove the external storage media.
2572 * Applications should close all files they have open within the mount point when they receive this intent.
2573 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2574 */
2575 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2576 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2577
2578 /**
2579 * Broadcast Action: The media scanner has started scanning a directory.
2580 * The path to the directory being scanned is contained in the Intent.mData field.
2581 */
2582 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2583 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2584
2585 /**
2586 * Broadcast Action: The media scanner has finished scanning a directory.
2587 * The path to the scanned directory is contained in the Intent.mData field.
2588 */
2589 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2590 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2591
2592 /**
2593 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2594 * The path to the file is contained in the Intent.mData field.
2595 */
2596 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2597 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2598
2599 /**
2600 * Broadcast Action: The "Media Button" was pressed. Includes a single
2601 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2602 * caused the broadcast.
2603 */
2604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2605 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2606
2607 /**
2608 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2609 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2610 * caused the broadcast.
2611 */
2612 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2613 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2614
2615 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2616 // location; they are not general-purpose actions.
2617
2618 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002619 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002620 */
2621 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2622 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2623 "android.intent.action.GTALK_CONNECTED";
2624
2625 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002626 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002627 */
2628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2629 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2630 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002631
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002632 /**
2633 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002634 */
2635 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2636 public static final String ACTION_INPUT_METHOD_CHANGED =
2637 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002638
2639 /**
2640 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2641 * more radios have been turned off or on. The intent will have the following extra value:</p>
2642 * <ul>
2643 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2644 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2645 * turned off</li>
2646 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002647 *
Peng Xua35b5532016-01-20 00:05:45 -08002648 * <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 -07002649 */
2650 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2651 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2652
2653 /**
2654 * Broadcast Action: Some content providers have parts of their namespace
2655 * where they publish new events or items that the user may be especially
2656 * interested in. For these things, they may broadcast this action when the
2657 * set of interesting items change.
2658 *
2659 * For example, GmailProvider sends this notification when the set of unread
2660 * mail in the inbox changes.
2661 *
2662 * <p>The data of the intent identifies which part of which provider
2663 * changed. When queried through the content resolver, the data URI will
2664 * return the data set in question.
2665 *
2666 * <p>The intent will have the following extra values:
2667 * <ul>
2668 * <li><em>count</em> - The number of items in the data set. This is the
2669 * same as the number of items in the cursor returned by querying the
2670 * data URI. </li>
2671 * </ul>
2672 *
2673 * This intent will be sent at boot (if the count is non-zero) and when the
2674 * data set changes. It is possible for the data set to change without the
2675 * count changing (for example, if a new unread message arrives in the same
2676 * sync operation in which a message is archived). The phone should still
2677 * ring/vibrate/etc as normal in this case.
2678 */
2679 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2680 public static final String ACTION_PROVIDER_CHANGED =
2681 "android.intent.action.PROVIDER_CHANGED";
2682
2683 /**
2684 * Broadcast Action: Wired Headset plugged in or unplugged.
2685 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002686 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2687 * and documentation.
2688 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002689 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002690 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 */
2692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002693 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002694
2695 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002696 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2697 * <ul>
2698 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2699 * </ul>
2700 *
2701 * <p class="note">This is a protected intent that can only be sent
2702 * by the system.
2703 *
2704 * @hide
2705 */
2706 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2707 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2708 = "android.intent.action.ADVANCED_SETTINGS";
2709
2710 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002711 * Broadcast Action: Sent after application restrictions are changed.
2712 *
2713 * <p class="note">This is a protected intent that can only be sent
2714 * by the system.</p>
2715 */
2716 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2717 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2718 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2719
2720 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002721 * Broadcast Action: An outgoing call is about to be placed.
2722 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002723 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002725 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002726 * the phone number originally intended to be dialed.</li>
2727 * </ul>
2728 * <p>Once the broadcast is finished, the resultData is used as the actual
2729 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002730 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 * outgoing call in turn: for example, a parental control application
2732 * might verify that the user is authorized to place the call at that
2733 * time, then a number-rewriting application might add an area code if
2734 * one was not specified.</p>
2735 * <p>For consistency, any receiver whose purpose is to prohibit phone
2736 * calls should have a priority of 0, to ensure it will see the final
2737 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002738 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002739 * should have a positive priority.
2740 * Negative priorities are reserved for the system for this broadcast;
2741 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002742 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2743 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002744 * <p>Emergency calls cannot be intercepted using this mechanism, and
2745 * other calls cannot be modified to call emergency numbers using this
2746 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002747 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2748 * call to use their own service instead. Those apps should first prevent
2749 * the call from being placed by setting resultData to <code>null</code>
2750 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002751 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002752 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2753 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002754 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002755 * <p class="note">This is a protected intent that can only be sent
2756 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002757 */
2758 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2759 public static final String ACTION_NEW_OUTGOING_CALL =
2760 "android.intent.action.NEW_OUTGOING_CALL";
2761
2762 /**
2763 * Broadcast Action: Have the device reboot. This is only for use by
2764 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002765 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002766 * <p class="note">This is a protected intent that can only be sent
2767 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002768 */
2769 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2770 public static final String ACTION_REBOOT =
2771 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002772
Wei Huang97ecc9c2009-05-11 17:44:20 -07002773 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002774 * Broadcast Action: A sticky broadcast for changes in the physical
2775 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002776 *
2777 * <p>The intent will have the following extra values:
2778 * <ul>
2779 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002780 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002781 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002782 * <p>This is intended for monitoring the current physical dock state.
2783 * See {@link android.app.UiModeManager} for the normal API dealing with
2784 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002785 */
2786 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2787 public static final String ACTION_DOCK_EVENT =
2788 "android.intent.action.DOCK_EVENT";
2789
2790 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002791 * Broadcast Action: A broadcast when idle maintenance can be started.
2792 * This means that the user is not interacting with the device and is
2793 * not expected to do so soon. Typical use of the idle maintenance is
2794 * to perform somehow expensive tasks that can be postponed at a moment
2795 * when they will not degrade user experience.
2796 * <p>
2797 * <p class="note">In order to keep the device responsive in case of an
2798 * unexpected user interaction, implementations of a maintenance task
2799 * should be interruptible. In such a scenario a broadcast with action
2800 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2801 * should not do the maintenance work in
2802 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2803 * maintenance service by {@link Context#startService(Intent)}. Also
2804 * you should hold a wake lock while your maintenance service is running
2805 * to prevent the device going to sleep.
2806 * </p>
2807 * <p>
2808 * <p class="note">This is a protected intent that can only be sent by
2809 * the system.
2810 * </p>
2811 *
2812 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002813 *
2814 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002815 */
2816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2817 public static final String ACTION_IDLE_MAINTENANCE_START =
2818 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2819
2820 /**
2821 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2822 * This means that the user was not interacting with the device as a result
2823 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2824 * was sent and now the user started interacting with the device. Typical
2825 * use of the idle maintenance is to perform somehow expensive tasks that
2826 * can be postponed at a moment when they will not degrade user experience.
2827 * <p>
2828 * <p class="note">In order to keep the device responsive in case of an
2829 * unexpected user interaction, implementations of a maintenance task
2830 * should be interruptible. Hence, on receiving a broadcast with this
2831 * action, the maintenance task should be interrupted as soon as possible.
2832 * In other words, you should not do the maintenance work in
2833 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2834 * maintenance service that was started on receiving of
2835 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2836 * lock you acquired when your maintenance service started.
2837 * </p>
2838 * <p class="note">This is a protected intent that can only be sent
2839 * by the system.
2840 *
2841 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002842 *
2843 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002844 */
2845 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2846 public static final String ACTION_IDLE_MAINTENANCE_END =
2847 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2848
2849 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002850 * Broadcast Action: a remote intent is to be broadcasted.
2851 *
2852 * A remote intent is used for remote RPC between devices. The remote intent
2853 * is serialized and sent from one device to another device. The receiving
2854 * device parses the remote intent and broadcasts it. Note that anyone can
2855 * broadcast a remote intent. However, if the intent receiver of the remote intent
2856 * does not trust intent broadcasts from arbitrary intent senders, it should require
2857 * the sender to hold certain permissions so only trusted sender's broadcast will be
2858 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002859 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002860 */
2861 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002862 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002863
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002864 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002865 * Broadcast Action: This is broadcast once when the user is booting after a
2866 * system update. It can be used to perform cleanup or upgrades after a
2867 * system update.
2868 * <p>
2869 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2870 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2871 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2872 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002873 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002874 * @hide
2875 */
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08002876 @SystemApi
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002877 public static final String ACTION_PRE_BOOT_COMPLETED =
2878 "android.intent.action.PRE_BOOT_COMPLETED";
2879
Amith Yamasani13593602012-03-22 16:16:17 -07002880 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002881 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002882 * on restricted users. The broadcast intent contains an extra
2883 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2884 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2885 * String[] depending on the restriction type.<p/>
2886 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002887 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2888 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2889 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002890 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2891 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002892 * @see RestrictionEntry
2893 */
2894 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2895 "android.intent.action.GET_RESTRICTION_ENTRIES";
2896
2897 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002898 * Sent the first time a user is starting, to allow system apps to
2899 * perform one time initialization. (This will not be seen by third
2900 * party applications because a newly initialized user does not have any
2901 * third party applications installed for it.) This is sent early in
2902 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002903 * {@link #ACTION_BOOT_COMPLETED} is sent. 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 */
2907 public static final String ACTION_USER_INITIALIZE =
2908 "android.intent.action.USER_INITIALIZE";
2909
2910 /**
2911 * Sent when a user switch is happening, causing the process's user to be
2912 * brought to the foreground. This is only sent to receivers registered
2913 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2914 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002915 * foreground. This is sent as a foreground
2916 * broadcast, since it is part of a visible user interaction; be as quick
2917 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002918 */
2919 public static final String ACTION_USER_FOREGROUND =
2920 "android.intent.action.USER_FOREGROUND";
2921
2922 /**
2923 * Sent when a user switch is happening, causing the process's user to be
2924 * sent to the background. This is only sent to receivers registered
2925 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2926 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002927 * background. This is sent as a foreground
2928 * broadcast, since it is part of a visible user interaction; be as quick
2929 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002930 */
2931 public static final String ACTION_USER_BACKGROUND =
2932 "android.intent.action.USER_BACKGROUND";
2933
2934 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002935 * Broadcast sent to the system when a user is added. Carries an extra
2936 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2937 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002938 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002939 * @hide
2940 */
2941 public static final String ACTION_USER_ADDED =
2942 "android.intent.action.USER_ADDED";
2943
2944 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002945 * Broadcast sent by the system when a user is started. Carries an extra
2946 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002947 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002948 * that has been started. This is sent as a foreground
2949 * broadcast, since it is part of a visible user interaction; be as quick
2950 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002951 * @hide
2952 */
2953 public static final String ACTION_USER_STARTED =
2954 "android.intent.action.USER_STARTED";
2955
2956 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002957 * Broadcast sent when a user is in the process of starting. Carries an extra
2958 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2959 * sent to registered receivers, not manifest receivers. It is sent to all
2960 * users (including the one that is being started). You must hold
2961 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2962 * this broadcast. This is sent as a background broadcast, since
2963 * its result is not part of the primary UX flow; to safely keep track of
2964 * started/stopped state of a user you can use this in conjunction with
2965 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2966 * other user state broadcasts since those are foreground broadcasts so can
2967 * execute in a different order.
2968 * @hide
2969 */
2970 public static final String ACTION_USER_STARTING =
2971 "android.intent.action.USER_STARTING";
2972
2973 /**
2974 * Broadcast sent when a user is going to be stopped. Carries an extra
2975 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2976 * sent to registered receivers, not manifest receivers. It is sent to all
2977 * users (including the one that is being stopped). You must hold
2978 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2979 * this broadcast. The user will not stop until all receivers have
2980 * handled the broadcast. This is sent as a background broadcast, since
2981 * its result is not part of the primary UX flow; to safely keep track of
2982 * started/stopped state of a user you can use this in conjunction with
2983 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2984 * other user state broadcasts since those are foreground broadcasts so can
2985 * execute in a different order.
2986 * @hide
2987 */
2988 public static final String ACTION_USER_STOPPING =
2989 "android.intent.action.USER_STOPPING";
2990
2991 /**
2992 * Broadcast sent to the system when a user is stopped. Carries an extra
2993 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2994 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2995 * specific package. This is only sent to registered receivers, not manifest
2996 * receivers. It is sent to all running users <em>except</em> the one that
2997 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002998 * @hide
2999 */
3000 public static final String ACTION_USER_STOPPED =
3001 "android.intent.action.USER_STOPPED";
3002
3003 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003004 * 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 -07003005 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003006 * one that has been removed. The user will not be completely removed until all receivers have
3007 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003008 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003009 * @hide
3010 */
3011 public static final String ACTION_USER_REMOVED =
3012 "android.intent.action.USER_REMOVED";
3013
3014 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003015 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003016 * the userHandle of the user to become the current one. This is only sent to
3017 * registered receivers, not manifest receivers. It is sent to all running users.
3018 * You must hold
3019 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003020 * @hide
3021 */
3022 public static final String ACTION_USER_SWITCHED =
3023 "android.intent.action.USER_SWITCHED";
3024
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003025 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003026 * Broadcast Action: Sent when the credential-encrypted private storage has
3027 * become unlocked for the target user. This is only sent to registered
3028 * receivers, not manifest receivers.
3029 */
3030 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3031 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3032
3033 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003034 * Broadcast sent to the system when a user's information changes. Carries an extra
3035 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003036 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003037 * @hide
3038 */
3039 public static final String ACTION_USER_INFO_CHANGED =
3040 "android.intent.action.USER_INFO_CHANGED";
3041
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003042 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003043 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3044 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003045 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3046 * that need to display merged content across both primary and managed profiles need to
3047 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003048 * not manifest receivers.
3049 */
3050 public static final String ACTION_MANAGED_PROFILE_ADDED =
3051 "android.intent.action.MANAGED_PROFILE_ADDED";
3052
3053 /**
3054 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003055 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3056 * Only applications (for example Launchers) that need to display merged content across both
3057 * primary and managed profiles need to worry about this broadcast. This is only sent to
3058 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003059 */
3060 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3061 "android.intent.action.MANAGED_PROFILE_REMOVED";
3062
3063 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003064 * Broadcast sent to the primary user when the credential-encrypted private storage for
3065 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3066 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3067 * Launchers) that need to display merged content across both primary and managed profiles
3068 * need to worry about this broadcast. This is only sent to registered receivers,
3069 * not manifest receivers.
3070 */
3071 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3072 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3073
3074 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003075 * Broadcast sent to the primary user when an associated managed profile has become available.
3076 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003077 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3078 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3079 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003080 */
Rubin Xue95057a2016-04-01 16:49:25 +01003081 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3082 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3083
3084 /**
3085 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3086 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3087 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3088 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3089 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3090 */
3091 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3092 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003093
3094 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003095 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3096 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3097 * the device was locked or unlocked.
3098 *
3099 * This is only sent to registered receivers.
3100 *
3101 * @hide
3102 */
3103 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3104 "android.intent.action.DEVICE_LOCKED_CHANGED";
3105
3106 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003107 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3108 */
3109 public static final String ACTION_QUICK_CLOCK =
3110 "android.intent.action.QUICK_CLOCK";
3111
Michael Wright0087a142013-02-05 16:29:39 -08003112 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003113 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003114 * @hide
3115 */
3116 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3117 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3118
Justin Kohd378ad72013-04-01 12:18:26 -07003119 /**
3120 * Broadcast Action: A global button was pressed. Includes a single
3121 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3122 * caused the broadcast.
3123 * @hide
3124 */
3125 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3126
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003127 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003128 * Broadcast Action: Sent when media resource is granted.
3129 * <p>
3130 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3131 * granted.
3132 * </p>
3133 * <p class="note">
3134 * This is a protected intent that can only be sent by the system.
3135 * </p>
3136 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003137 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003138 * </p>
3139 *
3140 * @hide
3141 */
3142 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3143 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3144
3145 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003146 * Broadcast Action: An overlay package has been installed. The data
3147 * contains the name of the added overlay package.
3148 * @hide
3149 */
3150 public static final String ACTION_OVERLAY_ADDED = "android.intent.action.OVERLAY_ADDED";
3151
3152 /**
3153 * Broadcast Action: An overlay package has changed. The data contains the
3154 * name of the overlay package which has changed. This is broadcast on all
3155 * changes to the OverlayInfo returned by {@link
3156 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3157 * most common change is a state change that will change whether the
3158 * overlay is enabled or not.
3159 * @hide
3160 */
3161 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3162
3163 /**
3164 * Broadcast Action: An overlay package has been removed. The data contains
3165 * the name of the overlay package which has been removed.
3166 * @hide
3167 */
3168 public static final String ACTION_OVERLAY_REMOVED = "android.intent.action.OVERLAY_REMOVED";
3169
3170 /**
3171 * Broadcast Action: The order of a package's list of overlay packages has
3172 * changed. The data contains the package name of the overlay package that
3173 * had its position in the list adjusted.
3174 * @hide
3175 */
3176 public static final String
3177 ACTION_OVERLAY_PRIORITY_CHANGED = "android.intent.action.OVERLAY_PRIORITY_CHANGED";
3178
3179 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003180 * Activity Action: Allow the user to select and return one or more existing
3181 * documents. When invoked, the system will display the various
3182 * {@link DocumentsProvider} instances installed on the device, letting the
3183 * user interactively navigate through them. These documents include local
3184 * media, such as photos and video, and documents provided by installed
3185 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003186 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003187 * Each document is represented as a {@code content://} URI backed by a
3188 * {@link DocumentsProvider}, which can be opened as a stream with
3189 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3190 * {@link android.provider.DocumentsContract.Document} metadata.
3191 * <p>
3192 * All selected documents are returned to the calling application with
3193 * persistable read and write permission grants. If you want to maintain
3194 * access to the documents across device reboots, you need to explicitly
3195 * take the persistable permissions using
3196 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3197 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003198 * Callers must indicate the acceptable document MIME types through
3199 * {@link #setType(String)}. For example, to select photos, use
3200 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3201 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3202 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003203 * <p>
3204 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003205 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3206 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003207 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003208 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3209 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003210 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003211 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003212 * Callers can set a document URI through
3213 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3214 * location of documents navigator. System will do its best to launch the
3215 * navigator in the specified document if it's a folder, or the folder that
3216 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003217 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003218 * Output: The URI of the item that was picked, returned in
3219 * {@link #getData()}. This must be a {@code content://} URI so that any
3220 * receiver can access it. If multiple documents were selected, they are
3221 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003222 *
3223 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003224 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003225 * @see #ACTION_CREATE_DOCUMENT
3226 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003227 */
3228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3229 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3230
3231 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003232 * Activity Action: Allow the user to create a new document. When invoked,
3233 * the system will display the various {@link DocumentsProvider} instances
3234 * installed on the device, letting the user navigate through them. The
3235 * returned document may be a newly created document with no content, or it
3236 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003237 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003238 * Each document is represented as a {@code content://} URI backed by a
3239 * {@link DocumentsProvider}, which can be opened as a stream with
3240 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3241 * {@link android.provider.DocumentsContract.Document} metadata.
3242 * <p>
3243 * Callers must indicate the concrete MIME type of the document being
3244 * created by setting {@link #setType(String)}. This MIME type cannot be
3245 * changed after the document is created.
3246 * <p>
3247 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3248 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003249 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003250 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3251 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003252 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003253 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003254 * Callers can set a document URI through
3255 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3256 * location of documents navigator. System will do its best to launch the
3257 * navigator in the specified document if it's a folder, or the folder that
3258 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003259 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003260 * Output: The URI of the item that was created. This must be a
3261 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003262 *
3263 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003264 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003265 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003266 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003267 */
3268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3269 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3270
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003271 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003272 * Activity Action: Allow the user to pick a directory subtree. When
3273 * invoked, the system will display the various {@link DocumentsProvider}
3274 * instances installed on the device, letting the user navigate through
3275 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003276 * <p>
3277 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003278 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3279 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3280 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003281 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003282 * Callers can set a document URI through
3283 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3284 * location of documents navigator. System will do its best to launch the
3285 * navigator in the specified document if it's a folder, or the folder that
3286 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003287 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003288 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003289 *
3290 * @see DocumentsContract
3291 */
3292 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003293 public static final String
3294 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003295
Felipe Lemec7b1f892016-01-15 15:02:31 -08003296 /**
Peng Xua35b5532016-01-20 00:05:45 -08003297 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3298 * exisiting sensor being disconnected.
3299 *
3300 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3301 *
3302 * {@hide}
3303 */
3304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3305 public static final String
3306 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3307
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003308 /**
3309 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3310 *
3311 * {@hide}
3312 */
3313 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003314 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3315
Christopher Tate6597e342015-02-17 12:15:25 -08003316 /**
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003317 * Broadcast intent sent by the RecoverySystem to inform listeners that a master clear (wipe)
3318 * is about to be performed.
3319 * @hide
3320 */
3321 @SystemApi
3322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3323 public static final String ACTION_MASTER_CLEAR_NOTIFICATION
3324 = "android.intent.action.MASTER_CLEAR_NOTIFICATION";
3325
3326 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003327 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3328 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3329 *
3330 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3331 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003332 * @hide
3333 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003334 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003335 public static final String EXTRA_FORCE_MASTER_CLEAR =
3336 "android.intent.extra.FORCE_MASTER_CLEAR";
3337
3338 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003339 * A broadcast action to trigger a factory reset.
3340 *
3341 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3342 *
3343 * <p>Not for use by third-party applications.
3344 *
3345 * @see #EXTRA_FORCE_MASTER_CLEAR
3346 *
3347 * {@hide}
3348 */
3349 @SystemApi
3350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3351 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3352
3353 /**
3354 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3355 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3356 *
3357 * <p>Not for use by third-party applications.
3358 *
3359 * @hide
3360 */
3361 @SystemApi
3362 public static final String EXTRA_FORCE_FACTORY_RESET =
3363 "android.intent.extra.FORCE_FACTORY_RESET";
3364
3365 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003366 * Broadcast action: report that a settings element is being restored from backup. The intent
3367 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3368 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3369 * is the value of that settings entry prior to the restore operation. All of these values are
3370 * represented as strings.
3371 *
3372 * <p>This broadcast is sent only for settings provider entries known to require special handling
3373 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3374 * the provider's backup agent implementation.
3375 *
3376 * @see #EXTRA_SETTING_NAME
3377 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3378 * @see #EXTRA_SETTING_NEW_VALUE
3379 * {@hide}
3380 */
3381 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3382
3383 /** {@hide} */
3384 public static final String EXTRA_SETTING_NAME = "setting_name";
3385 /** {@hide} */
3386 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3387 /** {@hide} */
3388 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3389
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003390 /**
3391 * Activity Action: Process a piece of text.
3392 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3393 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3394 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3395 */
3396 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3397 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
Amith Yamasanicbabb8d2017-02-17 16:50:05 -08003398
3399 /**
3400 * Broadcast Action: The sim card state has changed.
3401 * For more details see TelephonyIntents.ACTION_SIM_STATE_CHANGED. This is here
3402 * because TelephonyIntents is an internal class.
3403 * @hide
3404 */
3405 @SystemApi
3406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3407 public static final String ACTION_SIM_STATE_CHANGED = "android.intent.action.SIM_STATE_CHANGED";
3408
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003409 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003410 * The name of the extra used to define the text to be processed, as a
3411 * CharSequence. Note that this may be a styled CharSequence, so you must use
3412 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003413 */
3414 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3415 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003416 * 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 +00003417 */
3418 public static final String EXTRA_PROCESS_TEXT_READONLY =
3419 "android.intent.extra.PROCESS_TEXT_READONLY";
3420
Bryce Leebc58f592015-09-25 16:43:01 -07003421 /**
3422 * Broadcast action: reports when a new thermal event has been reached. When the device
3423 * is reaching its maximum temperatue, the thermal level reported
3424 * {@hide}
3425 */
3426 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3427 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3428
3429 /** {@hide} */
3430 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3431
3432 /**
3433 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003434 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003435 * {@hide}
3436 */
3437 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3438
3439 /**
3440 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003441 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003442 * {@hide}
3443 */
3444 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3445
3446 /**
3447 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003448 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003449 * {@hide}
3450 */
3451 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3452
3453
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003454 // ---------------------------------------------------------------------
3455 // ---------------------------------------------------------------------
3456 // Standard intent categories (see addCategory()).
3457
3458 /**
3459 * Set if the activity should be an option for the default action
3460 * (center press) to perform on a piece of data. Setting this will
3461 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003462 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003463 * Intent when initiating an action -- it is for use in intent filters
3464 * specified in packages.
3465 */
3466 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3467 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3468 /**
3469 * Activities that can be safely invoked from a browser must support this
3470 * category. For example, if the user is viewing a web page or an e-mail
3471 * and clicks on a link in the text, the Intent generated execute that
3472 * link will require the BROWSABLE category, so that only activities
3473 * supporting this category will be considered as possible actions. By
3474 * supporting this category, you are promising that there is nothing
3475 * damaging (without user intervention) that can happen by invoking any
3476 * matching Intent.
3477 */
3478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3479 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3480 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003481 * Categories for activities that can participate in voice interaction.
3482 * An activity that supports this category must be prepared to run with
3483 * no UI shown at all (though in some case it may have a UI shown), and
3484 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3485 */
3486 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3487 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3488 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003489 * Set if the activity should be considered as an alternative action to
3490 * the data the user is currently viewing. See also
3491 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3492 * applies to the selection in a list of items.
3493 *
3494 * <p>Supporting this category means that you would like your activity to be
3495 * displayed in the set of alternative things the user can do, usually as
3496 * part of the current activity's options menu. You will usually want to
3497 * include a specific label in the &lt;intent-filter&gt; of this action
3498 * describing to the user what it does.
3499 *
3500 * <p>The action of IntentFilter with this category is important in that it
3501 * describes the specific action the target will perform. This generally
3502 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3503 * a specific name such as "com.android.camera.action.CROP. Only one
3504 * alternative of any particular action will be shown to the user, so using
3505 * a specific action like this makes sure that your alternative will be
3506 * displayed while also allowing other applications to provide their own
3507 * overrides of that particular action.
3508 */
3509 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3510 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3511 /**
3512 * Set if the activity should be considered as an alternative selection
3513 * action to the data the user has currently selected. This is like
3514 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3515 * of items from which the user can select, giving them alternatives to the
3516 * default action that will be performed on it.
3517 */
3518 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3519 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3520 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003521 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003522 */
3523 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3524 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3525 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003526 * Should be displayed in the top-level launcher.
3527 */
3528 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3529 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3530 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003531 * Indicates an activity optimized for Leanback mode, and that should
3532 * be displayed in the Leanback launcher.
3533 */
3534 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3535 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3536 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003537 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3538 * @hide
3539 */
3540 @SystemApi
3541 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3542 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003543 * Provides information about the package it is in; typically used if
3544 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3545 * a front-door to the user without having to be shown in the all apps list.
3546 */
3547 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3548 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3549 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003550 * This is the home activity, that is the first activity that is displayed
3551 * when the device boots.
3552 */
3553 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3554 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3555 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003556 * This is the home activity that is displayed when the device is finished setting up and ready
3557 * for use.
3558 * @hide
3559 */
3560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3561 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3562 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003563 * This is the setup wizard activity, that is the first activity that is displayed
3564 * when the user sets up the device for the first time.
3565 * @hide
3566 */
3567 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3568 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 * This activity is a preference panel.
3571 */
3572 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3573 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3574 /**
3575 * This activity is a development preference panel.
3576 */
3577 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3578 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3579 /**
3580 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003581 */
3582 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3583 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3584 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003585 * This activity allows the user to browse and download new applications.
3586 */
3587 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3588 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3589 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003590 * This activity may be exercised by the monkey or other automated test tools.
3591 */
3592 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3593 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3594 /**
3595 * To be used as a test (not part of the normal user experience).
3596 */
3597 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3598 /**
3599 * To be used as a unit test (run through the Test Harness).
3600 */
3601 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3602 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003603 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003604 * experience).
3605 */
3606 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003608 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003609 * Used to indicate that an intent only wants URIs that can be opened with
3610 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3611 * must support at least the columns defined in {@link OpenableColumns} when
3612 * queried.
3613 *
3614 * @see #ACTION_GET_CONTENT
3615 * @see #ACTION_OPEN_DOCUMENT
3616 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617 */
3618 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3619 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3620
3621 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003622 * Used to indicate that an intent filter can accept files which are not necessarily
3623 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3624 * at least streamable via
3625 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3626 * using one of the stream types exposed via
3627 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3628 *
3629 * @see #ACTION_SEND
3630 * @see #ACTION_SEND_MULTIPLE
3631 */
3632 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3633 public static final String CATEGORY_TYPED_OPENABLE =
3634 "android.intent.category.TYPED_OPENABLE";
3635
3636 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003637 * To be used as code under test for framework instrumentation tests.
3638 */
3639 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3640 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003641 /**
3642 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003643 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3644 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003645 */
3646 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3647 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3648 /**
3649 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003650 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3651 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003652 */
3653 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3654 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003655 /**
3656 * An activity to run when device is inserted into a analog (low end) dock.
3657 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3658 * information, see {@link android.app.UiModeManager}.
3659 */
3660 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3661 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3662
3663 /**
3664 * An activity to run when device is inserted into a digital (high end) dock.
3665 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3666 * information, see {@link android.app.UiModeManager}.
3667 */
3668 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3669 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003670
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003671 /**
3672 * Used to indicate that the activity can be used in a car environment.
3673 */
3674 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3675 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3676
Zak Cohendb6ca492017-01-26 14:09:00 -08003677 /**
3678 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
3679 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3680 * information, see {@link android.app.UiModeManager}.
3681 */
3682 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3683 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684 // ---------------------------------------------------------------------
3685 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003686 // Application launch intent categories (see addCategory()).
3687
3688 /**
3689 * Used with {@link #ACTION_MAIN} to launch the browser application.
3690 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003691 * <p>NOTE: This should not be used as the primary key of an Intent,
3692 * since it will not result in the app launching with the correct
3693 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003694 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003695 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003696 */
3697 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3698 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3699
3700 /**
3701 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3702 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003703 * <p>NOTE: This should not be used as the primary key of an Intent,
3704 * since it will not result in the app launching with the correct
3705 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003706 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003707 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003708 */
3709 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3710 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3711
3712 /**
3713 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3714 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003715 * <p>NOTE: This should not be used as the primary key of an Intent,
3716 * since it will not result in the app launching with the correct
3717 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003718 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003719 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003720 */
3721 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3722 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3723
3724 /**
3725 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3726 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003727 * <p>NOTE: This should not be used as the primary key of an Intent,
3728 * since it will not result in the app launching with the correct
3729 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003730 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003731 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003732 */
3733 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3734 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3735
3736 /**
3737 * Used with {@link #ACTION_MAIN} to launch the email application.
3738 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003739 * <p>NOTE: This should not be used as the primary key of an Intent,
3740 * since it will not result in the app launching with the correct
3741 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003742 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003743 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003744 */
3745 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3746 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3747
3748 /**
3749 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3750 * The activity should be able to view and manipulate image and video files
3751 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003752 * <p>NOTE: This should not be used as the primary key of an Intent,
3753 * since it will not result in the app launching with the correct
3754 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003755 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003756 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003757 */
3758 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3759 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3760
3761 /**
3762 * Used with {@link #ACTION_MAIN} to launch the maps application.
3763 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003764 * <p>NOTE: This should not be used as the primary key of an Intent,
3765 * since it will not result in the app launching with the correct
3766 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003767 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003768 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003769 */
3770 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3771 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3772
3773 /**
3774 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3775 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003776 * <p>NOTE: This should not be used as the primary key of an Intent,
3777 * since it will not result in the app launching with the correct
3778 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003779 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003780 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003781 */
3782 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3783 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3784
3785 /**
3786 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003787 * The activity should be able to play, browse, or manipulate music files
3788 * stored on the device.
3789 * <p>NOTE: This should not be used as the primary key of an Intent,
3790 * since it will not result in the app launching with the correct
3791 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003792 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003793 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003794 */
3795 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3796 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3797
3798 // ---------------------------------------------------------------------
3799 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003800 // Standard extra data keys.
3801
3802 /**
3803 * The initial data to place in a newly created record. Use with
3804 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3805 * fields as would be given to the underlying ContentProvider.insert()
3806 * call.
3807 */
3808 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3809
3810 /**
3811 * A constant CharSequence that is associated with the Intent, used with
3812 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3813 * this may be a styled CharSequence, so you must use
3814 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3815 * retrieve it.
3816 */
3817 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3818
3819 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003820 * A constant String that is associated with the Intent, used with
3821 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3822 * as HTML formatted text. Note that you <em>must</em> also supply
3823 * {@link #EXTRA_TEXT}.
3824 */
3825 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3826
3827 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003828 * A content: URI holding a stream of data associated with the Intent,
3829 * used with {@link #ACTION_SEND} to supply the data being sent.
3830 */
3831 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3832
3833 /**
3834 * A String[] holding e-mail addresses that should be delivered to.
3835 */
3836 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3837
3838 /**
3839 * A String[] holding e-mail addresses that should be carbon copied.
3840 */
3841 public static final String EXTRA_CC = "android.intent.extra.CC";
3842
3843 /**
3844 * A String[] holding e-mail addresses that should be blind carbon copied.
3845 */
3846 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3847
3848 /**
3849 * A constant string holding the desired subject line of a message.
3850 */
3851 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3852
3853 /**
3854 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003855 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003856 */
3857 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3858
3859 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003860 * An int representing the user id to be used.
3861 *
3862 * @hide
3863 */
3864 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3865
3866 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003867 * An int representing the task id to be retrieved. This is used when a launch from recents is
3868 * intercepted by another action such as credentials confirmation to remember which task should
3869 * be resumed when complete.
3870 *
3871 * @hide
3872 */
3873 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3874
3875 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003876 * An Intent[] describing additional, alternate choices you would like shown with
3877 * {@link #ACTION_CHOOSER}.
3878 *
3879 * <p>An app may be capable of providing several different payload types to complete a
3880 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3881 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3882 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3883 * photo data or a hosted link where the photos can be viewed.</p>
3884 *
3885 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3886 * first/primary/preferred intent in the set. Additional intents specified in
3887 * this extra are ordered; by default intents that appear earlier in the array will be
3888 * preferred over intents that appear later in the array as matches for the same
3889 * target component. To alter this preference, a calling app may also supply
3890 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3891 */
3892 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3893
3894 /**
Adam Powell52c39212016-04-07 15:14:18 -07003895 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3896 * and omitted from a list of components presented to the user.
3897 *
3898 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3899 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3900 * from your own package or other apps from your organization if the idea of sending to those
3901 * targets would be redundant with other app functionality. Filtered components will not
3902 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3903 */
3904 public static final String EXTRA_EXCLUDE_COMPONENTS
3905 = "android.intent.extra.EXCLUDE_COMPONENTS";
3906
3907 /**
3908 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3909 * describing additional high-priority deep-link targets for the chooser to present to the user.
3910 *
3911 * <p>Targets provided in this way will be presented inline with all other targets provided
3912 * by services from other apps. They will be prioritized before other service targets, but
3913 * after those targets provided by sources that the user has manually pinned to the front.</p>
3914 *
3915 * @see #ACTION_CHOOSER
3916 */
3917 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3918
3919 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003920 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3921 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3922 *
3923 * <p>An app preparing an action for another app to complete may wish to allow the user to
3924 * disambiguate between several options for completing the action based on the chosen target
3925 * or otherwise refine the action before it is invoked.
3926 * </p>
3927 *
3928 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3929 * <ul>
3930 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3931 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3932 * chosen target beyond the first</li>
3933 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3934 * should fill in and send once the disambiguation is complete</li>
3935 * </ul>
3936 */
3937 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3938 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3939
3940 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08003941 * An {@code ArrayList} of {@code String} annotations describing content for
3942 * {@link #ACTION_CHOOSER}.
3943 *
3944 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
3945 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
3946 *
3947 * <p>Annotations should describe the major components or topics of the content. It is up to
3948 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
3949 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
3950 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
3951 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
3952 * use the following annotations when applicable:</p>
3953 * <ul>
3954 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
3955 * health & beauty, and office supplies.</li>
3956 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
3957 * happy, and sad.</li>
3958 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
3959 * face, finger, standing, and walking.</li>
3960 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
3961 * child, and baby.</li>
3962 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
3963 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
3964 * <li>"party": represents that the topic of the content is mainly about parties.</li>
3965 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
3966 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
3967 * flowers.</li>
3968 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
3969 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
3970 * sunglasses, jewelry, handbags and clothing.</li>
3971 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
3972 * paper, and silk.</li>
3973 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
3974 * cars, and boats.</li>
3975 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
3976 * posters.</li>
3977 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
3978 * and designs of houses.</li>
3979 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
3980 * Christmas and Thanksgiving.</li>
3981 * </ul>
3982 */
3983 public static final String EXTRA_CONTENT_ANNOTATIONS
3984 = "android.intent.extra.CONTENT_ANNOTATIONS";
3985
3986 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003987 * A {@link ResultReceiver} used to return data back to the sender.
3988 *
3989 * <p>Used to complete an app-specific
3990 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3991 *
3992 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3993 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3994 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3995 * when the user selects a target component from the chooser. It is up to the recipient
3996 * to send a result to this ResultReceiver to signal that disambiguation is complete
3997 * and that the chooser should invoke the user's choice.</p>
3998 *
3999 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
4000 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
4001 * to match and fill in the final Intent or ChooserTarget before starting it.
4002 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
4003 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
4004 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
4005 *
4006 * <p>The result code passed to the ResultReceiver should be
4007 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
4008 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
4009 * the chooser should finish without starting a target.</p>
4010 */
4011 public static final String EXTRA_RESULT_RECEIVER
4012 = "android.intent.extra.RESULT_RECEIVER";
4013
4014 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004015 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00004016 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004017 */
4018 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
4019
4020 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07004021 * A Parcelable[] of {@link Intent} or
4022 * {@link android.content.pm.LabeledIntent} objects as set with
4023 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4024 * a the front of the list of choices, when shown to the user with a
4025 * {@link #ACTION_CHOOSER}.
4026 */
4027 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4028
4029 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004030 * A {@link IntentSender} to start after ephemeral installation success.
4031 * @hide
4032 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004033 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4034
4035 /**
4036 * A {@link IntentSender} to start after ephemeral installation failure.
4037 * @hide
4038 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004039 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4040
4041 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004042 * The host name that triggered an ephemeral resolution.
4043 * @hide
4044 */
4045 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4046
4047 /**
4048 * An opaque token to track ephemeral resolution.
4049 * @hide
4050 */
4051 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4052
4053 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004054 * The version code of the app to install components from.
4055 * @hide
4056 */
4057 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4058
4059 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004060 * A Bundle forming a mapping of potential target package names to different extras Bundles
4061 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4062 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4063 * be currently installed on the device.
4064 *
4065 * <p>An application may choose to provide alternate extras for the case where a user
4066 * selects an activity from a predetermined set of target packages. If the activity
4067 * the user selects from the chooser belongs to a package with its package name as
4068 * a key in this bundle, the corresponding extras for that package will be merged with
4069 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4070 * extra has the same key as an extra already present in the intent it will overwrite
4071 * the extra from the intent.</p>
4072 *
4073 * <p><em>Examples:</em>
4074 * <ul>
4075 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4076 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4077 * parameters for that target.</li>
4078 * <li>An application may offer additional metadata for known targets of a given intent
4079 * to pass along information only relevant to that target such as account or content
4080 * identifiers already known to that application.</li>
4081 * </ul></p>
4082 */
4083 public static final String EXTRA_REPLACEMENT_EXTRAS =
4084 "android.intent.extra.REPLACEMENT_EXTRAS";
4085
4086 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004087 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4088 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4089 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4090 * {@link ComponentName} of the chosen component.
4091 *
4092 * <p>In some situations this callback may never come, for example if the user abandons
4093 * the chooser, switches to another task or any number of other reasons. Apps should not
4094 * be written assuming that this callback will always occur.</p>
4095 */
4096 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4097 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4098
4099 /**
4100 * The {@link ComponentName} chosen by the user to complete an action.
4101 *
4102 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4103 */
4104 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4105
4106 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004107 * A {@link android.view.KeyEvent} object containing the event that
4108 * triggered the creation of the Intent it is in.
4109 */
4110 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4111
4112 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004113 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4114 * before shutting down.
4115 *
4116 * {@hide}
4117 */
4118 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4119
4120 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004121 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4122 * requested by the user.
4123 *
4124 * {@hide}
4125 */
4126 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4127 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4128
4129 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004130 * 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 -07004131 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4132 * of restarting the application.
4133 */
4134 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4135
4136 /**
4137 * A String holding the phone number originally entered in
4138 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4139 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4140 */
4141 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004142
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004143 /**
4144 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4145 * intents to supply the uid the package had been assigned. Also an optional
4146 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4147 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4148 * purpose.
4149 */
4150 public static final String EXTRA_UID = "android.intent.extra.UID";
4151
4152 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004153 * @hide String array of package names.
4154 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004155 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004156 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4157
4158 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004159 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4160 * intents to indicate whether this represents a full uninstall (removing
4161 * both the code and its data) or a partial uninstall (leaving its data,
4162 * implying that this is an update).
4163 */
4164 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004165
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004166 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004167 * @hide
4168 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4169 * intents to indicate that at this point the package has been removed for
4170 * all users on the device.
4171 */
4172 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4173 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4174
4175 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004176 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4177 * intents to indicate that this is a replacement of the package, so this
4178 * broadcast will immediately be followed by an add broadcast for a
4179 * different version of the same package.
4180 */
4181 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004182
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004183 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004184 * Used as an int extra field in {@link android.app.AlarmManager} intents
4185 * to tell the application being invoked how many pending alarms are being
4186 * delievered with the intent. For one-shot alarms this will always be 1.
4187 * For recurring alarms, this might be greater than 1 if the device was
4188 * asleep or powered off at the time an earlier alarm would have been
4189 * delivered.
4190 */
4191 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004192
Jacek Surazski86b6c532009-05-13 14:38:28 +02004193 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004194 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4195 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004196 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4197 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004198 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4199 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4200 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004201 */
4202 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4203
4204 /**
4205 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4206 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004207 */
4208 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4209
4210 /**
4211 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4212 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004213 */
4214 public static final int EXTRA_DOCK_STATE_DESK = 1;
4215
4216 /**
4217 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4218 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004219 */
4220 public static final int EXTRA_DOCK_STATE_CAR = 2;
4221
4222 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004223 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4224 * to represent that the phone is in a analog (low end) dock.
4225 */
4226 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4227
4228 /**
4229 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4230 * to represent that the phone is in a digital (high end) dock.
4231 */
4232 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4233
4234 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004235 * Boolean that can be supplied as meta-data with a dock activity, to
4236 * indicate that the dock should take over the home key when it is active.
4237 */
4238 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004239
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004240 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004241 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4242 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004243 */
4244 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4245
4246 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004247 * Used in the extra field in the remote intent. It's astring token passed with the
4248 * remote intent.
4249 */
4250 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4251 "android.intent.extra.remote_intent_token";
4252
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004253 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004254 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004255 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004256 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004257 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004258 "android.intent.extra.changed_component_name";
4259
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004260 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004261 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004262 * and contains a string array of all of the components that have changed. If
4263 * the state of the overall package has changed, then it will contain an entry
4264 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004265 */
4266 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4267 "android.intent.extra.changed_component_name_list";
4268
4269 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004270 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004271 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004272 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4273 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4274 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004275 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004276 */
4277 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4278 "android.intent.extra.changed_package_list";
4279
4280 /**
4281 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004282 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4283 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004284 * and contains an integer array of uids of all of the components
4285 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004286 */
4287 public static final String EXTRA_CHANGED_UID_LIST =
4288 "android.intent.extra.changed_uid_list";
4289
4290 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004291 * @hide
4292 * Magic extra system code can use when binding, to give a label for
4293 * who it is that has bound to a service. This is an integer giving
4294 * a framework string resource that can be displayed to the user.
4295 */
4296 public static final String EXTRA_CLIENT_LABEL =
4297 "android.intent.extra.client_label";
4298
4299 /**
4300 * @hide
4301 * Magic extra system code can use when binding, to give a PendingIntent object
4302 * that can be launched for the user to disable the system's use of this
4303 * service.
4304 */
4305 public static final String EXTRA_CLIENT_INTENT =
4306 "android.intent.extra.client_intent";
4307
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004308 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004309 * Extra used to indicate that an intent should only return data that is on
4310 * the local device. This is a boolean extra; the default is false. If true,
4311 * an implementation should only allow the user to select data that is
4312 * already on the device, not requiring it be downloaded from a remote
4313 * service when opened.
4314 *
4315 * @see #ACTION_GET_CONTENT
4316 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004317 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004318 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004319 */
4320 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004321 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004322
Amith Yamasani13593602012-03-22 16:16:17 -07004323 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004324 * Extra used to indicate that an intent can allow the user to select and
4325 * return multiple items. This is a boolean extra; the default is false. If
4326 * true, an implementation is allowed to present the user with a UI where
4327 * they can pick multiple items that are all returned to the caller. When
4328 * this happens, they should be returned as the {@link #getClipData()} part
4329 * of the result Intent.
4330 *
4331 * @see #ACTION_GET_CONTENT
4332 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004333 */
4334 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004335 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004336
4337 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004338 * The integer userHandle carried with broadcast intents related to addition, removal and
4339 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4340 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4341 *
Amith Yamasani13593602012-03-22 16:16:17 -07004342 * @hide
4343 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004344 public static final String EXTRA_USER_HANDLE =
4345 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004346
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004347 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004348 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4349 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4350 */
4351 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004352 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004353
4354 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004355 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004356 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4357 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004358 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004359 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4360
4361 /**
4362 * Extra sent in the intent to the BroadcastReceiver that handles
4363 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4364 * the restrictions as key/value pairs.
4365 */
4366 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4367 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004368
Amith Yamasani86118ba2013-03-28 14:33:16 -07004369 /**
4370 * Extra used in the response from a BroadcastReceiver that handles
4371 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4372 */
4373 public static final String EXTRA_RESTRICTIONS_INTENT =
4374 "android.intent.extra.restrictions_intent";
4375
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004376 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004377 * Extra used to communicate a set of acceptable MIME types. The type of the
4378 * extra is {@code String[]}. Values may be a combination of concrete MIME
4379 * types (such as "image/png") and/or partial MIME types (such as
4380 * "audio/*").
4381 *
4382 * @see #ACTION_GET_CONTENT
4383 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004384 */
4385 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4386
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004387 /**
4388 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4389 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004390 * When this is true, hardware devices can use this information to determine that
4391 * they shouldn't do a complete shutdown of their device since this is not a
4392 * complete shutdown down to the kernel, but only user space restarting.
4393 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004394 */
4395 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4396 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4397
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004398 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004399 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4400 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4401 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4402 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004403 *
4404 * @hide for internal use only.
4405 */
4406 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4407 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004408 /** @hide */
4409 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4410 /** @hide */
4411 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4412 /** @hide */
4413 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004414
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004415 /** {@hide} */
4416 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4417
Rubin Xue8490f12015-06-25 12:17:48 +01004418 /** {@hide} */
4419 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4420
Santos Cordon15a13782015-03-31 18:32:31 -07004421 /**
4422 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4423 * activation request.
4424 * TODO: Add information about the structure and response data used with the pending intent.
4425 * @hide
4426 */
4427 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4428 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4429
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004430 /**
4431 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004432 *
4433 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004434 * @see ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004435 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004436 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4437
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004438 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004439 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4440 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4441 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004442 *
4443 * <p>The value is boolean. By default false.
4444 * @see ACTION_QUICK_VIEW
4445 */
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004446 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4447 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004448
4449 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004450 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004451 * When a profile goes into quiet mode, all apps in the profile are killed and the
4452 * profile user is stopped. Widgets originating from the profile are masked, and app
4453 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004454 */
4455 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004456
4457 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004458 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004459 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004460 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4461 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004462 *
4463 * @hide
4464 */
4465 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4466 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4467
4468 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004469 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4470 * whether to show the chooser or not when there is only one application available
4471 * to choose from.
4472 *
4473 * @hide
4474 */
4475 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4476 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4477
4478 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004479 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004480 * to represent that a video codec is allowed to use.
4481 *
4482 * @hide
4483 */
4484 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4485
4486 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004487 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004488 * to represent that a audio codec is allowed to use.
4489 *
4490 * @hide
4491 */
4492 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4493
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004494 // ---------------------------------------------------------------------
4495 // ---------------------------------------------------------------------
4496 // Intent flags (see mFlags variable).
4497
Tor Norbyed9273d62013-05-30 15:59:53 -07004498 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004499 @IntDef(flag = true, value = {
4500 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4501 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004502 @Retention(RetentionPolicy.SOURCE)
4503 public @interface GrantUriMode {}
4504
Jeff Sharkey846318a2014-04-04 12:12:41 -07004505 /** @hide */
4506 @IntDef(flag = true, value = {
4507 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4508 @Retention(RetentionPolicy.SOURCE)
4509 public @interface AccessUriMode {}
4510
4511 /**
4512 * Test if given mode flags specify an access mode, which must be at least
4513 * read and/or write.
4514 *
4515 * @hide
4516 */
4517 public static boolean isAccessUriMode(int modeFlags) {
4518 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4519 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4520 }
4521
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004522 /**
4523 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004524 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004525 * specified in its ClipData. When applying to an Intent's ClipData,
4526 * all URIs as well as recursive traversals through data or other ClipData
4527 * in Intent items will be granted; only the grant flags of the top-level
4528 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004529 */
4530 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4531 /**
4532 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004533 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004534 * specified in its ClipData. When applying to an Intent's ClipData,
4535 * all URIs as well as recursive traversals through data or other ClipData
4536 * in Intent items will be granted; only the grant flags of the top-level
4537 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004538 */
4539 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4540 /**
4541 * Can be set by the caller to indicate that this Intent is coming from
4542 * a background operation, not from direct user interaction.
4543 */
4544 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4545 /**
4546 * A flag you can enable for debugging: when set, log messages will be
4547 * printed during the resolution of this intent to show you what has
4548 * been found to create the final resolved list.
4549 */
4550 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004551 /**
4552 * If set, this intent will not match any components in packages that
4553 * are currently stopped. If this is not set, then the default behavior
4554 * is to include such applications in the result.
4555 */
4556 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4557 /**
4558 * If set, this intent will always match any components in packages that
4559 * are currently stopped. This is the default behavior when
4560 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4561 * flags are set, this one wins (it allows overriding of exclude for
4562 * places where the framework may automatically set the exclude flag).
4563 */
4564 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004565
4566 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004567 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004568 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004569 * persisted across device reboots until explicitly revoked with
4570 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4571 * grant for possible persisting; the receiving application must call
4572 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4573 * actually persist.
4574 *
4575 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4576 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4577 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004578 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004579 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004580 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004581
4582 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004583 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4584 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4585 * applies to any URI that is a prefix match against the original granted
4586 * URI. (Without this flag, the URI must match exactly for access to be
4587 * granted.) Another URI is considered a prefix match only when scheme,
4588 * authority, and all path segments defined by the prefix are an exact
4589 * match.
4590 */
4591 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4592
4593 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004594 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004595 * homework and verified that they correctly handle packages and components
4596 * that come and go over time. In particular:
4597 * <ul>
4598 * <li>Apps installed on external storage, which will appear to be
4599 * uninstalled while the the device is ejected.
4600 * <li>Apps with encryption unaware components, which will appear to not
4601 * exist while the device is locked.
4602 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004603 *
4604 * @hide
4605 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004606 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004607
4608 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004609 * Internal flag used to indicate ephemeral applications should not be
4610 * considered when resolving the intent.
4611 *
4612 * @hide
4613 */
4614 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4615
4616 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004617 * If set, the new activity is not kept in the history stack. As soon as
4618 * the user navigates away from it, the activity is finished. This may also
4619 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4620 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004621 *
4622 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4623 * is never invoked when the current activity starts a new activity which
4624 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004625 */
4626 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4627 /**
4628 * If set, the activity will not be launched if it is already running
4629 * at the top of the history stack.
4630 */
4631 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4632 /**
4633 * If set, this activity will become the start of a new task on this
4634 * history stack. A task (from the activity that started it to the
4635 * next task activity) defines an atomic group of activities that the
4636 * user can move to. Tasks can be moved to the foreground and background;
4637 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004638 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004639 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4640 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004641 *
4642 * <p>This flag is generally used by activities that want
4643 * to present a "launcher" style behavior: they give the user a list of
4644 * separate things that can be done, which otherwise run completely
4645 * independently of the activity launching them.
4646 *
4647 * <p>When using this flag, if a task is already running for the activity
4648 * you are now starting, then a new activity will not be started; instead,
4649 * the current task will simply be brought to the front of the screen with
4650 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4651 * to disable this behavior.
4652 *
4653 * <p>This flag can not be used when the caller is requesting a result from
4654 * the activity being launched.
4655 */
4656 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4657 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004658 * This flag is used to create a new task and launch an activity into it.
4659 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4660 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4661 * search through existing tasks for ones matching this Intent. Only if no such
4662 * task is found would a new task be created. When paired with
4663 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4664 * the search for a matching task and unconditionally start a new task.
4665 *
4666 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4667 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004668 * top-level application launcher.</strong> Used in conjunction with
4669 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4670 * behavior of bringing an existing task to the foreground. When set,
4671 * a new task is <em>always</em> started to host the Activity for the
4672 * Intent, regardless of whether there is already an existing task running
4673 * the same thing.
4674 *
4675 * <p><strong>Because the default system does not include graphical task management,
4676 * you should not use this flag unless you provide some way for a user to
4677 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004678 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004679 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4680 * creating new document tasks.
4681 *
4682 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004683 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004684 *
Scott Main7aee61f2011-02-08 11:25:01 -08004685 * <p>See
4686 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4687 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004688 *
4689 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4690 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004691 */
4692 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4693 /**
4694 * If set, and the activity being launched is already running in the
4695 * current task, then instead of launching a new instance of that activity,
4696 * all of the other activities on top of it will be closed and this Intent
4697 * will be delivered to the (now on top) old activity as a new Intent.
4698 *
4699 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4700 * If D calls startActivity() with an Intent that resolves to the component
4701 * of activity B, then C and D will be finished and B receive the given
4702 * Intent, resulting in the stack now being: A, B.
4703 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004704 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004705 * either receive the new intent you are starting here in its
4706 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004707 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004708 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4709 * the same intent, then it will be finished and re-created; for all other
4710 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4711 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004712 *
4713 * <p>This launch mode can also be used to good effect in conjunction with
4714 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4715 * of a task, it will bring any currently running instance of that task
4716 * to the foreground, and then clear it to its root state. This is
4717 * especially useful, for example, when launching an activity from the
4718 * notification manager.
4719 *
Scott Main7aee61f2011-02-08 11:25:01 -08004720 * <p>See
4721 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4722 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004723 */
4724 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4725 /**
4726 * If set and this intent is being used to launch a new activity from an
4727 * existing one, then the reply target of the existing activity will be
4728 * transfered to the new activity. This way the new activity can call
4729 * {@link android.app.Activity#setResult} and have that result sent back to
4730 * the reply target of the original activity.
4731 */
4732 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4733 /**
4734 * If set and this intent is being used to launch a new activity from an
4735 * existing one, the current activity will not be counted as the top
4736 * activity for deciding whether the new intent should be delivered to
4737 * the top instead of starting a new one. The previous activity will
4738 * be used as the top, with the assumption being that the current activity
4739 * will finish itself immediately.
4740 */
4741 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4742 /**
4743 * If set, the new activity is not kept in the list of recently launched
4744 * activities.
4745 */
4746 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4747 /**
4748 * This flag is not normally set by application code, but set for you by
4749 * the system as described in the
4750 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4751 * launchMode} documentation for the singleTask mode.
4752 */
4753 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4754 /**
4755 * If set, and this activity is either being started in a new task or
4756 * bringing to the top an existing task, then it will be launched as
4757 * the front door of the task. This will result in the application of
4758 * any affinities needed to have that task in the proper state (either
4759 * moving activities to or from it), or simply resetting that task to
4760 * its initial state if needed.
4761 */
4762 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4763 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004764 * This flag is not normally set by application code, but set for you by
4765 * the system if this activity is being launched from history
4766 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004767 */
4768 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004769 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004770 * @deprecated As of API 21 this performs identically to
4771 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004772 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004773 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004774 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004775 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004776 * This flag is used to open a document into a new task rooted at the activity launched
4777 * by this Intent. Through the use of this flag, or its equivalent attribute,
4778 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004779 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004780 *
Craig Mautner026596b2014-05-21 15:35:44 -07004781 * <p>The use of the activity attribute form of this,
4782 * {@link android.R.attr#documentLaunchMode}, is
4783 * preferred over the Intent flag described here. The attribute form allows the
4784 * Activity to specify multiple document behavior for all launchers of the Activity
4785 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004786 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004787 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4788 * it is kept after the activity is finished is different than the use of
4789 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4790 * this flag is being used to create a new recents entry, then by default that entry
4791 * will be removed once the activity is finished. You can modify this behavior with
4792 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4793 *
Craig Mautner026596b2014-05-21 15:35:44 -07004794 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4795 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4796 * equivalent of the Activity manifest specifying {@link
4797 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4798 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4799 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004800 *
Craig Mautner026596b2014-05-21 15:35:44 -07004801 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004802 *
Craig Mautner026596b2014-05-21 15:35:44 -07004803 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004804 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4805 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004806 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004807 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004808 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004809 * callback from occurring on the current frontmost activity before it is
4810 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004811 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004812 * <p>Typically, an activity can rely on that callback to indicate that an
4813 * explicit user action has caused their activity to be moved out of the
4814 * foreground. The callback marks an appropriate point in the activity's
4815 * lifecycle for it to dismiss any notifications that it intends to display
4816 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004817 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004818 * <p>If an activity is ever started via any non-user-driven events such as
4819 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4820 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004821 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004822 */
4823 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004824 /**
4825 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4826 * this flag will cause the launched activity to be brought to the front of its
4827 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004828 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004829 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4830 * If D calls startActivity() with an Intent that resolves to the component
4831 * of activity B, then B will be brought to the front of the history stack,
4832 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004833 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004834 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004835 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004836 */
4837 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004838 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004839 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4840 * this flag will prevent the system from applying an activity transition
4841 * animation to go to the next activity state. This doesn't mean an
4842 * animation will never run -- if another activity change happens that doesn't
4843 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004844 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004845 * when you are going to do a series of activity operations but the
4846 * animation seen by the user shouldn't be driven by the first activity
4847 * change but rather a later one.
4848 */
4849 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4850 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004851 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4852 * this flag will cause any existing task that would be associated with the
4853 * activity to be cleared before the activity is started. That is, the activity
4854 * becomes the new root of an otherwise empty task, and any old activities
4855 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4856 */
4857 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4858 /**
4859 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4860 * this flag will cause a newly launching task to be placed on top of the current
4861 * home activity task (if there is one). That is, pressing back from the task
4862 * will always return the user to home even if that was not the last activity they
4863 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4864 */
4865 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4866 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004867 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4868 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004869 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004870 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004871 * this flag. When set and the task's activity is finished, the recents
4872 * entry will remain in the interface for the user to re-launch it, like a
4873 * recents entry for a top-level application.
4874 * <p>
4875 * The receiving activity can override this request with
4876 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4877 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004878 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004879 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004880 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004881
4882 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004883 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4884 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004885 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4886 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004887 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004888 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004889
4890 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004891 * If set, when sending a broadcast only registered receivers will be
4892 * called -- no BroadcastReceiver components will be launched.
4893 */
4894 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004895 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004896 * If set, when sending a broadcast the new broadcast will replace
4897 * any existing pending broadcast that matches it. Matching is defined
4898 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4899 * true for the intents of the two broadcasts. When a match is found,
4900 * the new broadcast (and receivers associated with it) will replace the
4901 * existing one in the pending broadcast list, remaining at the same
4902 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004903 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004904 * <p>This flag is most typically used with sticky broadcasts, which
4905 * only care about delivering the most recent values of the broadcast
4906 * to their receivers.
4907 */
4908 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4909 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004910 * If set, when sending a broadcast the recipient is allowed to run at
4911 * foreground priority, with a shorter timeout interval. During normal
4912 * broadcasts the receivers are not automatically hoisted out of the
4913 * background priority class.
4914 */
4915 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4916 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004917 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4918 * They can still propagate results through to later receivers, but they can not prevent
4919 * later receivers from seeing the broadcast.
4920 */
4921 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4922 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004923 * If set, when sending a broadcast <i>before boot has completed</i> only
4924 * registered receivers will be called -- no BroadcastReceiver components
4925 * will be launched. Sticky intent state will be recorded properly even
4926 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4927 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004928 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004929 * <p>This flag is only for use by system sevices as a convenience to
4930 * avoid having to implement a more complex mechanism around detection
4931 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004932 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004933 * @hide
4934 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004935 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004936 /**
4937 * Set when this broadcast is for a boot upgrade, a special mode that
4938 * allows the broadcast to be sent before the system is ready and launches
4939 * the app process with no providers running in it.
4940 * @hide
4941 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004942 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004943 /**
4944 * If set, the broadcast will always go to manifest receivers in background (cached
4945 * or not running) apps, regardless of whether that would be done by default. By
4946 * default they will only receive broadcasts if the broadcast has specified an
4947 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08004948 *
4949 * NOTE: dumpstate uses this flag numerically, so when its value is changed
4950 * the broadcast code there must also be changed to match.
4951 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004952 * @hide
4953 */
4954 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4955 /**
4956 * If set, the broadcast will never go to manifest receivers in background (cached
4957 * or not running) apps, regardless of whether that would be done by default. By
4958 * default they will receive broadcasts if the broadcast has specified an
4959 * explicit component or package name.
4960 * @hide
4961 */
4962 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07004963 /**
4964 * If set, this broadcast is being sent from the shell.
4965 * @hide
4966 */
4967 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004968
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004969 /**
4970 * @hide Flags that can't be changed with PendingIntent.
4971 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004972 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4973 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4974 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004976 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004977 // ---------------------------------------------------------------------
4978 // toUri() and parseUri() options.
4979
4980 /**
4981 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4982 * always has the "intent:" scheme. This syntax can be used when you want
4983 * to later disambiguate between URIs that are intended to describe an
4984 * Intent vs. all others that should be treated as raw URIs. When used
4985 * with {@link #parseUri}, any other scheme will result in a generic
4986 * VIEW action for that raw URI.
4987 */
4988 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004989
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004990 /**
4991 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4992 * always has the "android-app:" scheme. This is a variation of
4993 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4994 * http/https URI being delivered to a specific package name. The format
4995 * is:
4996 *
4997 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004998 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004999 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08005000 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
5001 * you must also include a scheme; including a path also requires both a host and a scheme.
5002 * The final #Intent; fragment can be used without a scheme, host, or path.
5003 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005004 * used with intents that have a {@link #setSelector}, since the base intent
5005 * will always have an explicit package name.</p>
5006 *
5007 * <p>Some examples of how this scheme maps to Intent objects:</p>
5008 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
5009 * <colgroup align="left" />
5010 * <colgroup align="left" />
5011 * <thead>
5012 * <tr><th>URI</th> <th>Intent</th></tr>
5013 * </thead>
5014 *
5015 * <tbody>
5016 * <tr><td><code>android-app://com.example.app</code></td>
5017 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5018 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
5019 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5020 * </table></td>
5021 * </tr>
5022 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5023 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5024 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5025 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5026 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5027 * </table></td>
5028 * </tr>
5029 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5030 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5031 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5032 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5033 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5034 * </table></td>
5035 * </tr>
5036 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5037 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5038 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5039 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5040 * </table></td>
5041 * </tr>
5042 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5043 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5044 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5045 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5046 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5047 * </table></td>
5048 * </tr>
5049 * <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>
5050 * <td><table border="" style="margin:0" >
5051 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5052 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5053 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5054 * </table></td>
5055 * </tr>
5056 * </tbody>
5057 * </table>
5058 */
5059 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5060
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005061 /**
5062 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5063 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5064 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5065 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5066 * generated Intent can not cause unexpected data access to happen.
5067 *
5068 * <p>If you do not trust the source of the URI being parsed, you should still do further
5069 * processing to protect yourself from it. In particular, when using it to start an
5070 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5071 * that can handle it.</p>
5072 */
5073 public static final int URI_ALLOW_UNSAFE = 1<<2;
5074
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005075 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005076
5077 private String mAction;
5078 private Uri mData;
5079 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005080 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 private ComponentName mComponent;
5082 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005083 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005084 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005085 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005086 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005087 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005088 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089
5090 // ---------------------------------------------------------------------
5091
5092 /**
5093 * Create an empty intent.
5094 */
5095 public Intent() {
5096 }
5097
5098 /**
5099 * Copy constructor.
5100 */
5101 public Intent(Intent o) {
5102 this.mAction = o.mAction;
5103 this.mData = o.mData;
5104 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005105 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 this.mComponent = o.mComponent;
5107 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005108 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005109 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005110 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005111 }
5112 if (o.mExtras != null) {
5113 this.mExtras = new Bundle(o.mExtras);
5114 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005115 if (o.mSourceBounds != null) {
5116 this.mSourceBounds = new Rect(o.mSourceBounds);
5117 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005118 if (o.mSelector != null) {
5119 this.mSelector = new Intent(o.mSelector);
5120 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005121 if (o.mClipData != null) {
5122 this.mClipData = new ClipData(o.mClipData);
5123 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005124 }
5125
5126 @Override
5127 public Object clone() {
5128 return new Intent(this);
5129 }
5130
5131 private Intent(Intent o, boolean all) {
5132 this.mAction = o.mAction;
5133 this.mData = o.mData;
5134 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005135 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005136 this.mComponent = o.mComponent;
5137 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005138 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005139 }
5140 }
5141
5142 /**
5143 * Make a clone of only the parts of the Intent that are relevant for
5144 * filter matching: the action, data, type, component, and categories.
5145 */
5146 public Intent cloneFilter() {
5147 return new Intent(this, false);
5148 }
5149
5150 /**
5151 * Create an intent with a given action. All other fields (data, type,
5152 * class) are null. Note that the action <em>must</em> be in a
5153 * namespace because Intents are used globally in the system -- for
5154 * example the system VIEW action is android.intent.action.VIEW; an
5155 * application's custom action would be something like
5156 * com.google.app.myapp.CUSTOM_ACTION.
5157 *
5158 * @param action The Intent action, such as ACTION_VIEW.
5159 */
5160 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005161 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005162 }
5163
5164 /**
5165 * Create an intent with a given action and for a given data url. Note
5166 * that the action <em>must</em> be in a namespace because Intents are
5167 * used globally in the system -- for example the system VIEW action is
5168 * android.intent.action.VIEW; an application's custom action would be
5169 * something like com.google.app.myapp.CUSTOM_ACTION.
5170 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005171 * <p><em>Note: scheme and host name matching in the Android framework is
5172 * case-sensitive, unlike the formal RFC. As a result,
5173 * you should always ensure that you write your Uri with these elements
5174 * using lower case letters, and normalize any Uris you receive from
5175 * outside of Android to ensure the scheme and host is lower case.</em></p>
5176 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005177 * @param action The Intent action, such as ACTION_VIEW.
5178 * @param uri The Intent data URI.
5179 */
5180 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005181 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005182 mData = uri;
5183 }
5184
5185 /**
5186 * Create an intent for a specific component. All other fields (action, data,
5187 * type, class) are null, though they can be modified later with explicit
5188 * calls. This provides a convenient way to create an intent that is
5189 * intended to execute a hard-coded class name, rather than relying on the
5190 * system to find an appropriate class for you; see {@link #setComponent}
5191 * for more information on the repercussions of this.
5192 *
5193 * @param packageContext A Context of the application package implementing
5194 * this class.
5195 * @param cls The component class that is to be used for the intent.
5196 *
5197 * @see #setClass
5198 * @see #setComponent
5199 * @see #Intent(String, android.net.Uri , Context, Class)
5200 */
5201 public Intent(Context packageContext, Class<?> cls) {
5202 mComponent = new ComponentName(packageContext, cls);
5203 }
5204
5205 /**
5206 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005207 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005208 * construct the Intent and then calling {@link #setClass} to set its
5209 * class.
5210 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005211 * <p><em>Note: scheme and host name matching in the Android framework is
5212 * case-sensitive, unlike the formal RFC. As a result,
5213 * you should always ensure that you write your Uri with these elements
5214 * using lower case letters, and normalize any Uris you receive from
5215 * outside of Android to ensure the scheme and host is lower case.</em></p>
5216 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005217 * @param action The Intent action, such as ACTION_VIEW.
5218 * @param uri The Intent data URI.
5219 * @param packageContext A Context of the application package implementing
5220 * this class.
5221 * @param cls The component class that is to be used for the intent.
5222 *
5223 * @see #Intent(String, android.net.Uri)
5224 * @see #Intent(Context, Class)
5225 * @see #setClass
5226 * @see #setComponent
5227 */
5228 public Intent(String action, Uri uri,
5229 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005230 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005231 mData = uri;
5232 mComponent = new ComponentName(packageContext, cls);
5233 }
5234
5235 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005236 * Create an intent to launch the main (root) activity of a task. This
5237 * is the Intent that is started when the application's is launched from
5238 * Home. For anything else that wants to launch an application in the
5239 * same way, it is important that they use an Intent structured the same
5240 * way, and can use this function to ensure this is the case.
5241 *
5242 * <p>The returned Intent has the given Activity component as its explicit
5243 * component, {@link #ACTION_MAIN} as its action, and includes the
5244 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5245 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5246 * to do that through {@link #addFlags(int)} on the returned Intent.
5247 *
5248 * @param mainActivity The main activity component that this Intent will
5249 * launch.
5250 * @return Returns a newly created Intent that can be used to launch the
5251 * activity as a main application entry.
5252 *
5253 * @see #setClass
5254 * @see #setComponent
5255 */
5256 public static Intent makeMainActivity(ComponentName mainActivity) {
5257 Intent intent = new Intent(ACTION_MAIN);
5258 intent.setComponent(mainActivity);
5259 intent.addCategory(CATEGORY_LAUNCHER);
5260 return intent;
5261 }
5262
5263 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005264 * Make an Intent for the main activity of an application, without
5265 * specifying a specific activity to run but giving a selector to find
5266 * the activity. This results in a final Intent that is structured
5267 * the same as when the application is launched from
5268 * Home. For anything else that wants to launch an application in the
5269 * same way, it is important that they use an Intent structured the same
5270 * way, and can use this function to ensure this is the case.
5271 *
5272 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5273 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5274 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5275 * to do that through {@link #addFlags(int)} on the returned Intent.
5276 *
5277 * @param selectorAction The action name of the Intent's selector.
5278 * @param selectorCategory The name of a category to add to the Intent's
5279 * selector.
5280 * @return Returns a newly created Intent that can be used to launch the
5281 * activity as a main application entry.
5282 *
5283 * @see #setSelector(Intent)
5284 */
5285 public static Intent makeMainSelectorActivity(String selectorAction,
5286 String selectorCategory) {
5287 Intent intent = new Intent(ACTION_MAIN);
5288 intent.addCategory(CATEGORY_LAUNCHER);
5289 Intent selector = new Intent();
5290 selector.setAction(selectorAction);
5291 selector.addCategory(selectorCategory);
5292 intent.setSelector(selector);
5293 return intent;
5294 }
5295
5296 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005297 * Make an Intent that can be used to re-launch an application's task
5298 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5299 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5300 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5301 *
5302 * @param mainActivity The activity component that is the root of the
5303 * task; this is the activity that has been published in the application's
5304 * manifest as the main launcher icon.
5305 *
5306 * @return Returns a newly created Intent that can be used to relaunch the
5307 * activity's task in its root state.
5308 */
5309 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5310 Intent intent = makeMainActivity(mainActivity);
5311 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5312 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5313 return intent;
5314 }
5315
5316 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005317 * Call {@link #parseUri} with 0 flags.
5318 * @deprecated Use {@link #parseUri} instead.
5319 */
5320 @Deprecated
5321 public static Intent getIntent(String uri) throws URISyntaxException {
5322 return parseUri(uri, 0);
5323 }
Tom Taylord4a47292009-12-21 13:59:18 -08005324
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005325 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005326 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005327 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005328 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005329 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005330 *
5331 * <p>The URI given here must not be relative -- that is, it must include
5332 * the scheme and full path.
5333 *
5334 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005335 * @param flags Additional processing flags. Either 0,
5336 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005337 *
5338 * @return Intent The newly created Intent object.
5339 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005340 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5341 * it bad (as parsed by the Uri class) or the Intent data within the
5342 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005343 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005344 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005345 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005346 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005347 int i = 0;
5348 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005349 final boolean androidApp = uri.startsWith("android-app:");
5350
5351 // Validate intent scheme if requested.
5352 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5353 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005354 Intent intent = new Intent(ACTION_VIEW);
5355 try {
5356 intent.setData(Uri.parse(uri));
5357 } catch (IllegalArgumentException e) {
5358 throw new URISyntaxException(uri, e.getMessage());
5359 }
5360 return intent;
5361 }
5362 }
Tom Taylord4a47292009-12-21 13:59:18 -08005363
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005364 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005365 // simple case
5366 if (i == -1) {
5367 if (!androidApp) {
5368 return new Intent(ACTION_VIEW, Uri.parse(uri));
5369 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005370
5371 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005372 } else if (!uri.startsWith("#Intent;", i)) {
5373 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005374 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005375 } else {
5376 i = -1;
5377 }
5378 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005379
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005380 // new format
5381 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005382 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005383 boolean explicitAction = false;
5384 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005385
5386 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005387 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005388 String data;
5389 if (i >= 0) {
5390 data = uri.substring(0, i);
5391 i += 8; // length of "#Intent;"
5392 } else {
5393 data = uri;
5394 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005395
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005396 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005397 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005398 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005399 if (eq < 0) eq = i-1;
5400 int semi = uri.indexOf(';', i);
5401 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005402
5403 // action
5404 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005405 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005406 if (!inSelector) {
5407 explicitAction = true;
5408 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005409 }
5410
5411 // categories
5412 else if (uri.startsWith("category=", i)) {
5413 intent.addCategory(value);
5414 }
5415
5416 // type
5417 else if (uri.startsWith("type=", i)) {
5418 intent.mType = value;
5419 }
5420
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005421 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005422 else if (uri.startsWith("launchFlags=", i)) {
5423 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005424 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5425 intent.mFlags &= ~IMMUTABLE_FLAGS;
5426 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005427 }
5428
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005429 // package
5430 else if (uri.startsWith("package=", i)) {
5431 intent.mPackage = value;
5432 }
5433
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005434 // component
5435 else if (uri.startsWith("component=", i)) {
5436 intent.mComponent = ComponentName.unflattenFromString(value);
5437 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005438
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005439 // scheme
5440 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005441 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005442 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005443 } else {
5444 scheme = value;
5445 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005446 }
5447
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005448 // source bounds
5449 else if (uri.startsWith("sourceBounds=", i)) {
5450 intent.mSourceBounds = Rect.unflattenFromString(value);
5451 }
5452
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005453 // selector
5454 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5455 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005456 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005457 }
5458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005459 // extra
5460 else {
5461 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005462 // create Bundle if it doesn't already exist
5463 if (intent.mExtras == null) intent.mExtras = new Bundle();
5464 Bundle b = intent.mExtras;
5465 // add EXTRA
5466 if (uri.startsWith("S.", i)) b.putString(key, value);
5467 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5468 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5469 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5470 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5471 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5472 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5473 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5474 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5475 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5476 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005477
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005478 // move to the next item
5479 i = semi + 1;
5480 }
5481
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005482 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005483 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005484 if (baseIntent.mPackage == null) {
5485 baseIntent.setSelector(intent);
5486 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005487 intent = baseIntent;
5488 }
5489
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005490 if (data != null) {
5491 if (data.startsWith("intent:")) {
5492 data = data.substring(7);
5493 if (scheme != null) {
5494 data = scheme + ':' + data;
5495 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005496 } else if (data.startsWith("android-app:")) {
5497 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5498 // Correctly formed android-app, first part is package name.
5499 int end = data.indexOf('/', 14);
5500 if (end < 0) {
5501 // All we have is a package name.
5502 intent.mPackage = data.substring(14);
5503 if (!explicitAction) {
5504 intent.setAction(ACTION_MAIN);
5505 }
5506 data = "";
5507 } else {
5508 // Target the Intent at the given package name always.
5509 String authority = null;
5510 intent.mPackage = data.substring(14, end);
5511 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005512 if ((end+1) < data.length()) {
5513 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5514 // Found a scheme, remember it.
5515 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005516 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005517 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5518 // Found a authority, remember it.
5519 authority = data.substring(end+1, newEnd);
5520 end = newEnd;
5521 }
5522 } else {
5523 // All we have is a scheme.
5524 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005525 }
5526 }
5527 if (scheme == null) {
5528 // If there was no scheme, then this just targets the package.
5529 if (!explicitAction) {
5530 intent.setAction(ACTION_MAIN);
5531 }
5532 data = "";
5533 } else if (authority == null) {
5534 data = scheme + ":";
5535 } else {
5536 data = scheme + "://" + authority + data.substring(end);
5537 }
5538 }
5539 } else {
5540 data = "";
5541 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005542 }
Tom Taylord4a47292009-12-21 13:59:18 -08005543
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005544 if (data.length() > 0) {
5545 try {
5546 intent.mData = Uri.parse(data);
5547 } catch (IllegalArgumentException e) {
5548 throw new URISyntaxException(uri, e.getMessage());
5549 }
5550 }
5551 }
Tom Taylord4a47292009-12-21 13:59:18 -08005552
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005553 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005554
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005555 } catch (IndexOutOfBoundsException e) {
5556 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5557 }
5558 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005559
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005560 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005561 return getIntentOld(uri, 0);
5562 }
5563
5564 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005565 Intent intent;
5566
5567 int i = uri.lastIndexOf('#');
5568 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005569 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005570 final int intentFragmentStart = i;
5571 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005572
5573 i++;
5574
5575 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005576 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005577 i += 7;
5578 int j = uri.indexOf(')', i);
5579 action = uri.substring(i, j);
5580 i = j + 1;
5581 }
5582
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005583 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005584
5585 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005586 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005587 i += 11;
5588 int j = uri.indexOf(')', i);
5589 while (i < j) {
5590 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005591 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005592 if (i < sep) {
5593 intent.addCategory(uri.substring(i, sep));
5594 }
5595 i = sep + 1;
5596 }
5597 i = j + 1;
5598 }
5599
5600 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005601 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005602 i += 5;
5603 int j = uri.indexOf(')', i);
5604 intent.mType = uri.substring(i, j);
5605 i = j + 1;
5606 }
5607
5608 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005609 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005610 i += 12;
5611 int j = uri.indexOf(')', i);
5612 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005613 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5614 intent.mFlags &= ~IMMUTABLE_FLAGS;
5615 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005616 i = j + 1;
5617 }
5618
5619 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005620 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005621 i += 10;
5622 int j = uri.indexOf(')', i);
5623 int sep = uri.indexOf('!', i);
5624 if (sep >= 0 && sep < j) {
5625 String pkg = uri.substring(i, sep);
5626 String cls = uri.substring(sep + 1, j);
5627 intent.mComponent = new ComponentName(pkg, cls);
5628 }
5629 i = j + 1;
5630 }
5631
5632 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005633 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005634 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005636 final int closeParen = uri.indexOf(')', i);
5637 if (closeParen == -1) throw new URISyntaxException(uri,
5638 "EXTRA missing trailing ')'", i);
5639
5640 while (i < closeParen) {
5641 // fetch the key value
5642 int j = uri.indexOf('=', i);
5643 if (j <= i + 1 || i >= closeParen) {
5644 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5645 }
5646 char type = uri.charAt(i);
5647 i++;
5648 String key = uri.substring(i, j);
5649 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005651 // get type-value
5652 j = uri.indexOf('!', i);
5653 if (j == -1 || j >= closeParen) j = closeParen;
5654 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5655 String value = uri.substring(i, j);
5656 i = j;
5657
5658 // create Bundle if it doesn't already exist
5659 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005661 // add item to bundle
5662 try {
5663 switch (type) {
5664 case 'S':
5665 intent.mExtras.putString(key, Uri.decode(value));
5666 break;
5667 case 'B':
5668 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5669 break;
5670 case 'b':
5671 intent.mExtras.putByte(key, Byte.parseByte(value));
5672 break;
5673 case 'c':
5674 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5675 break;
5676 case 'd':
5677 intent.mExtras.putDouble(key, Double.parseDouble(value));
5678 break;
5679 case 'f':
5680 intent.mExtras.putFloat(key, Float.parseFloat(value));
5681 break;
5682 case 'i':
5683 intent.mExtras.putInt(key, Integer.parseInt(value));
5684 break;
5685 case 'l':
5686 intent.mExtras.putLong(key, Long.parseLong(value));
5687 break;
5688 case 's':
5689 intent.mExtras.putShort(key, Short.parseShort(value));
5690 break;
5691 default:
5692 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5693 }
5694 } catch (NumberFormatException e) {
5695 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5696 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005697
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005698 char ch = uri.charAt(i);
5699 if (ch == ')') break;
5700 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5701 i++;
5702 }
5703 }
5704
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005705 if (isIntentFragment) {
5706 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5707 } else {
5708 intent.mData = Uri.parse(uri);
5709 }
Tom Taylord4a47292009-12-21 13:59:18 -08005710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005711 if (intent.mAction == null) {
5712 // By default, if no action is specified, then use VIEW.
5713 intent.mAction = ACTION_VIEW;
5714 }
5715
5716 } else {
5717 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5718 }
5719
5720 return intent;
5721 }
5722
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005723 /** @hide */
5724 public interface CommandOptionHandler {
5725 boolean handleOption(String opt, ShellCommand cmd);
5726 }
5727
5728 /** @hide */
5729 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5730 throws URISyntaxException {
5731 Intent intent = new Intent();
5732 Intent baseIntent = intent;
5733 boolean hasIntentInfo = false;
5734
5735 Uri data = null;
5736 String type = null;
5737
5738 String opt;
5739 while ((opt=cmd.getNextOption()) != null) {
5740 switch (opt) {
5741 case "-a":
5742 intent.setAction(cmd.getNextArgRequired());
5743 if (intent == baseIntent) {
5744 hasIntentInfo = true;
5745 }
5746 break;
5747 case "-d":
5748 data = Uri.parse(cmd.getNextArgRequired());
5749 if (intent == baseIntent) {
5750 hasIntentInfo = true;
5751 }
5752 break;
5753 case "-t":
5754 type = cmd.getNextArgRequired();
5755 if (intent == baseIntent) {
5756 hasIntentInfo = true;
5757 }
5758 break;
5759 case "-c":
5760 intent.addCategory(cmd.getNextArgRequired());
5761 if (intent == baseIntent) {
5762 hasIntentInfo = true;
5763 }
5764 break;
5765 case "-e":
5766 case "--es": {
5767 String key = cmd.getNextArgRequired();
5768 String value = cmd.getNextArgRequired();
5769 intent.putExtra(key, value);
5770 }
5771 break;
5772 case "--esn": {
5773 String key = cmd.getNextArgRequired();
5774 intent.putExtra(key, (String) null);
5775 }
5776 break;
5777 case "--ei": {
5778 String key = cmd.getNextArgRequired();
5779 String value = cmd.getNextArgRequired();
5780 intent.putExtra(key, Integer.decode(value));
5781 }
5782 break;
5783 case "--eu": {
5784 String key = cmd.getNextArgRequired();
5785 String value = cmd.getNextArgRequired();
5786 intent.putExtra(key, Uri.parse(value));
5787 }
5788 break;
5789 case "--ecn": {
5790 String key = cmd.getNextArgRequired();
5791 String value = cmd.getNextArgRequired();
5792 ComponentName cn = ComponentName.unflattenFromString(value);
5793 if (cn == null)
5794 throw new IllegalArgumentException("Bad component name: " + value);
5795 intent.putExtra(key, cn);
5796 }
5797 break;
5798 case "--eia": {
5799 String key = cmd.getNextArgRequired();
5800 String value = cmd.getNextArgRequired();
5801 String[] strings = value.split(",");
5802 int[] list = new int[strings.length];
5803 for (int i = 0; i < strings.length; i++) {
5804 list[i] = Integer.decode(strings[i]);
5805 }
5806 intent.putExtra(key, list);
5807 }
5808 break;
5809 case "--eial": {
5810 String key = cmd.getNextArgRequired();
5811 String value = cmd.getNextArgRequired();
5812 String[] strings = value.split(",");
5813 ArrayList<Integer> list = new ArrayList<>(strings.length);
5814 for (int i = 0; i < strings.length; i++) {
5815 list.add(Integer.decode(strings[i]));
5816 }
5817 intent.putExtra(key, list);
5818 }
5819 break;
5820 case "--el": {
5821 String key = cmd.getNextArgRequired();
5822 String value = cmd.getNextArgRequired();
5823 intent.putExtra(key, Long.valueOf(value));
5824 }
5825 break;
5826 case "--ela": {
5827 String key = cmd.getNextArgRequired();
5828 String value = cmd.getNextArgRequired();
5829 String[] strings = value.split(",");
5830 long[] list = new long[strings.length];
5831 for (int i = 0; i < strings.length; i++) {
5832 list[i] = Long.valueOf(strings[i]);
5833 }
5834 intent.putExtra(key, list);
5835 hasIntentInfo = true;
5836 }
5837 break;
5838 case "--elal": {
5839 String key = cmd.getNextArgRequired();
5840 String value = cmd.getNextArgRequired();
5841 String[] strings = value.split(",");
5842 ArrayList<Long> list = new ArrayList<>(strings.length);
5843 for (int i = 0; i < strings.length; i++) {
5844 list.add(Long.valueOf(strings[i]));
5845 }
5846 intent.putExtra(key, list);
5847 hasIntentInfo = true;
5848 }
5849 break;
5850 case "--ef": {
5851 String key = cmd.getNextArgRequired();
5852 String value = cmd.getNextArgRequired();
5853 intent.putExtra(key, Float.valueOf(value));
5854 hasIntentInfo = true;
5855 }
5856 break;
5857 case "--efa": {
5858 String key = cmd.getNextArgRequired();
5859 String value = cmd.getNextArgRequired();
5860 String[] strings = value.split(",");
5861 float[] list = new float[strings.length];
5862 for (int i = 0; i < strings.length; i++) {
5863 list[i] = Float.valueOf(strings[i]);
5864 }
5865 intent.putExtra(key, list);
5866 hasIntentInfo = true;
5867 }
5868 break;
5869 case "--efal": {
5870 String key = cmd.getNextArgRequired();
5871 String value = cmd.getNextArgRequired();
5872 String[] strings = value.split(",");
5873 ArrayList<Float> list = new ArrayList<>(strings.length);
5874 for (int i = 0; i < strings.length; i++) {
5875 list.add(Float.valueOf(strings[i]));
5876 }
5877 intent.putExtra(key, list);
5878 hasIntentInfo = true;
5879 }
5880 break;
5881 case "--esa": {
5882 String key = cmd.getNextArgRequired();
5883 String value = cmd.getNextArgRequired();
5884 // Split on commas unless they are preceeded by an escape.
5885 // The escape character must be escaped for the string and
5886 // again for the regex, thus four escape characters become one.
5887 String[] strings = value.split("(?<!\\\\),");
5888 intent.putExtra(key, strings);
5889 hasIntentInfo = true;
5890 }
5891 break;
5892 case "--esal": {
5893 String key = cmd.getNextArgRequired();
5894 String value = cmd.getNextArgRequired();
5895 // Split on commas unless they are preceeded by an escape.
5896 // The escape character must be escaped for the string and
5897 // again for the regex, thus four escape characters become one.
5898 String[] strings = value.split("(?<!\\\\),");
5899 ArrayList<String> list = new ArrayList<>(strings.length);
5900 for (int i = 0; i < strings.length; i++) {
5901 list.add(strings[i]);
5902 }
5903 intent.putExtra(key, list);
5904 hasIntentInfo = true;
5905 }
5906 break;
5907 case "--ez": {
5908 String key = cmd.getNextArgRequired();
5909 String value = cmd.getNextArgRequired().toLowerCase();
5910 // Boolean.valueOf() results in false for anything that is not "true", which is
5911 // error-prone in shell commands
5912 boolean arg;
5913 if ("true".equals(value) || "t".equals(value)) {
5914 arg = true;
5915 } else if ("false".equals(value) || "f".equals(value)) {
5916 arg = false;
5917 } else {
5918 try {
5919 arg = Integer.decode(value) != 0;
5920 } catch (NumberFormatException ex) {
5921 throw new IllegalArgumentException("Invalid boolean value: " + value);
5922 }
5923 }
5924
5925 intent.putExtra(key, arg);
5926 }
5927 break;
5928 case "-n": {
5929 String str = cmd.getNextArgRequired();
5930 ComponentName cn = ComponentName.unflattenFromString(str);
5931 if (cn == null)
5932 throw new IllegalArgumentException("Bad component name: " + str);
5933 intent.setComponent(cn);
5934 if (intent == baseIntent) {
5935 hasIntentInfo = true;
5936 }
5937 }
5938 break;
5939 case "-p": {
5940 String str = cmd.getNextArgRequired();
5941 intent.setPackage(str);
5942 if (intent == baseIntent) {
5943 hasIntentInfo = true;
5944 }
5945 }
5946 break;
5947 case "-f":
5948 String str = cmd.getNextArgRequired();
5949 intent.setFlags(Integer.decode(str).intValue());
5950 break;
5951 case "--grant-read-uri-permission":
5952 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5953 break;
5954 case "--grant-write-uri-permission":
5955 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5956 break;
5957 case "--grant-persistable-uri-permission":
5958 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5959 break;
5960 case "--grant-prefix-uri-permission":
5961 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5962 break;
5963 case "--exclude-stopped-packages":
5964 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5965 break;
5966 case "--include-stopped-packages":
5967 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5968 break;
5969 case "--debug-log-resolution":
5970 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5971 break;
5972 case "--activity-brought-to-front":
5973 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5974 break;
5975 case "--activity-clear-top":
5976 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5977 break;
5978 case "--activity-clear-when-task-reset":
5979 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5980 break;
5981 case "--activity-exclude-from-recents":
5982 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5983 break;
5984 case "--activity-launched-from-history":
5985 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5986 break;
5987 case "--activity-multiple-task":
5988 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5989 break;
5990 case "--activity-no-animation":
5991 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5992 break;
5993 case "--activity-no-history":
5994 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5995 break;
5996 case "--activity-no-user-action":
5997 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5998 break;
5999 case "--activity-previous-is-top":
6000 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
6001 break;
6002 case "--activity-reorder-to-front":
6003 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
6004 break;
6005 case "--activity-reset-task-if-needed":
6006 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
6007 break;
6008 case "--activity-single-top":
6009 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
6010 break;
6011 case "--activity-clear-task":
6012 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
6013 break;
6014 case "--activity-task-on-home":
6015 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
6016 break;
6017 case "--receiver-registered-only":
6018 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
6019 break;
6020 case "--receiver-replace-pending":
6021 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6022 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006023 case "--receiver-foreground":
6024 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6025 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006026 case "--receiver-no-abort":
6027 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6028 break;
6029 case "--receiver-include-background":
6030 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6031 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006032 case "--selector":
6033 intent.setDataAndType(data, type);
6034 intent = new Intent();
6035 break;
6036 default:
6037 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6038 // Okay, caller handled this option.
6039 } else {
6040 throw new IllegalArgumentException("Unknown option: " + opt);
6041 }
6042 break;
6043 }
6044 }
6045 intent.setDataAndType(data, type);
6046
6047 final boolean hasSelector = intent != baseIntent;
6048 if (hasSelector) {
6049 // A selector was specified; fix up.
6050 baseIntent.setSelector(intent);
6051 intent = baseIntent;
6052 }
6053
6054 String arg = cmd.getNextArg();
6055 baseIntent = null;
6056 if (arg == null) {
6057 if (hasSelector) {
6058 // If a selector has been specified, and no arguments
6059 // have been supplied for the main Intent, then we can
6060 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6061 // need to have a component name specified yet, the
6062 // selector will take care of that.
6063 baseIntent = new Intent(Intent.ACTION_MAIN);
6064 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6065 }
6066 } else if (arg.indexOf(':') >= 0) {
6067 // The argument is a URI. Fully parse it, and use that result
6068 // to fill in any data not specified so far.
6069 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6070 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6071 } else if (arg.indexOf('/') >= 0) {
6072 // The argument is a component name. Build an Intent to launch
6073 // it.
6074 baseIntent = new Intent(Intent.ACTION_MAIN);
6075 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6076 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6077 } else {
6078 // Assume the argument is a package name.
6079 baseIntent = new Intent(Intent.ACTION_MAIN);
6080 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6081 baseIntent.setPackage(arg);
6082 }
6083 if (baseIntent != null) {
6084 Bundle extras = intent.getExtras();
6085 intent.replaceExtras((Bundle)null);
6086 Bundle uriExtras = baseIntent.getExtras();
6087 baseIntent.replaceExtras((Bundle)null);
6088 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6089 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6090 for (String c : cats) {
6091 baseIntent.removeCategory(c);
6092 }
6093 }
6094 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6095 if (extras == null) {
6096 extras = uriExtras;
6097 } else if (uriExtras != null) {
6098 uriExtras.putAll(extras);
6099 extras = uriExtras;
6100 }
6101 intent.replaceExtras(extras);
6102 hasIntentInfo = true;
6103 }
6104
6105 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6106 return intent;
6107 }
6108
6109 /** @hide */
6110 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6111 final String[] lines = new String[] {
6112 "<INTENT> specifications include these flags and arguments:",
6113 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6114 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6115 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6116 " [--esn <EXTRA_KEY> ...]",
6117 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6118 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6119 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6120 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6121 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6122 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6123 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6124 " (mutiple extras passed as Integer[])",
6125 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6126 " (mutiple extras passed as List<Integer>)",
6127 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6128 " (mutiple extras passed as Long[])",
6129 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6130 " (mutiple extras passed as List<Long>)",
6131 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6132 " (mutiple extras passed as Float[])",
6133 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6134 " (mutiple extras passed as List<Float>)",
6135 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6136 " (mutiple extras passed as String[]; to embed a comma into a string,",
6137 " escape it using \"\\,\")",
6138 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6139 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6140 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006141 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006142 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6143 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6144 " [--debug-log-resolution] [--exclude-stopped-packages]",
6145 " [--include-stopped-packages]",
6146 " [--activity-brought-to-front] [--activity-clear-top]",
6147 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6148 " [--activity-launched-from-history] [--activity-multiple-task]",
6149 " [--activity-no-animation] [--activity-no-history]",
6150 " [--activity-no-user-action] [--activity-previous-is-top]",
6151 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6152 " [--activity-single-top] [--activity-clear-task]",
6153 " [--activity-task-on-home]",
6154 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006155 " [--receiver-foreground] [--receiver-no-abort]",
6156 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006157 " [--selector]",
6158 " [<URI> | <PACKAGE> | <COMPONENT>]"
6159 };
6160 for (String line : lines) {
6161 pw.print(prefix);
6162 pw.println(line);
6163 }
6164 }
6165
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006166 /**
6167 * Retrieve the general action to be performed, such as
6168 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6169 * the information in the intent should be interpreted -- most importantly,
6170 * what to do with the data returned by {@link #getData}.
6171 *
6172 * @return The action of this intent or null if none is specified.
6173 *
6174 * @see #setAction
6175 */
6176 public String getAction() {
6177 return mAction;
6178 }
6179
6180 /**
6181 * Retrieve data this intent is operating on. This URI specifies the name
6182 * of the data; often it uses the content: scheme, specifying data in a
6183 * content provider. Other schemes may be handled by specific activities,
6184 * such as http: by the web browser.
6185 *
6186 * @return The URI of the data this intent is targeting or null.
6187 *
6188 * @see #getScheme
6189 * @see #setData
6190 */
6191 public Uri getData() {
6192 return mData;
6193 }
6194
6195 /**
6196 * The same as {@link #getData()}, but returns the URI as an encoded
6197 * String.
6198 */
6199 public String getDataString() {
6200 return mData != null ? mData.toString() : null;
6201 }
6202
6203 /**
6204 * Return the scheme portion of the intent's data. If the data is null or
6205 * does not include a scheme, null is returned. Otherwise, the scheme
6206 * prefix without the final ':' is returned, i.e. "http".
6207 *
6208 * <p>This is the same as calling getData().getScheme() (and checking for
6209 * null data).
6210 *
6211 * @return The scheme of this intent.
6212 *
6213 * @see #getData
6214 */
6215 public String getScheme() {
6216 return mData != null ? mData.getScheme() : null;
6217 }
6218
6219 /**
6220 * Retrieve any explicit MIME type included in the intent. This is usually
6221 * null, as the type is determined by the intent data.
6222 *
6223 * @return If a type was manually set, it is returned; else null is
6224 * returned.
6225 *
6226 * @see #resolveType(ContentResolver)
6227 * @see #setType
6228 */
6229 public String getType() {
6230 return mType;
6231 }
6232
6233 /**
6234 * Return the MIME data type of this intent. If the type field is
6235 * explicitly set, that is simply returned. Otherwise, if the data is set,
6236 * the type of that data is returned. If neither fields are set, a null is
6237 * returned.
6238 *
6239 * @return The MIME type of this intent.
6240 *
6241 * @see #getType
6242 * @see #resolveType(ContentResolver)
6243 */
6244 public String resolveType(Context context) {
6245 return resolveType(context.getContentResolver());
6246 }
6247
6248 /**
6249 * Return the MIME data type of this intent. If the type field is
6250 * explicitly set, that is simply returned. Otherwise, if the data is set,
6251 * the type of that data is returned. If neither fields are set, a null is
6252 * returned.
6253 *
6254 * @param resolver A ContentResolver that can be used to determine the MIME
6255 * type of the intent's data.
6256 *
6257 * @return The MIME type of this intent.
6258 *
6259 * @see #getType
6260 * @see #resolveType(Context)
6261 */
6262 public String resolveType(ContentResolver resolver) {
6263 if (mType != null) {
6264 return mType;
6265 }
6266 if (mData != null) {
6267 if ("content".equals(mData.getScheme())) {
6268 return resolver.getType(mData);
6269 }
6270 }
6271 return null;
6272 }
6273
6274 /**
6275 * Return the MIME data type of this intent, only if it will be needed for
6276 * intent resolution. This is not generally useful for application code;
6277 * it is used by the frameworks for communicating with back-end system
6278 * services.
6279 *
6280 * @param resolver A ContentResolver that can be used to determine the MIME
6281 * type of the intent's data.
6282 *
6283 * @return The MIME type of this intent, or null if it is unknown or not
6284 * needed.
6285 */
6286 public String resolveTypeIfNeeded(ContentResolver resolver) {
6287 if (mComponent != null) {
6288 return mType;
6289 }
6290 return resolveType(resolver);
6291 }
6292
6293 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006294 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006295 *
6296 * @param category The category to check.
6297 *
6298 * @return boolean True if the intent contains the category, else false.
6299 *
6300 * @see #getCategories
6301 * @see #addCategory
6302 */
6303 public boolean hasCategory(String category) {
6304 return mCategories != null && mCategories.contains(category);
6305 }
6306
6307 /**
6308 * Return the set of all categories in the intent. If there are no categories,
6309 * returns NULL.
6310 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006311 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006312 *
6313 * @see #hasCategory
6314 * @see #addCategory
6315 */
6316 public Set<String> getCategories() {
6317 return mCategories;
6318 }
6319
6320 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006321 * Return the specific selector associated with this Intent. If there is
6322 * none, returns null. See {@link #setSelector} for more information.
6323 *
6324 * @see #setSelector
6325 */
6326 public Intent getSelector() {
6327 return mSelector;
6328 }
6329
6330 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006331 * Return the {@link ClipData} associated with this Intent. If there is
6332 * none, returns null. See {@link #setClipData} for more information.
6333 *
John Spurlock125d1332013-11-25 11:58:37 -05006334 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006335 */
6336 public ClipData getClipData() {
6337 return mClipData;
6338 }
6339
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006340 /** @hide */
6341 public int getContentUserHint() {
6342 return mContentUserHint;
6343 }
6344
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006345 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006346 * Sets the ClassLoader that will be used when unmarshalling
6347 * any Parcelable values from the extras of this Intent.
6348 *
6349 * @param loader a ClassLoader, or null to use the default loader
6350 * at the time of unmarshalling.
6351 */
6352 public void setExtrasClassLoader(ClassLoader loader) {
6353 if (mExtras != null) {
6354 mExtras.setClassLoader(loader);
6355 }
6356 }
6357
6358 /**
6359 * Returns true if an extra value is associated with the given name.
6360 * @param name the extra's name
6361 * @return true if the given extra is present.
6362 */
6363 public boolean hasExtra(String name) {
6364 return mExtras != null && mExtras.containsKey(name);
6365 }
6366
6367 /**
6368 * Returns true if the Intent's extras contain a parcelled file descriptor.
6369 * @return true if the Intent contains a parcelled file descriptor.
6370 */
6371 public boolean hasFileDescriptors() {
6372 return mExtras != null && mExtras.hasFileDescriptors();
6373 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006374
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006375 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006376 public void setAllowFds(boolean allowFds) {
6377 if (mExtras != null) {
6378 mExtras.setAllowFds(allowFds);
6379 }
6380 }
6381
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006382 /** {@hide} */
6383 public void setDefusable(boolean defusable) {
6384 if (mExtras != null) {
6385 mExtras.setDefusable(defusable);
6386 }
6387 }
6388
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006389 /**
6390 * Retrieve extended data from the intent.
6391 *
6392 * @param name The name of the desired item.
6393 *
6394 * @return the value of an item that previously added with putExtra()
6395 * or null if none was found.
6396 *
6397 * @deprecated
6398 * @hide
6399 */
6400 @Deprecated
6401 public Object getExtra(String name) {
6402 return getExtra(name, null);
6403 }
6404
6405 /**
6406 * Retrieve extended data from the intent.
6407 *
6408 * @param name The name of the desired item.
6409 * @param defaultValue the value to be returned if no value of the desired
6410 * type is stored with the given name.
6411 *
6412 * @return the value of an item that previously added with putExtra()
6413 * or the default value if none was found.
6414 *
6415 * @see #putExtra(String, boolean)
6416 */
6417 public boolean getBooleanExtra(String name, boolean defaultValue) {
6418 return mExtras == null ? defaultValue :
6419 mExtras.getBoolean(name, defaultValue);
6420 }
6421
6422 /**
6423 * Retrieve extended data from the intent.
6424 *
6425 * @param name The name of the desired item.
6426 * @param defaultValue the value to be returned if no value of the desired
6427 * type is stored with the given name.
6428 *
6429 * @return the value of an item that previously added with putExtra()
6430 * or the default value if none was found.
6431 *
6432 * @see #putExtra(String, byte)
6433 */
6434 public byte getByteExtra(String name, byte defaultValue) {
6435 return mExtras == null ? defaultValue :
6436 mExtras.getByte(name, defaultValue);
6437 }
6438
6439 /**
6440 * Retrieve extended data from the intent.
6441 *
6442 * @param name The name of the desired item.
6443 * @param defaultValue the value to be returned if no value of the desired
6444 * type is stored with the given name.
6445 *
6446 * @return the value of an item that previously added with putExtra()
6447 * or the default value if none was found.
6448 *
6449 * @see #putExtra(String, short)
6450 */
6451 public short getShortExtra(String name, short defaultValue) {
6452 return mExtras == null ? defaultValue :
6453 mExtras.getShort(name, defaultValue);
6454 }
6455
6456 /**
6457 * Retrieve extended data from the intent.
6458 *
6459 * @param name The name of the desired item.
6460 * @param defaultValue the value to be returned if no value of the desired
6461 * type is stored with the given name.
6462 *
6463 * @return the value of an item that previously added with putExtra()
6464 * or the default value if none was found.
6465 *
6466 * @see #putExtra(String, char)
6467 */
6468 public char getCharExtra(String name, char defaultValue) {
6469 return mExtras == null ? defaultValue :
6470 mExtras.getChar(name, defaultValue);
6471 }
6472
6473 /**
6474 * Retrieve extended data from the intent.
6475 *
6476 * @param name The name of the desired item.
6477 * @param defaultValue the value to be returned if no value of the desired
6478 * type is stored with the given name.
6479 *
6480 * @return the value of an item that previously added with putExtra()
6481 * or the default value if none was found.
6482 *
6483 * @see #putExtra(String, int)
6484 */
6485 public int getIntExtra(String name, int defaultValue) {
6486 return mExtras == null ? defaultValue :
6487 mExtras.getInt(name, defaultValue);
6488 }
6489
6490 /**
6491 * Retrieve extended data from the intent.
6492 *
6493 * @param name The name of the desired item.
6494 * @param defaultValue the value to be returned if no value of the desired
6495 * type is stored with the given name.
6496 *
6497 * @return the value of an item that previously added with putExtra()
6498 * or the default value if none was found.
6499 *
6500 * @see #putExtra(String, long)
6501 */
6502 public long getLongExtra(String name, long defaultValue) {
6503 return mExtras == null ? defaultValue :
6504 mExtras.getLong(name, defaultValue);
6505 }
6506
6507 /**
6508 * Retrieve extended data from the intent.
6509 *
6510 * @param name The name of the desired item.
6511 * @param defaultValue the value to be returned if no value of the desired
6512 * type is stored with the given name.
6513 *
6514 * @return the value of an item that previously added with putExtra(),
6515 * or the default value if no such item is present
6516 *
6517 * @see #putExtra(String, float)
6518 */
6519 public float getFloatExtra(String name, float defaultValue) {
6520 return mExtras == null ? defaultValue :
6521 mExtras.getFloat(name, defaultValue);
6522 }
6523
6524 /**
6525 * Retrieve extended data from the intent.
6526 *
6527 * @param name The name of the desired item.
6528 * @param defaultValue the value to be returned if no value of the desired
6529 * type is stored with the given name.
6530 *
6531 * @return the value of an item that previously added with putExtra()
6532 * or the default value if none was found.
6533 *
6534 * @see #putExtra(String, double)
6535 */
6536 public double getDoubleExtra(String name, double defaultValue) {
6537 return mExtras == null ? defaultValue :
6538 mExtras.getDouble(name, defaultValue);
6539 }
6540
6541 /**
6542 * Retrieve extended data from the intent.
6543 *
6544 * @param name The name of the desired item.
6545 *
6546 * @return the value of an item that previously added with putExtra()
6547 * or null if no String value was found.
6548 *
6549 * @see #putExtra(String, String)
6550 */
6551 public String getStringExtra(String name) {
6552 return mExtras == null ? null : mExtras.getString(name);
6553 }
6554
6555 /**
6556 * Retrieve extended data from the intent.
6557 *
6558 * @param name The name of the desired item.
6559 *
6560 * @return the value of an item that previously added with putExtra()
6561 * or null if no CharSequence value was found.
6562 *
6563 * @see #putExtra(String, CharSequence)
6564 */
6565 public CharSequence getCharSequenceExtra(String name) {
6566 return mExtras == null ? null : mExtras.getCharSequence(name);
6567 }
6568
6569 /**
6570 * Retrieve extended data from the intent.
6571 *
6572 * @param name The name of the desired item.
6573 *
6574 * @return the value of an item that previously added with putExtra()
6575 * or null if no Parcelable value was found.
6576 *
6577 * @see #putExtra(String, Parcelable)
6578 */
6579 public <T extends Parcelable> T getParcelableExtra(String name) {
6580 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6581 }
6582
6583 /**
6584 * Retrieve extended data from the intent.
6585 *
6586 * @param name The name of the desired item.
6587 *
6588 * @return the value of an item that previously added with putExtra()
6589 * or null if no Parcelable[] value was found.
6590 *
6591 * @see #putExtra(String, Parcelable[])
6592 */
6593 public Parcelable[] getParcelableArrayExtra(String name) {
6594 return mExtras == null ? null : mExtras.getParcelableArray(name);
6595 }
6596
6597 /**
6598 * Retrieve extended data from the intent.
6599 *
6600 * @param name The name of the desired item.
6601 *
6602 * @return the value of an item that previously added with putExtra()
6603 * or null if no ArrayList<Parcelable> value was found.
6604 *
6605 * @see #putParcelableArrayListExtra(String, ArrayList)
6606 */
6607 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6608 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6609 }
6610
6611 /**
6612 * Retrieve extended data from the intent.
6613 *
6614 * @param name The name of the desired item.
6615 *
6616 * @return the value of an item that previously added with putExtra()
6617 * or null if no Serializable value was found.
6618 *
6619 * @see #putExtra(String, Serializable)
6620 */
6621 public Serializable getSerializableExtra(String name) {
6622 return mExtras == null ? null : mExtras.getSerializable(name);
6623 }
6624
6625 /**
6626 * Retrieve extended data from the intent.
6627 *
6628 * @param name The name of the desired item.
6629 *
6630 * @return the value of an item that previously added with putExtra()
6631 * or null if no ArrayList<Integer> value was found.
6632 *
6633 * @see #putIntegerArrayListExtra(String, ArrayList)
6634 */
6635 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6636 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6637 }
6638
6639 /**
6640 * Retrieve extended data from the intent.
6641 *
6642 * @param name The name of the desired item.
6643 *
6644 * @return the value of an item that previously added with putExtra()
6645 * or null if no ArrayList<String> value was found.
6646 *
6647 * @see #putStringArrayListExtra(String, ArrayList)
6648 */
6649 public ArrayList<String> getStringArrayListExtra(String name) {
6650 return mExtras == null ? null : mExtras.getStringArrayList(name);
6651 }
6652
6653 /**
6654 * Retrieve extended data from the intent.
6655 *
6656 * @param name The name of the desired item.
6657 *
6658 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006659 * or null if no ArrayList<CharSequence> value was found.
6660 *
6661 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6662 */
6663 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6664 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6665 }
6666
6667 /**
6668 * Retrieve extended data from the intent.
6669 *
6670 * @param name The name of the desired item.
6671 *
6672 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006673 * or null if no boolean array value was found.
6674 *
6675 * @see #putExtra(String, boolean[])
6676 */
6677 public boolean[] getBooleanArrayExtra(String name) {
6678 return mExtras == null ? null : mExtras.getBooleanArray(name);
6679 }
6680
6681 /**
6682 * Retrieve extended data from the intent.
6683 *
6684 * @param name The name of the desired item.
6685 *
6686 * @return the value of an item that previously added with putExtra()
6687 * or null if no byte array value was found.
6688 *
6689 * @see #putExtra(String, byte[])
6690 */
6691 public byte[] getByteArrayExtra(String name) {
6692 return mExtras == null ? null : mExtras.getByteArray(name);
6693 }
6694
6695 /**
6696 * Retrieve extended data from the intent.
6697 *
6698 * @param name The name of the desired item.
6699 *
6700 * @return the value of an item that previously added with putExtra()
6701 * or null if no short array value was found.
6702 *
6703 * @see #putExtra(String, short[])
6704 */
6705 public short[] getShortArrayExtra(String name) {
6706 return mExtras == null ? null : mExtras.getShortArray(name);
6707 }
6708
6709 /**
6710 * Retrieve extended data from the intent.
6711 *
6712 * @param name The name of the desired item.
6713 *
6714 * @return the value of an item that previously added with putExtra()
6715 * or null if no char array value was found.
6716 *
6717 * @see #putExtra(String, char[])
6718 */
6719 public char[] getCharArrayExtra(String name) {
6720 return mExtras == null ? null : mExtras.getCharArray(name);
6721 }
6722
6723 /**
6724 * Retrieve extended data from the intent.
6725 *
6726 * @param name The name of the desired item.
6727 *
6728 * @return the value of an item that previously added with putExtra()
6729 * or null if no int array value was found.
6730 *
6731 * @see #putExtra(String, int[])
6732 */
6733 public int[] getIntArrayExtra(String name) {
6734 return mExtras == null ? null : mExtras.getIntArray(name);
6735 }
6736
6737 /**
6738 * Retrieve extended data from the intent.
6739 *
6740 * @param name The name of the desired item.
6741 *
6742 * @return the value of an item that previously added with putExtra()
6743 * or null if no long array value was found.
6744 *
6745 * @see #putExtra(String, long[])
6746 */
6747 public long[] getLongArrayExtra(String name) {
6748 return mExtras == null ? null : mExtras.getLongArray(name);
6749 }
6750
6751 /**
6752 * Retrieve extended data from the intent.
6753 *
6754 * @param name The name of the desired item.
6755 *
6756 * @return the value of an item that previously added with putExtra()
6757 * or null if no float array value was found.
6758 *
6759 * @see #putExtra(String, float[])
6760 */
6761 public float[] getFloatArrayExtra(String name) {
6762 return mExtras == null ? null : mExtras.getFloatArray(name);
6763 }
6764
6765 /**
6766 * Retrieve extended data from the intent.
6767 *
6768 * @param name The name of the desired item.
6769 *
6770 * @return the value of an item that previously added with putExtra()
6771 * or null if no double array value was found.
6772 *
6773 * @see #putExtra(String, double[])
6774 */
6775 public double[] getDoubleArrayExtra(String name) {
6776 return mExtras == null ? null : mExtras.getDoubleArray(name);
6777 }
6778
6779 /**
6780 * Retrieve extended data from the intent.
6781 *
6782 * @param name The name of the desired item.
6783 *
6784 * @return the value of an item that previously added with putExtra()
6785 * or null if no String array value was found.
6786 *
6787 * @see #putExtra(String, String[])
6788 */
6789 public String[] getStringArrayExtra(String name) {
6790 return mExtras == null ? null : mExtras.getStringArray(name);
6791 }
6792
6793 /**
6794 * Retrieve extended data from the intent.
6795 *
6796 * @param name The name of the desired item.
6797 *
6798 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006799 * or null if no CharSequence array value was found.
6800 *
6801 * @see #putExtra(String, CharSequence[])
6802 */
6803 public CharSequence[] getCharSequenceArrayExtra(String name) {
6804 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6805 }
6806
6807 /**
6808 * Retrieve extended data from the intent.
6809 *
6810 * @param name The name of the desired item.
6811 *
6812 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006813 * or null if no Bundle value was found.
6814 *
6815 * @see #putExtra(String, Bundle)
6816 */
6817 public Bundle getBundleExtra(String name) {
6818 return mExtras == null ? null : mExtras.getBundle(name);
6819 }
6820
6821 /**
6822 * Retrieve extended data from the intent.
6823 *
6824 * @param name The name of the desired item.
6825 *
6826 * @return the value of an item that previously added with putExtra()
6827 * or null if no IBinder value was found.
6828 *
6829 * @see #putExtra(String, IBinder)
6830 *
6831 * @deprecated
6832 * @hide
6833 */
6834 @Deprecated
6835 public IBinder getIBinderExtra(String name) {
6836 return mExtras == null ? null : mExtras.getIBinder(name);
6837 }
6838
6839 /**
6840 * Retrieve extended data from the intent.
6841 *
6842 * @param name The name of the desired item.
6843 * @param defaultValue The default value to return in case no item is
6844 * associated with the key 'name'
6845 *
6846 * @return the value of an item that previously added with putExtra()
6847 * or defaultValue if none was found.
6848 *
6849 * @see #putExtra
6850 *
6851 * @deprecated
6852 * @hide
6853 */
6854 @Deprecated
6855 public Object getExtra(String name, Object defaultValue) {
6856 Object result = defaultValue;
6857 if (mExtras != null) {
6858 Object result2 = mExtras.get(name);
6859 if (result2 != null) {
6860 result = result2;
6861 }
6862 }
6863
6864 return result;
6865 }
6866
6867 /**
6868 * Retrieves a map of extended data from the intent.
6869 *
6870 * @return the map of all extras previously added with putExtra(),
6871 * or null if none have been added.
6872 */
6873 public Bundle getExtras() {
6874 return (mExtras != null)
6875 ? new Bundle(mExtras)
6876 : null;
6877 }
6878
6879 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006880 * Filter extras to only basic types.
6881 * @hide
6882 */
6883 public void removeUnsafeExtras() {
6884 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006885 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006886 }
6887 }
6888
6889 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006890 * Retrieve any special flags associated with this intent. You will
6891 * normally just set them with {@link #setFlags} and let the system
6892 * take the appropriate action with them.
6893 *
6894 * @return int The currently set flags.
6895 *
6896 * @see #setFlags
6897 */
6898 public int getFlags() {
6899 return mFlags;
6900 }
6901
Dianne Hackborne7f97212011-02-24 14:40:20 -08006902 /** @hide */
6903 public boolean isExcludingStopped() {
6904 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6905 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6906 }
6907
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006908 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006909 * Retrieve the application package name this Intent is limited to. When
6910 * resolving an Intent, if non-null this limits the resolution to only
6911 * components in the given application package.
6912 *
6913 * @return The name of the application package for the Intent.
6914 *
6915 * @see #resolveActivity
6916 * @see #setPackage
6917 */
6918 public String getPackage() {
6919 return mPackage;
6920 }
6921
6922 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006923 * Retrieve the concrete component associated with the intent. When receiving
6924 * an intent, this is the component that was found to best handle it (that is,
6925 * yourself) and will always be non-null; in all other cases it will be
6926 * null unless explicitly set.
6927 *
6928 * @return The name of the application component to handle the intent.
6929 *
6930 * @see #resolveActivity
6931 * @see #setComponent
6932 */
6933 public ComponentName getComponent() {
6934 return mComponent;
6935 }
6936
6937 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006938 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6939 * used as a hint to the receiver for animations and the like. Null means that there
6940 * is no source bounds.
6941 */
6942 public Rect getSourceBounds() {
6943 return mSourceBounds;
6944 }
6945
6946 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006947 * Return the Activity component that should be used to handle this intent.
6948 * The appropriate component is determined based on the information in the
6949 * intent, evaluated as follows:
6950 *
6951 * <p>If {@link #getComponent} returns an explicit class, that is returned
6952 * without any further consideration.
6953 *
6954 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6955 * category to be considered.
6956 *
6957 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6958 * action.
6959 *
6960 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6961 * this type.
6962 *
6963 * <p>If {@link #addCategory} has added any categories, the activity must
6964 * handle ALL of the categories specified.
6965 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006966 * <p>If {@link #getPackage} is non-NULL, only activity components in
6967 * that application package will be considered.
6968 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006969 * <p>If there are no activities that satisfy all of these conditions, a
6970 * null string is returned.
6971 *
6972 * <p>If multiple activities are found to satisfy the intent, the one with
6973 * the highest priority will be used. If there are multiple activities
6974 * with the same priority, the system will either pick the best activity
6975 * based on user preference, or resolve to a system class that will allow
6976 * the user to pick an activity and forward from there.
6977 *
6978 * <p>This method is implemented simply by calling
6979 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6980 * true.</p>
6981 * <p> This API is called for you as part of starting an activity from an
6982 * intent. You do not normally need to call it yourself.</p>
6983 *
6984 * @param pm The package manager with which to resolve the Intent.
6985 *
6986 * @return Name of the component implementing an activity that can
6987 * display the intent.
6988 *
6989 * @see #setComponent
6990 * @see #getComponent
6991 * @see #resolveActivityInfo
6992 */
6993 public ComponentName resolveActivity(PackageManager pm) {
6994 if (mComponent != null) {
6995 return mComponent;
6996 }
6997
6998 ResolveInfo info = pm.resolveActivity(
6999 this, PackageManager.MATCH_DEFAULT_ONLY);
7000 if (info != null) {
7001 return new ComponentName(
7002 info.activityInfo.applicationInfo.packageName,
7003 info.activityInfo.name);
7004 }
7005
7006 return null;
7007 }
7008
7009 /**
7010 * Resolve the Intent into an {@link ActivityInfo}
7011 * describing the activity that should execute the intent. Resolution
7012 * follows the same rules as described for {@link #resolveActivity}, but
7013 * you get back the completely information about the resolved activity
7014 * instead of just its class name.
7015 *
7016 * @param pm The package manager with which to resolve the Intent.
7017 * @param flags Addition information to retrieve as per
7018 * {@link PackageManager#getActivityInfo(ComponentName, int)
7019 * PackageManager.getActivityInfo()}.
7020 *
7021 * @return PackageManager.ActivityInfo
7022 *
7023 * @see #resolveActivity
7024 */
7025 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
7026 ActivityInfo ai = null;
7027 if (mComponent != null) {
7028 try {
7029 ai = pm.getActivityInfo(mComponent, flags);
7030 } catch (PackageManager.NameNotFoundException e) {
7031 // ignore
7032 }
7033 } else {
7034 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007035 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007036 if (info != null) {
7037 ai = info.activityInfo;
7038 }
7039 }
7040
7041 return ai;
7042 }
7043
7044 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007045 * Special function for use by the system to resolve service
7046 * intents to system apps. Throws an exception if there are
7047 * multiple potential matches to the Intent. Returns null if
7048 * there are no matches.
7049 * @hide
7050 */
7051 public ComponentName resolveSystemService(PackageManager pm, int flags) {
7052 if (mComponent != null) {
7053 return mComponent;
7054 }
7055
7056 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7057 if (results == null) {
7058 return null;
7059 }
7060 ComponentName comp = null;
7061 for (int i=0; i<results.size(); i++) {
7062 ResolveInfo ri = results.get(i);
7063 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7064 continue;
7065 }
7066 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7067 ri.serviceInfo.name);
7068 if (comp != null) {
7069 throw new IllegalStateException("Multiple system services handle " + this
7070 + ": " + comp + ", " + foundComp);
7071 }
7072 comp = foundComp;
7073 }
7074 return comp;
7075 }
7076
7077 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007078 * Set the general action to be performed.
7079 *
7080 * @param action An action name, such as ACTION_VIEW. Application-specific
7081 * actions should be prefixed with the vendor's package name.
7082 *
7083 * @return Returns the same Intent object, for chaining multiple calls
7084 * into a single statement.
7085 *
7086 * @see #getAction
7087 */
7088 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007089 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007090 return this;
7091 }
7092
7093 /**
7094 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007095 * clears any type that was previously set by {@link #setType} or
7096 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007097 *
Nick Pellyccae4122012-01-09 14:12:58 -08007098 * <p><em>Note: scheme matching in the Android framework is
7099 * case-sensitive, unlike the formal RFC. As a result,
7100 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007101 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007102 * {@link #setDataAndNormalize}
7103 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007104 *
Nick Pellyccae4122012-01-09 14:12:58 -08007105 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007106 *
7107 * @return Returns the same Intent object, for chaining multiple calls
7108 * into a single statement.
7109 *
7110 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007111 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007112 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007113 */
7114 public Intent setData(Uri data) {
7115 mData = data;
7116 mType = null;
7117 return this;
7118 }
7119
7120 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007121 * Normalize and set the data this intent is operating on.
7122 *
7123 * <p>This method automatically clears any type that was
7124 * previously set (for example, by {@link #setType}).
7125 *
7126 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007127 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007128 * so really this is just a convenience method for
7129 * <pre>
7130 * setData(data.normalize())
7131 * </pre>
7132 *
7133 * @param data The Uri of the data this intent is now targeting.
7134 *
7135 * @return Returns the same Intent object, for chaining multiple calls
7136 * into a single statement.
7137 *
7138 * @see #getData
7139 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007140 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007141 */
7142 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007143 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007144 }
7145
7146 /**
7147 * Set an explicit MIME data type.
7148 *
7149 * <p>This is used to create intents that only specify a type and not data,
7150 * for example to indicate the type of data to return.
7151 *
7152 * <p>This method automatically clears any data that was
7153 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007154 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007155 * <p><em>Note: MIME type matching in the Android framework is
7156 * case-sensitive, unlike formal RFC MIME types. As a result,
7157 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007158 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7159 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007160 *
7161 * @param type The MIME type of the data being handled by this intent.
7162 *
7163 * @return Returns the same Intent object, for chaining multiple calls
7164 * into a single statement.
7165 *
7166 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007167 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007168 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007169 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007170 */
7171 public Intent setType(String type) {
7172 mData = null;
7173 mType = type;
7174 return this;
7175 }
7176
7177 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007178 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007179 *
Nick Pellyccae4122012-01-09 14:12:58 -08007180 * <p>This is used to create intents that only specify a type and not data,
7181 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007182 *
Nick Pellyccae4122012-01-09 14:12:58 -08007183 * <p>This method automatically clears any data that was
7184 * previously set (for example by {@link #setData}).
7185 *
7186 * <p>The MIME type is normalized using
7187 * {@link #normalizeMimeType} before it is set,
7188 * so really this is just a convenience method for
7189 * <pre>
7190 * setType(Intent.normalizeMimeType(type))
7191 * </pre>
7192 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007193 * @param type The MIME type of the data being handled by this intent.
7194 *
7195 * @return Returns the same Intent object, for chaining multiple calls
7196 * into a single statement.
7197 *
Nick Pellyccae4122012-01-09 14:12:58 -08007198 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007199 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007200 * @see #normalizeMimeType
7201 */
7202 public Intent setTypeAndNormalize(String type) {
7203 return setType(normalizeMimeType(type));
7204 }
7205
7206 /**
7207 * (Usually optional) Set the data for the intent along with an explicit
7208 * MIME data type. This method should very rarely be used -- it allows you
7209 * to override the MIME type that would ordinarily be inferred from the
7210 * data with your own type given here.
7211 *
7212 * <p><em>Note: MIME type and Uri scheme matching in the
7213 * Android framework is case-sensitive, unlike the formal RFC definitions.
7214 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007215 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007216 * {@link #setDataAndTypeAndNormalize}
7217 * to ensure that they are converted to lower case.</em>
7218 *
7219 * @param data The Uri of the data this intent is now targeting.
7220 * @param type The MIME type of the data being handled by this intent.
7221 *
7222 * @return Returns the same Intent object, for chaining multiple calls
7223 * into a single statement.
7224 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007225 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007226 * @see #setData
7227 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007228 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007229 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007230 */
7231 public Intent setDataAndType(Uri data, String type) {
7232 mData = data;
7233 mType = type;
7234 return this;
7235 }
7236
7237 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007238 * (Usually optional) Normalize and set both the data Uri and an explicit
7239 * MIME data type. This method should very rarely be used -- it allows you
7240 * to override the MIME type that would ordinarily be inferred from the
7241 * data with your own type given here.
7242 *
7243 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007244 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007245 * before they are set, so really this is just a convenience method for
7246 * <pre>
7247 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7248 * </pre>
7249 *
7250 * @param data The Uri of the data this intent is now targeting.
7251 * @param type The MIME type of the data being handled by this intent.
7252 *
7253 * @return Returns the same Intent object, for chaining multiple calls
7254 * into a single statement.
7255 *
7256 * @see #setType
7257 * @see #setData
7258 * @see #setDataAndType
7259 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007260 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007261 */
7262 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007263 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007264 }
7265
7266 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007267 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007268 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007269 * activities that provide <em>all</em> of the requested categories will be
7270 * used.
7271 *
7272 * @param category The desired category. This can be either one of the
7273 * predefined Intent categories, or a custom category in your own
7274 * namespace.
7275 *
7276 * @return Returns the same Intent object, for chaining multiple calls
7277 * into a single statement.
7278 *
7279 * @see #hasCategory
7280 * @see #removeCategory
7281 */
7282 public Intent addCategory(String category) {
7283 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007284 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007285 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007286 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007287 return this;
7288 }
7289
7290 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007291 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007292 *
7293 * @param category The category to remove.
7294 *
7295 * @see #addCategory
7296 */
7297 public void removeCategory(String category) {
7298 if (mCategories != null) {
7299 mCategories.remove(category);
7300 if (mCategories.size() == 0) {
7301 mCategories = null;
7302 }
7303 }
7304 }
7305
7306 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007307 * Set a selector for this Intent. This is a modification to the kinds of
7308 * things the Intent will match. If the selector is set, it will be used
7309 * when trying to find entities that can handle the Intent, instead of the
7310 * main contents of the Intent. This allows you build an Intent containing
7311 * a generic protocol while targeting it more specifically.
7312 *
7313 * <p>An example of where this may be used is with things like
7314 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7315 * Intent that will launch the Browser application. However, the correct
7316 * main entry point of an application is actually {@link #ACTION_MAIN}
7317 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7318 * used to specify the actual Activity to launch. If you launch the browser
7319 * with something different, undesired behavior may happen if the user has
7320 * previously or later launches it the normal way, since they do not match.
7321 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7322 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7323 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7324 *
7325 * <p>Setting a selector does not impact the behavior of
7326 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7327 * desired behavior of a selector -- it does not impact the base meaning
7328 * of the Intent, just what kinds of things will be matched against it
7329 * when determining who can handle it.</p>
7330 *
7331 * <p>You can not use both a selector and {@link #setPackage(String)} on
7332 * the same base Intent.</p>
7333 *
7334 * @param selector The desired selector Intent; set to null to not use
7335 * a special selector.
7336 */
7337 public void setSelector(Intent selector) {
7338 if (selector == this) {
7339 throw new IllegalArgumentException(
7340 "Intent being set as a selector of itself");
7341 }
7342 if (selector != null && mPackage != null) {
7343 throw new IllegalArgumentException(
7344 "Can't set selector when package name is already set");
7345 }
7346 mSelector = selector;
7347 }
7348
7349 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007350 * Set a {@link ClipData} associated with this Intent. This replaces any
7351 * previously set ClipData.
7352 *
7353 * <p>The ClipData in an intent is not used for Intent matching or other
7354 * such operations. Semantically it is like extras, used to transmit
7355 * additional data with the Intent. The main feature of using this over
7356 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7357 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7358 * items included in the clip data. This is useful, in particular, if
7359 * you want to transmit an Intent containing multiple <code>content:</code>
7360 * URIs for which the recipient may not have global permission to access the
7361 * content provider.
7362 *
7363 * <p>If the ClipData contains items that are themselves Intents, any
7364 * grant flags in those Intents will be ignored. Only the top-level flags
7365 * of the main Intent are respected, and will be applied to all Uri or
7366 * Intent items in the clip (or sub-items of the clip).
7367 *
7368 * <p>The MIME type, label, and icon in the ClipData object are not
7369 * directly used by Intent. Applications should generally rely on the
7370 * MIME type of the Intent itself, not what it may find in the ClipData.
7371 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007372 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007373 *
7374 * @param clip The new clip to set. May be null to clear the current clip.
7375 */
7376 public void setClipData(ClipData clip) {
7377 mClipData = clip;
7378 }
7379
7380 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007381 * This is NOT a secure mechanism to identify the user who sent the intent.
7382 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7383 * who sent the intent.
7384 * @hide
7385 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007386 public void prepareToLeaveUser(int userId) {
7387 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7388 // We want mContentUserHint to refer to the original user, so don't do anything.
7389 if (mContentUserHint == UserHandle.USER_CURRENT) {
7390 mContentUserHint = userId;
7391 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007392 }
7393
7394 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007395 * Add extended data to the intent. The name must include a package
7396 * prefix, for example the app com.android.contacts would use names
7397 * like "com.android.contacts.ShowAll".
7398 *
7399 * @param name The name of the extra data, with package prefix.
7400 * @param value The boolean data value.
7401 *
7402 * @return Returns the same Intent object, for chaining multiple calls
7403 * into a single statement.
7404 *
7405 * @see #putExtras
7406 * @see #removeExtra
7407 * @see #getBooleanExtra(String, boolean)
7408 */
7409 public Intent putExtra(String name, boolean value) {
7410 if (mExtras == null) {
7411 mExtras = new Bundle();
7412 }
7413 mExtras.putBoolean(name, value);
7414 return this;
7415 }
7416
7417 /**
7418 * Add extended data to the intent. The name must include a package
7419 * prefix, for example the app com.android.contacts would use names
7420 * like "com.android.contacts.ShowAll".
7421 *
7422 * @param name The name of the extra data, with package prefix.
7423 * @param value The byte data value.
7424 *
7425 * @return Returns the same Intent object, for chaining multiple calls
7426 * into a single statement.
7427 *
7428 * @see #putExtras
7429 * @see #removeExtra
7430 * @see #getByteExtra(String, byte)
7431 */
7432 public Intent putExtra(String name, byte value) {
7433 if (mExtras == null) {
7434 mExtras = new Bundle();
7435 }
7436 mExtras.putByte(name, value);
7437 return this;
7438 }
7439
7440 /**
7441 * Add extended data to the intent. The name must include a package
7442 * prefix, for example the app com.android.contacts would use names
7443 * like "com.android.contacts.ShowAll".
7444 *
7445 * @param name The name of the extra data, with package prefix.
7446 * @param value The char data value.
7447 *
7448 * @return Returns the same Intent object, for chaining multiple calls
7449 * into a single statement.
7450 *
7451 * @see #putExtras
7452 * @see #removeExtra
7453 * @see #getCharExtra(String, char)
7454 */
7455 public Intent putExtra(String name, char value) {
7456 if (mExtras == null) {
7457 mExtras = new Bundle();
7458 }
7459 mExtras.putChar(name, value);
7460 return this;
7461 }
7462
7463 /**
7464 * Add extended data to the intent. The name must include a package
7465 * prefix, for example the app com.android.contacts would use names
7466 * like "com.android.contacts.ShowAll".
7467 *
7468 * @param name The name of the extra data, with package prefix.
7469 * @param value The short data value.
7470 *
7471 * @return Returns the same Intent object, for chaining multiple calls
7472 * into a single statement.
7473 *
7474 * @see #putExtras
7475 * @see #removeExtra
7476 * @see #getShortExtra(String, short)
7477 */
7478 public Intent putExtra(String name, short value) {
7479 if (mExtras == null) {
7480 mExtras = new Bundle();
7481 }
7482 mExtras.putShort(name, value);
7483 return this;
7484 }
7485
7486 /**
7487 * Add extended data to the intent. The name must include a package
7488 * prefix, for example the app com.android.contacts would use names
7489 * like "com.android.contacts.ShowAll".
7490 *
7491 * @param name The name of the extra data, with package prefix.
7492 * @param value The integer data value.
7493 *
7494 * @return Returns the same Intent object, for chaining multiple calls
7495 * into a single statement.
7496 *
7497 * @see #putExtras
7498 * @see #removeExtra
7499 * @see #getIntExtra(String, int)
7500 */
7501 public Intent putExtra(String name, int value) {
7502 if (mExtras == null) {
7503 mExtras = new Bundle();
7504 }
7505 mExtras.putInt(name, value);
7506 return this;
7507 }
7508
7509 /**
7510 * Add extended data to the intent. The name must include a package
7511 * prefix, for example the app com.android.contacts would use names
7512 * like "com.android.contacts.ShowAll".
7513 *
7514 * @param name The name of the extra data, with package prefix.
7515 * @param value The long data value.
7516 *
7517 * @return Returns the same Intent object, for chaining multiple calls
7518 * into a single statement.
7519 *
7520 * @see #putExtras
7521 * @see #removeExtra
7522 * @see #getLongExtra(String, long)
7523 */
7524 public Intent putExtra(String name, long value) {
7525 if (mExtras == null) {
7526 mExtras = new Bundle();
7527 }
7528 mExtras.putLong(name, value);
7529 return this;
7530 }
7531
7532 /**
7533 * Add extended data to the intent. The name must include a package
7534 * prefix, for example the app com.android.contacts would use names
7535 * like "com.android.contacts.ShowAll".
7536 *
7537 * @param name The name of the extra data, with package prefix.
7538 * @param value The float data value.
7539 *
7540 * @return Returns the same Intent object, for chaining multiple calls
7541 * into a single statement.
7542 *
7543 * @see #putExtras
7544 * @see #removeExtra
7545 * @see #getFloatExtra(String, float)
7546 */
7547 public Intent putExtra(String name, float value) {
7548 if (mExtras == null) {
7549 mExtras = new Bundle();
7550 }
7551 mExtras.putFloat(name, value);
7552 return this;
7553 }
7554
7555 /**
7556 * Add extended data to the intent. The name must include a package
7557 * prefix, for example the app com.android.contacts would use names
7558 * like "com.android.contacts.ShowAll".
7559 *
7560 * @param name The name of the extra data, with package prefix.
7561 * @param value The double data value.
7562 *
7563 * @return Returns the same Intent object, for chaining multiple calls
7564 * into a single statement.
7565 *
7566 * @see #putExtras
7567 * @see #removeExtra
7568 * @see #getDoubleExtra(String, double)
7569 */
7570 public Intent putExtra(String name, double value) {
7571 if (mExtras == null) {
7572 mExtras = new Bundle();
7573 }
7574 mExtras.putDouble(name, value);
7575 return this;
7576 }
7577
7578 /**
7579 * Add extended data to the intent. The name must include a package
7580 * prefix, for example the app com.android.contacts would use names
7581 * like "com.android.contacts.ShowAll".
7582 *
7583 * @param name The name of the extra data, with package prefix.
7584 * @param value The String data value.
7585 *
7586 * @return Returns the same Intent object, for chaining multiple calls
7587 * into a single statement.
7588 *
7589 * @see #putExtras
7590 * @see #removeExtra
7591 * @see #getStringExtra(String)
7592 */
7593 public Intent putExtra(String name, String value) {
7594 if (mExtras == null) {
7595 mExtras = new Bundle();
7596 }
7597 mExtras.putString(name, value);
7598 return this;
7599 }
7600
7601 /**
7602 * Add extended data to the intent. The name must include a package
7603 * prefix, for example the app com.android.contacts would use names
7604 * like "com.android.contacts.ShowAll".
7605 *
7606 * @param name The name of the extra data, with package prefix.
7607 * @param value The CharSequence data value.
7608 *
7609 * @return Returns the same Intent object, for chaining multiple calls
7610 * into a single statement.
7611 *
7612 * @see #putExtras
7613 * @see #removeExtra
7614 * @see #getCharSequenceExtra(String)
7615 */
7616 public Intent putExtra(String name, CharSequence value) {
7617 if (mExtras == null) {
7618 mExtras = new Bundle();
7619 }
7620 mExtras.putCharSequence(name, value);
7621 return this;
7622 }
7623
7624 /**
7625 * Add extended data to the intent. The name must include a package
7626 * prefix, for example the app com.android.contacts would use names
7627 * like "com.android.contacts.ShowAll".
7628 *
7629 * @param name The name of the extra data, with package prefix.
7630 * @param value The Parcelable data value.
7631 *
7632 * @return Returns the same Intent object, for chaining multiple calls
7633 * into a single statement.
7634 *
7635 * @see #putExtras
7636 * @see #removeExtra
7637 * @see #getParcelableExtra(String)
7638 */
7639 public Intent putExtra(String name, Parcelable value) {
7640 if (mExtras == null) {
7641 mExtras = new Bundle();
7642 }
7643 mExtras.putParcelable(name, value);
7644 return this;
7645 }
7646
7647 /**
7648 * Add extended data to the intent. The name must include a package
7649 * prefix, for example the app com.android.contacts would use names
7650 * like "com.android.contacts.ShowAll".
7651 *
7652 * @param name The name of the extra data, with package prefix.
7653 * @param value The Parcelable[] data value.
7654 *
7655 * @return Returns the same Intent object, for chaining multiple calls
7656 * into a single statement.
7657 *
7658 * @see #putExtras
7659 * @see #removeExtra
7660 * @see #getParcelableArrayExtra(String)
7661 */
7662 public Intent putExtra(String name, Parcelable[] value) {
7663 if (mExtras == null) {
7664 mExtras = new Bundle();
7665 }
7666 mExtras.putParcelableArray(name, value);
7667 return this;
7668 }
7669
7670 /**
7671 * Add extended data to the intent. The name must include a package
7672 * prefix, for example the app com.android.contacts would use names
7673 * like "com.android.contacts.ShowAll".
7674 *
7675 * @param name The name of the extra data, with package prefix.
7676 * @param value The ArrayList<Parcelable> data value.
7677 *
7678 * @return Returns the same Intent object, for chaining multiple calls
7679 * into a single statement.
7680 *
7681 * @see #putExtras
7682 * @see #removeExtra
7683 * @see #getParcelableArrayListExtra(String)
7684 */
7685 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7686 if (mExtras == null) {
7687 mExtras = new Bundle();
7688 }
7689 mExtras.putParcelableArrayList(name, value);
7690 return this;
7691 }
7692
7693 /**
7694 * Add extended data to the intent. The name must include a package
7695 * prefix, for example the app com.android.contacts would use names
7696 * like "com.android.contacts.ShowAll".
7697 *
7698 * @param name The name of the extra data, with package prefix.
7699 * @param value The ArrayList<Integer> data value.
7700 *
7701 * @return Returns the same Intent object, for chaining multiple calls
7702 * into a single statement.
7703 *
7704 * @see #putExtras
7705 * @see #removeExtra
7706 * @see #getIntegerArrayListExtra(String)
7707 */
7708 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7709 if (mExtras == null) {
7710 mExtras = new Bundle();
7711 }
7712 mExtras.putIntegerArrayList(name, value);
7713 return this;
7714 }
7715
7716 /**
7717 * Add extended data to the intent. The name must include a package
7718 * prefix, for example the app com.android.contacts would use names
7719 * like "com.android.contacts.ShowAll".
7720 *
7721 * @param name The name of the extra data, with package prefix.
7722 * @param value The ArrayList<String> data value.
7723 *
7724 * @return Returns the same Intent object, for chaining multiple calls
7725 * into a single statement.
7726 *
7727 * @see #putExtras
7728 * @see #removeExtra
7729 * @see #getStringArrayListExtra(String)
7730 */
7731 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7732 if (mExtras == null) {
7733 mExtras = new Bundle();
7734 }
7735 mExtras.putStringArrayList(name, value);
7736 return this;
7737 }
7738
7739 /**
7740 * Add extended data to the intent. The name must include a package
7741 * prefix, for example the app com.android.contacts would use names
7742 * like "com.android.contacts.ShowAll".
7743 *
7744 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007745 * @param value The ArrayList<CharSequence> data value.
7746 *
7747 * @return Returns the same Intent object, for chaining multiple calls
7748 * into a single statement.
7749 *
7750 * @see #putExtras
7751 * @see #removeExtra
7752 * @see #getCharSequenceArrayListExtra(String)
7753 */
7754 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7755 if (mExtras == null) {
7756 mExtras = new Bundle();
7757 }
7758 mExtras.putCharSequenceArrayList(name, value);
7759 return this;
7760 }
7761
7762 /**
7763 * Add extended data to the intent. The name must include a package
7764 * prefix, for example the app com.android.contacts would use names
7765 * like "com.android.contacts.ShowAll".
7766 *
7767 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007768 * @param value The Serializable data value.
7769 *
7770 * @return Returns the same Intent object, for chaining multiple calls
7771 * into a single statement.
7772 *
7773 * @see #putExtras
7774 * @see #removeExtra
7775 * @see #getSerializableExtra(String)
7776 */
7777 public Intent putExtra(String name, Serializable value) {
7778 if (mExtras == null) {
7779 mExtras = new Bundle();
7780 }
7781 mExtras.putSerializable(name, value);
7782 return this;
7783 }
7784
7785 /**
7786 * Add extended data to the intent. The name must include a package
7787 * prefix, for example the app com.android.contacts would use names
7788 * like "com.android.contacts.ShowAll".
7789 *
7790 * @param name The name of the extra data, with package prefix.
7791 * @param value The boolean array data value.
7792 *
7793 * @return Returns the same Intent object, for chaining multiple calls
7794 * into a single statement.
7795 *
7796 * @see #putExtras
7797 * @see #removeExtra
7798 * @see #getBooleanArrayExtra(String)
7799 */
7800 public Intent putExtra(String name, boolean[] value) {
7801 if (mExtras == null) {
7802 mExtras = new Bundle();
7803 }
7804 mExtras.putBooleanArray(name, value);
7805 return this;
7806 }
7807
7808 /**
7809 * Add extended data to the intent. The name must include a package
7810 * prefix, for example the app com.android.contacts would use names
7811 * like "com.android.contacts.ShowAll".
7812 *
7813 * @param name The name of the extra data, with package prefix.
7814 * @param value The byte array data value.
7815 *
7816 * @return Returns the same Intent object, for chaining multiple calls
7817 * into a single statement.
7818 *
7819 * @see #putExtras
7820 * @see #removeExtra
7821 * @see #getByteArrayExtra(String)
7822 */
7823 public Intent putExtra(String name, byte[] value) {
7824 if (mExtras == null) {
7825 mExtras = new Bundle();
7826 }
7827 mExtras.putByteArray(name, value);
7828 return this;
7829 }
7830
7831 /**
7832 * Add extended data to the intent. The name must include a package
7833 * prefix, for example the app com.android.contacts would use names
7834 * like "com.android.contacts.ShowAll".
7835 *
7836 * @param name The name of the extra data, with package prefix.
7837 * @param value The short array data value.
7838 *
7839 * @return Returns the same Intent object, for chaining multiple calls
7840 * into a single statement.
7841 *
7842 * @see #putExtras
7843 * @see #removeExtra
7844 * @see #getShortArrayExtra(String)
7845 */
7846 public Intent putExtra(String name, short[] value) {
7847 if (mExtras == null) {
7848 mExtras = new Bundle();
7849 }
7850 mExtras.putShortArray(name, value);
7851 return this;
7852 }
7853
7854 /**
7855 * Add extended data to the intent. The name must include a package
7856 * prefix, for example the app com.android.contacts would use names
7857 * like "com.android.contacts.ShowAll".
7858 *
7859 * @param name The name of the extra data, with package prefix.
7860 * @param value The char array data value.
7861 *
7862 * @return Returns the same Intent object, for chaining multiple calls
7863 * into a single statement.
7864 *
7865 * @see #putExtras
7866 * @see #removeExtra
7867 * @see #getCharArrayExtra(String)
7868 */
7869 public Intent putExtra(String name, char[] value) {
7870 if (mExtras == null) {
7871 mExtras = new Bundle();
7872 }
7873 mExtras.putCharArray(name, value);
7874 return this;
7875 }
7876
7877 /**
7878 * Add extended data to the intent. The name must include a package
7879 * prefix, for example the app com.android.contacts would use names
7880 * like "com.android.contacts.ShowAll".
7881 *
7882 * @param name The name of the extra data, with package prefix.
7883 * @param value The int array data value.
7884 *
7885 * @return Returns the same Intent object, for chaining multiple calls
7886 * into a single statement.
7887 *
7888 * @see #putExtras
7889 * @see #removeExtra
7890 * @see #getIntArrayExtra(String)
7891 */
7892 public Intent putExtra(String name, int[] value) {
7893 if (mExtras == null) {
7894 mExtras = new Bundle();
7895 }
7896 mExtras.putIntArray(name, value);
7897 return this;
7898 }
7899
7900 /**
7901 * Add extended data to the intent. The name must include a package
7902 * prefix, for example the app com.android.contacts would use names
7903 * like "com.android.contacts.ShowAll".
7904 *
7905 * @param name The name of the extra data, with package prefix.
7906 * @param value The byte array data value.
7907 *
7908 * @return Returns the same Intent object, for chaining multiple calls
7909 * into a single statement.
7910 *
7911 * @see #putExtras
7912 * @see #removeExtra
7913 * @see #getLongArrayExtra(String)
7914 */
7915 public Intent putExtra(String name, long[] value) {
7916 if (mExtras == null) {
7917 mExtras = new Bundle();
7918 }
7919 mExtras.putLongArray(name, value);
7920 return this;
7921 }
7922
7923 /**
7924 * Add extended data to the intent. The name must include a package
7925 * prefix, for example the app com.android.contacts would use names
7926 * like "com.android.contacts.ShowAll".
7927 *
7928 * @param name The name of the extra data, with package prefix.
7929 * @param value The float array data value.
7930 *
7931 * @return Returns the same Intent object, for chaining multiple calls
7932 * into a single statement.
7933 *
7934 * @see #putExtras
7935 * @see #removeExtra
7936 * @see #getFloatArrayExtra(String)
7937 */
7938 public Intent putExtra(String name, float[] value) {
7939 if (mExtras == null) {
7940 mExtras = new Bundle();
7941 }
7942 mExtras.putFloatArray(name, value);
7943 return this;
7944 }
7945
7946 /**
7947 * Add extended data to the intent. The name must include a package
7948 * prefix, for example the app com.android.contacts would use names
7949 * like "com.android.contacts.ShowAll".
7950 *
7951 * @param name The name of the extra data, with package prefix.
7952 * @param value The double array data value.
7953 *
7954 * @return Returns the same Intent object, for chaining multiple calls
7955 * into a single statement.
7956 *
7957 * @see #putExtras
7958 * @see #removeExtra
7959 * @see #getDoubleArrayExtra(String)
7960 */
7961 public Intent putExtra(String name, double[] value) {
7962 if (mExtras == null) {
7963 mExtras = new Bundle();
7964 }
7965 mExtras.putDoubleArray(name, value);
7966 return this;
7967 }
7968
7969 /**
7970 * Add extended data to the intent. The name must include a package
7971 * prefix, for example the app com.android.contacts would use names
7972 * like "com.android.contacts.ShowAll".
7973 *
7974 * @param name The name of the extra data, with package prefix.
7975 * @param value The String array data value.
7976 *
7977 * @return Returns the same Intent object, for chaining multiple calls
7978 * into a single statement.
7979 *
7980 * @see #putExtras
7981 * @see #removeExtra
7982 * @see #getStringArrayExtra(String)
7983 */
7984 public Intent putExtra(String name, String[] value) {
7985 if (mExtras == null) {
7986 mExtras = new Bundle();
7987 }
7988 mExtras.putStringArray(name, value);
7989 return this;
7990 }
7991
7992 /**
7993 * Add extended data to the intent. The name must include a package
7994 * prefix, for example the app com.android.contacts would use names
7995 * like "com.android.contacts.ShowAll".
7996 *
7997 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007998 * @param value The CharSequence array data value.
7999 *
8000 * @return Returns the same Intent object, for chaining multiple calls
8001 * into a single statement.
8002 *
8003 * @see #putExtras
8004 * @see #removeExtra
8005 * @see #getCharSequenceArrayExtra(String)
8006 */
8007 public Intent putExtra(String name, CharSequence[] value) {
8008 if (mExtras == null) {
8009 mExtras = new Bundle();
8010 }
8011 mExtras.putCharSequenceArray(name, value);
8012 return this;
8013 }
8014
8015 /**
8016 * Add extended data to the intent. The name must include a package
8017 * prefix, for example the app com.android.contacts would use names
8018 * like "com.android.contacts.ShowAll".
8019 *
8020 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008021 * @param value The Bundle data value.
8022 *
8023 * @return Returns the same Intent object, for chaining multiple calls
8024 * into a single statement.
8025 *
8026 * @see #putExtras
8027 * @see #removeExtra
8028 * @see #getBundleExtra(String)
8029 */
8030 public Intent putExtra(String name, Bundle value) {
8031 if (mExtras == null) {
8032 mExtras = new Bundle();
8033 }
8034 mExtras.putBundle(name, value);
8035 return this;
8036 }
8037
8038 /**
8039 * Add extended data to the intent. The name must include a package
8040 * prefix, for example the app com.android.contacts would use names
8041 * like "com.android.contacts.ShowAll".
8042 *
8043 * @param name The name of the extra data, with package prefix.
8044 * @param value The IBinder data value.
8045 *
8046 * @return Returns the same Intent object, for chaining multiple calls
8047 * into a single statement.
8048 *
8049 * @see #putExtras
8050 * @see #removeExtra
8051 * @see #getIBinderExtra(String)
8052 *
8053 * @deprecated
8054 * @hide
8055 */
8056 @Deprecated
8057 public Intent putExtra(String name, IBinder value) {
8058 if (mExtras == null) {
8059 mExtras = new Bundle();
8060 }
8061 mExtras.putIBinder(name, value);
8062 return this;
8063 }
8064
8065 /**
8066 * Copy all extras in 'src' in to this intent.
8067 *
8068 * @param src Contains the extras to copy.
8069 *
8070 * @see #putExtra
8071 */
8072 public Intent putExtras(Intent src) {
8073 if (src.mExtras != null) {
8074 if (mExtras == null) {
8075 mExtras = new Bundle(src.mExtras);
8076 } else {
8077 mExtras.putAll(src.mExtras);
8078 }
8079 }
8080 return this;
8081 }
8082
8083 /**
8084 * Add a set of extended data to the intent. The keys must include a package
8085 * prefix, for example the app com.android.contacts would use names
8086 * like "com.android.contacts.ShowAll".
8087 *
8088 * @param extras The Bundle of extras to add to this intent.
8089 *
8090 * @see #putExtra
8091 * @see #removeExtra
8092 */
8093 public Intent putExtras(Bundle extras) {
8094 if (mExtras == null) {
8095 mExtras = new Bundle();
8096 }
8097 mExtras.putAll(extras);
8098 return this;
8099 }
8100
8101 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008102 * Completely replace the extras in the Intent with the extras in the
8103 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008104 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008105 * @param src The exact extras contained in this Intent are copied
8106 * into the target intent, replacing any that were previously there.
8107 */
8108 public Intent replaceExtras(Intent src) {
8109 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8110 return this;
8111 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008112
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008113 /**
8114 * Completely replace the extras in the Intent with the given Bundle of
8115 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008116 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008117 * @param extras The new set of extras in the Intent, or null to erase
8118 * all extras.
8119 */
8120 public Intent replaceExtras(Bundle extras) {
8121 mExtras = extras != null ? new Bundle(extras) : null;
8122 return this;
8123 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008124
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008125 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008126 * Remove extended data from the intent.
8127 *
8128 * @see #putExtra
8129 */
8130 public void removeExtra(String name) {
8131 if (mExtras != null) {
8132 mExtras.remove(name);
8133 if (mExtras.size() == 0) {
8134 mExtras = null;
8135 }
8136 }
8137 }
8138
8139 /**
8140 * Set special flags controlling how this intent is handled. Most values
8141 * here depend on the type of component being executed by the Intent,
8142 * specifically the FLAG_ACTIVITY_* flags are all for use with
8143 * {@link Context#startActivity Context.startActivity()} and the
8144 * FLAG_RECEIVER_* flags are all for use with
8145 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8146 *
Scott Main7aee61f2011-02-08 11:25:01 -08008147 * <p>See the
8148 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8149 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008150 * the behavior of your application.
8151 *
8152 * @param flags The desired flags.
8153 *
8154 * @return Returns the same Intent object, for chaining multiple calls
8155 * into a single statement.
8156 *
8157 * @see #getFlags
8158 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008159 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008160 *
8161 * @see #FLAG_GRANT_READ_URI_PERMISSION
8162 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008163 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8164 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008165 * @see #FLAG_DEBUG_LOG_RESOLUTION
8166 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008167 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008168 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008169 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008170 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008171 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8172 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008173 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008174 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008175 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008176 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008177 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008178 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008179 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008180 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8181 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008182 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008183 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008184 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008185 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8186 */
8187 public Intent setFlags(int flags) {
8188 mFlags = flags;
8189 return this;
8190 }
8191
8192 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008193 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008194 *
8195 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008196 * @return Returns the same Intent object, for chaining multiple calls into
8197 * a single statement.
8198 * @see #setFlags(int)
8199 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008200 */
8201 public Intent addFlags(int flags) {
8202 mFlags |= flags;
8203 return this;
8204 }
8205
8206 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008207 * Remove these flags from the intent.
8208 *
8209 * @param flags The flags to remove.
8210 * @see #setFlags(int)
8211 * @see #addFlags(int)
8212 */
8213 public void removeFlags(int flags) {
8214 mFlags &= ~flags;
8215 }
8216
8217 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008218 * (Usually optional) Set an explicit application package name that limits
8219 * the components this Intent will resolve to. If left to the default
8220 * value of null, all components in all applications will considered.
8221 * If non-null, the Intent can only match the components in the given
8222 * application package.
8223 *
8224 * @param packageName The name of the application package to handle the
8225 * intent, or null to allow any application package.
8226 *
8227 * @return Returns the same Intent object, for chaining multiple calls
8228 * into a single statement.
8229 *
8230 * @see #getPackage
8231 * @see #resolveActivity
8232 */
8233 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008234 if (packageName != null && mSelector != null) {
8235 throw new IllegalArgumentException(
8236 "Can't set package name when selector is already set");
8237 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008238 mPackage = packageName;
8239 return this;
8240 }
8241
8242 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008243 * (Usually optional) Explicitly set the component to handle the intent.
8244 * If left with the default value of null, the system will determine the
8245 * appropriate class to use based on the other fields (action, data,
8246 * type, categories) in the Intent. If this class is defined, the
8247 * specified class will always be used regardless of the other fields. You
8248 * should only set this value when you know you absolutely want a specific
8249 * class to be used; otherwise it is better to let the system find the
8250 * appropriate class so that you will respect the installed applications
8251 * and user preferences.
8252 *
8253 * @param component The name of the application component to handle the
8254 * intent, or null to let the system find one for you.
8255 *
8256 * @return Returns the same Intent object, for chaining multiple calls
8257 * into a single statement.
8258 *
8259 * @see #setClass
8260 * @see #setClassName(Context, String)
8261 * @see #setClassName(String, String)
8262 * @see #getComponent
8263 * @see #resolveActivity
8264 */
8265 public Intent setComponent(ComponentName component) {
8266 mComponent = component;
8267 return this;
8268 }
8269
8270 /**
8271 * Convenience for calling {@link #setComponent} with an
8272 * explicit class name.
8273 *
8274 * @param packageContext A Context of the application package implementing
8275 * this class.
8276 * @param className The name of a class inside of the application package
8277 * that will be used as the component for this Intent.
8278 *
8279 * @return Returns the same Intent object, for chaining multiple calls
8280 * into a single statement.
8281 *
8282 * @see #setComponent
8283 * @see #setClass
8284 */
8285 public Intent setClassName(Context packageContext, String className) {
8286 mComponent = new ComponentName(packageContext, className);
8287 return this;
8288 }
8289
8290 /**
8291 * Convenience for calling {@link #setComponent} with an
8292 * explicit application package name and class name.
8293 *
8294 * @param packageName The name of the package implementing the desired
8295 * component.
8296 * @param className The name of a class inside of the application package
8297 * that will be used as the component for this Intent.
8298 *
8299 * @return Returns the same Intent object, for chaining multiple calls
8300 * into a single statement.
8301 *
8302 * @see #setComponent
8303 * @see #setClass
8304 */
8305 public Intent setClassName(String packageName, String className) {
8306 mComponent = new ComponentName(packageName, className);
8307 return this;
8308 }
8309
8310 /**
8311 * Convenience for calling {@link #setComponent(ComponentName)} with the
8312 * name returned by a {@link Class} object.
8313 *
8314 * @param packageContext A Context of the application package implementing
8315 * this class.
8316 * @param cls The class name to set, equivalent to
8317 * <code>setClassName(context, cls.getName())</code>.
8318 *
8319 * @return Returns the same Intent object, for chaining multiple calls
8320 * into a single statement.
8321 *
8322 * @see #setComponent
8323 */
8324 public Intent setClass(Context packageContext, Class<?> cls) {
8325 mComponent = new ComponentName(packageContext, cls);
8326 return this;
8327 }
8328
8329 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008330 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8331 * used as a hint to the receiver for animations and the like. Null means that there
8332 * is no source bounds.
8333 */
8334 public void setSourceBounds(Rect r) {
8335 if (r != null) {
8336 mSourceBounds = new Rect(r);
8337 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008338 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008339 }
8340 }
8341
Tor Norbyed9273d62013-05-30 15:59:53 -07008342 /** @hide */
8343 @IntDef(flag = true,
8344 value = {
8345 FILL_IN_ACTION,
8346 FILL_IN_DATA,
8347 FILL_IN_CATEGORIES,
8348 FILL_IN_COMPONENT,
8349 FILL_IN_PACKAGE,
8350 FILL_IN_SOURCE_BOUNDS,
8351 FILL_IN_SELECTOR,
8352 FILL_IN_CLIP_DATA
8353 })
8354 @Retention(RetentionPolicy.SOURCE)
8355 public @interface FillInFlags {}
8356
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008357 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008358 * Use with {@link #fillIn} to allow the current action value to be
8359 * overwritten, even if it is already set.
8360 */
8361 public static final int FILL_IN_ACTION = 1<<0;
8362
8363 /**
8364 * Use with {@link #fillIn} to allow the current data or type value
8365 * overwritten, even if it is already set.
8366 */
8367 public static final int FILL_IN_DATA = 1<<1;
8368
8369 /**
8370 * Use with {@link #fillIn} to allow the current categories to be
8371 * overwritten, even if they are already set.
8372 */
8373 public static final int FILL_IN_CATEGORIES = 1<<2;
8374
8375 /**
8376 * Use with {@link #fillIn} to allow the current component value to be
8377 * overwritten, even if it is already set.
8378 */
8379 public static final int FILL_IN_COMPONENT = 1<<3;
8380
8381 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008382 * Use with {@link #fillIn} to allow the current package value to be
8383 * overwritten, even if it is already set.
8384 */
8385 public static final int FILL_IN_PACKAGE = 1<<4;
8386
8387 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008388 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008389 * overwritten, even if it is already set.
8390 */
8391 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8392
8393 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008394 * Use with {@link #fillIn} to allow the current selector to be
8395 * overwritten, even if it is already set.
8396 */
8397 public static final int FILL_IN_SELECTOR = 1<<6;
8398
8399 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008400 * Use with {@link #fillIn} to allow the current ClipData to be
8401 * overwritten, even if it is already set.
8402 */
8403 public static final int FILL_IN_CLIP_DATA = 1<<7;
8404
8405 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008406 * Copy the contents of <var>other</var> in to this object, but only
8407 * where fields are not defined by this object. For purposes of a field
8408 * being defined, the following pieces of data in the Intent are
8409 * considered to be separate fields:
8410 *
8411 * <ul>
8412 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008413 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008414 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8415 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008416 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008417 * <li> component, as set by {@link #setComponent(ComponentName)} or
8418 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008419 * <li> source bounds, as set by {@link #setSourceBounds}.
8420 * <li> selector, as set by {@link #setSelector(Intent)}.
8421 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008422 * <li> each top-level name in the associated extras.
8423 * </ul>
8424 *
8425 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008426 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008427 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8428 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8429 * the restriction where the corresponding field will not be replaced if
8430 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008431 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008432 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8433 * is explicitly specified. The selector will only be copied if
8434 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008435 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008436 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8437 * and Intent B with {action="gotit", data-type="some/thing",
8438 * categories="one","two"}.
8439 *
8440 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8441 * containing: {action="gotit", data-type="some/thing",
8442 * categories="bar"}.
8443 *
8444 * @param other Another Intent whose values are to be used to fill in
8445 * the current one.
8446 * @param flags Options to control which fields can be filled in.
8447 *
8448 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008449 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008450 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008451 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008452 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008453 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008454 @FillInFlags
8455 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008456 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008457 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008458 if (other.mAction != null
8459 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008460 mAction = other.mAction;
8461 changes |= FILL_IN_ACTION;
8462 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008463 if ((other.mData != null || other.mType != null)
8464 && ((mData == null && mType == null)
8465 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008466 mData = other.mData;
8467 mType = other.mType;
8468 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008469 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008470 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008471 if (other.mCategories != null
8472 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008473 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008474 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008475 }
8476 changes |= FILL_IN_CATEGORIES;
8477 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008478 if (other.mPackage != null
8479 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008480 // Only do this if mSelector is not set.
8481 if (mSelector == null) {
8482 mPackage = other.mPackage;
8483 changes |= FILL_IN_PACKAGE;
8484 }
8485 }
8486 // Selector is special: it can only be set if explicitly allowed,
8487 // for the same reason as the component name.
8488 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8489 if (mPackage == null) {
8490 mSelector = new Intent(other.mSelector);
8491 mPackage = null;
8492 changes |= FILL_IN_SELECTOR;
8493 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008494 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008495 if (other.mClipData != null
8496 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8497 mClipData = other.mClipData;
8498 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008499 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008500 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008501 // Component is special: it can -only- be set if explicitly allowed,
8502 // since otherwise the sender could force the intent somewhere the
8503 // originator didn't intend.
8504 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008505 mComponent = other.mComponent;
8506 changes |= FILL_IN_COMPONENT;
8507 }
8508 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008509 if (other.mSourceBounds != null
8510 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8511 mSourceBounds = new Rect(other.mSourceBounds);
8512 changes |= FILL_IN_SOURCE_BOUNDS;
8513 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008514 if (mExtras == null) {
8515 if (other.mExtras != null) {
8516 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008517 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008518 }
8519 } else if (other.mExtras != null) {
8520 try {
8521 Bundle newb = new Bundle(other.mExtras);
8522 newb.putAll(mExtras);
8523 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008524 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008525 } catch (RuntimeException e) {
8526 // Modifying the extras can cause us to unparcel the contents
8527 // of the bundle, and if we do this in the system process that
8528 // may fail. We really should handle this (i.e., the Bundle
8529 // impl shouldn't be on top of a plain map), but for now just
8530 // ignore it and keep the original contents. :(
8531 Log.w("Intent", "Failure filling in extras", e);
8532 }
8533 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008534 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8535 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8536 mContentUserHint = other.mContentUserHint;
8537 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008538 return changes;
8539 }
8540
8541 /**
8542 * Wrapper class holding an Intent and implementing comparisons on it for
8543 * the purpose of filtering. The class implements its
8544 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8545 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8546 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8547 * on the wrapped Intent.
8548 */
8549 public static final class FilterComparison {
8550 private final Intent mIntent;
8551 private final int mHashCode;
8552
8553 public FilterComparison(Intent intent) {
8554 mIntent = intent;
8555 mHashCode = intent.filterHashCode();
8556 }
8557
8558 /**
8559 * Return the Intent that this FilterComparison represents.
8560 * @return Returns the Intent held by the FilterComparison. Do
8561 * not modify!
8562 */
8563 public Intent getIntent() {
8564 return mIntent;
8565 }
8566
8567 @Override
8568 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008569 if (obj instanceof FilterComparison) {
8570 Intent other = ((FilterComparison)obj).mIntent;
8571 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008572 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008573 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008574 }
8575
8576 @Override
8577 public int hashCode() {
8578 return mHashCode;
8579 }
8580 }
8581
8582 /**
8583 * Determine if two intents are the same for the purposes of intent
8584 * resolution (filtering). That is, if their action, data, type,
8585 * class, and categories are the same. This does <em>not</em> compare
8586 * any extra data included in the intents.
8587 *
8588 * @param other The other Intent to compare against.
8589 *
8590 * @return Returns true if action, data, type, class, and categories
8591 * are the same.
8592 */
8593 public boolean filterEquals(Intent other) {
8594 if (other == null) {
8595 return false;
8596 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008597 if (!Objects.equals(this.mAction, other.mAction)) return false;
8598 if (!Objects.equals(this.mData, other.mData)) return false;
8599 if (!Objects.equals(this.mType, other.mType)) return false;
8600 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8601 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8602 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008603
8604 return true;
8605 }
8606
8607 /**
8608 * Generate hash code that matches semantics of filterEquals().
8609 *
8610 * @return Returns the hash value of the action, data, type, class, and
8611 * categories.
8612 *
8613 * @see #filterEquals
8614 */
8615 public int filterHashCode() {
8616 int code = 0;
8617 if (mAction != null) {
8618 code += mAction.hashCode();
8619 }
8620 if (mData != null) {
8621 code += mData.hashCode();
8622 }
8623 if (mType != null) {
8624 code += mType.hashCode();
8625 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008626 if (mPackage != null) {
8627 code += mPackage.hashCode();
8628 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008629 if (mComponent != null) {
8630 code += mComponent.hashCode();
8631 }
8632 if (mCategories != null) {
8633 code += mCategories.hashCode();
8634 }
8635 return code;
8636 }
8637
8638 @Override
8639 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008640 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008641
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008642 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008643 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008644 b.append(" }");
8645
8646 return b.toString();
8647 }
8648
8649 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008650 public String toInsecureString() {
8651 StringBuilder b = new StringBuilder(128);
8652
8653 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008654 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008655 b.append(" }");
8656
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008657 return b.toString();
8658 }
Romain Guy4969af72009-06-17 10:53:19 -07008659
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008660 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008661 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008662 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008663
8664 b.append("Intent { ");
8665 toShortString(b, false, true, true, true);
8666 b.append(" }");
8667
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008668 return b.toString();
8669 }
8670
8671 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008672 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8673 StringBuilder b = new StringBuilder(128);
8674 toShortString(b, secure, comp, extras, clip);
8675 return b.toString();
8676 }
8677
8678 /** @hide */
8679 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8680 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008681 boolean first = true;
8682 if (mAction != null) {
8683 b.append("act=").append(mAction);
8684 first = false;
8685 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008686 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008687 if (!first) {
8688 b.append(' ');
8689 }
8690 first = false;
8691 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008692 for (int i=0; i<mCategories.size(); i++) {
8693 if (i > 0) b.append(',');
8694 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008695 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008696 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008697 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008698 if (mData != null) {
8699 if (!first) {
8700 b.append(' ');
8701 }
8702 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008703 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008704 if (secure) {
8705 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008706 } else {
8707 b.append(mData);
8708 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008709 }
8710 if (mType != null) {
8711 if (!first) {
8712 b.append(' ');
8713 }
8714 first = false;
8715 b.append("typ=").append(mType);
8716 }
8717 if (mFlags != 0) {
8718 if (!first) {
8719 b.append(' ');
8720 }
8721 first = false;
8722 b.append("flg=0x").append(Integer.toHexString(mFlags));
8723 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008724 if (mPackage != null) {
8725 if (!first) {
8726 b.append(' ');
8727 }
8728 first = false;
8729 b.append("pkg=").append(mPackage);
8730 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008731 if (comp && mComponent != null) {
8732 if (!first) {
8733 b.append(' ');
8734 }
8735 first = false;
8736 b.append("cmp=").append(mComponent.flattenToShortString());
8737 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008738 if (mSourceBounds != null) {
8739 if (!first) {
8740 b.append(' ');
8741 }
8742 first = false;
8743 b.append("bnds=").append(mSourceBounds.toShortString());
8744 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008745 if (mClipData != null) {
8746 if (!first) {
8747 b.append(' ');
8748 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008749 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008750 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008751 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008752 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008753 if (mClipData.getDescription() != null) {
8754 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8755 } else {
8756 first = true;
8757 }
8758 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008759 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008760 first = false;
8761 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008762 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008763 if (extras && mExtras != null) {
8764 if (!first) {
8765 b.append(' ');
8766 }
8767 first = false;
8768 b.append("(has extras)");
8769 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008770 if (mContentUserHint != UserHandle.USER_CURRENT) {
8771 if (!first) {
8772 b.append(' ');
8773 }
8774 first = false;
8775 b.append("u=").append(mContentUserHint);
8776 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008777 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008778 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008779 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008780 b.append("}");
8781 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008782 }
8783
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008784 /**
8785 * Call {@link #toUri} with 0 flags.
8786 * @deprecated Use {@link #toUri} instead.
8787 */
8788 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008789 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008790 return toUri(0);
8791 }
8792
8793 /**
8794 * Convert this Intent into a String holding a URI representation of it.
8795 * The returned URI string has been properly URI encoded, so it can be
8796 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8797 * Intent's data as the base URI, with an additional fragment describing
8798 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008799 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008800 * <p>You can convert the returned string back to an Intent with
8801 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008802 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008803 * @param flags Additional operating flags. Either 0,
8804 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008805 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008806 * @return Returns a URI encoding URI string describing the entire contents
8807 * of the Intent.
8808 */
8809 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008810 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008811 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8812 if (mPackage == null) {
8813 throw new IllegalArgumentException(
8814 "Intent must include an explicit package name to build an android-app: "
8815 + this);
8816 }
8817 uri.append("android-app://");
8818 uri.append(mPackage);
8819 String scheme = null;
8820 if (mData != null) {
8821 scheme = mData.getScheme();
8822 if (scheme != null) {
8823 uri.append('/');
8824 uri.append(scheme);
8825 String authority = mData.getEncodedAuthority();
8826 if (authority != null) {
8827 uri.append('/');
8828 uri.append(authority);
8829 String path = mData.getEncodedPath();
8830 if (path != null) {
8831 uri.append(path);
8832 }
8833 String queryParams = mData.getEncodedQuery();
8834 if (queryParams != null) {
8835 uri.append('?');
8836 uri.append(queryParams);
8837 }
8838 String fragment = mData.getEncodedFragment();
8839 if (fragment != null) {
8840 uri.append('#');
8841 uri.append(fragment);
8842 }
8843 }
8844 }
8845 }
8846 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8847 mPackage, flags);
8848 return uri.toString();
8849 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008850 String scheme = null;
8851 if (mData != null) {
8852 String data = mData.toString();
8853 if ((flags&URI_INTENT_SCHEME) != 0) {
8854 final int N = data.length();
8855 for (int i=0; i<N; i++) {
8856 char c = data.charAt(i);
8857 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8858 || c == '.' || c == '-') {
8859 continue;
8860 }
8861 if (c == ':' && i > 0) {
8862 // Valid scheme.
8863 scheme = data.substring(0, i);
8864 uri.append("intent:");
8865 data = data.substring(i+1);
8866 break;
8867 }
Tom Taylord4a47292009-12-21 13:59:18 -08008868
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008869 // No scheme.
8870 break;
8871 }
8872 }
8873 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008874
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008875 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8876 uri.append("intent:");
8877 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008878
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008879 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008880
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008881 return uri.toString();
8882 }
8883
8884 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8885 String defPackage, int flags) {
8886 StringBuilder frag = new StringBuilder(128);
8887
8888 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008889 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008890 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008891 // Note that for now we are not going to try to handle the
8892 // data part; not clear how to represent this as a URI, and
8893 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008894 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8895 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008896 }
8897
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008898 if (frag.length() > 0) {
8899 uri.append("#Intent;");
8900 uri.append(frag);
8901 uri.append("end");
8902 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008903 }
8904
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008905 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8906 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008907 if (scheme != null) {
8908 uri.append("scheme=").append(scheme).append(';');
8909 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008910 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008911 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008912 }
8913 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008914 for (int i=0; i<mCategories.size(); i++) {
8915 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008916 }
8917 }
8918 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008919 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008920 }
8921 if (mFlags != 0) {
8922 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8923 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008924 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008925 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8926 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008927 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008928 uri.append("component=").append(Uri.encode(
8929 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008930 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008931 if (mSourceBounds != null) {
8932 uri.append("sourceBounds=")
8933 .append(Uri.encode(mSourceBounds.flattenToString()))
8934 .append(';');
8935 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008936 if (mExtras != null) {
8937 for (String key : mExtras.keySet()) {
8938 final Object value = mExtras.get(key);
8939 char entryType =
8940 value instanceof String ? 'S' :
8941 value instanceof Boolean ? 'B' :
8942 value instanceof Byte ? 'b' :
8943 value instanceof Character ? 'c' :
8944 value instanceof Double ? 'd' :
8945 value instanceof Float ? 'f' :
8946 value instanceof Integer ? 'i' :
8947 value instanceof Long ? 'l' :
8948 value instanceof Short ? 's' :
8949 '\0';
8950
8951 if (entryType != '\0') {
8952 uri.append(entryType);
8953 uri.append('.');
8954 uri.append(Uri.encode(key));
8955 uri.append('=');
8956 uri.append(Uri.encode(value.toString()));
8957 uri.append(';');
8958 }
8959 }
8960 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008961 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008963 public int describeContents() {
8964 return (mExtras != null) ? mExtras.describeContents() : 0;
8965 }
8966
8967 public void writeToParcel(Parcel out, int flags) {
8968 out.writeString(mAction);
8969 Uri.writeToParcel(out, mData);
8970 out.writeString(mType);
8971 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008972 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008973 ComponentName.writeToParcel(mComponent, out);
8974
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008975 if (mSourceBounds != null) {
8976 out.writeInt(1);
8977 mSourceBounds.writeToParcel(out, flags);
8978 } else {
8979 out.writeInt(0);
8980 }
8981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008982 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008983 final int N = mCategories.size();
8984 out.writeInt(N);
8985 for (int i=0; i<N; i++) {
8986 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008987 }
8988 } else {
8989 out.writeInt(0);
8990 }
8991
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008992 if (mSelector != null) {
8993 out.writeInt(1);
8994 mSelector.writeToParcel(out, flags);
8995 } else {
8996 out.writeInt(0);
8997 }
8998
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008999 if (mClipData != null) {
9000 out.writeInt(1);
9001 mClipData.writeToParcel(out, flags);
9002 } else {
9003 out.writeInt(0);
9004 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009005 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009006 out.writeBundle(mExtras);
9007 }
9008
9009 public static final Parcelable.Creator<Intent> CREATOR
9010 = new Parcelable.Creator<Intent>() {
9011 public Intent createFromParcel(Parcel in) {
9012 return new Intent(in);
9013 }
9014 public Intent[] newArray(int size) {
9015 return new Intent[size];
9016 }
9017 };
9018
Dianne Hackborneb034652009-09-07 00:49:58 -07009019 /** @hide */
9020 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009021 readFromParcel(in);
9022 }
9023
9024 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009025 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009026 mData = Uri.CREATOR.createFromParcel(in);
9027 mType = in.readString();
9028 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009029 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009030 mComponent = ComponentName.readFromParcel(in);
9031
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009032 if (in.readInt() != 0) {
9033 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9034 }
9035
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009036 int N = in.readInt();
9037 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009038 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009039 int i;
9040 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009041 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009042 }
9043 } else {
9044 mCategories = null;
9045 }
9046
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009047 if (in.readInt() != 0) {
9048 mSelector = new Intent(in);
9049 }
9050
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009051 if (in.readInt() != 0) {
9052 mClipData = new ClipData(in);
9053 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009054 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009055 mExtras = in.readBundle();
9056 }
9057
9058 /**
9059 * Parses the "intent" element (and its children) from XML and instantiates
9060 * an Intent object. The given XML parser should be located at the tag
9061 * where parsing should start (often named "intent"), from which the
9062 * basic action, data, type, and package and class name will be
9063 * retrieved. The function will then parse in to any child elements,
9064 * looking for <category android:name="xxx"> tags to add categories and
9065 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9066 * to the intent.
9067 *
9068 * @param resources The Resources to use when inflating resources.
9069 * @param parser The XML parser pointing at an "intent" tag.
9070 * @param attrs The AttributeSet interface for retrieving extended
9071 * attribute data at the current <var>parser</var> location.
9072 * @return An Intent object matching the XML data.
9073 * @throws XmlPullParserException If there was an XML parsing error.
9074 * @throws IOException If there was an I/O error.
9075 */
9076 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
9077 throws XmlPullParserException, IOException {
9078 Intent intent = new Intent();
9079
9080 TypedArray sa = resources.obtainAttributes(attrs,
9081 com.android.internal.R.styleable.Intent);
9082
9083 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9084
9085 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9086 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9087 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9088
9089 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9090 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9091 if (packageName != null && className != null) {
9092 intent.setComponent(new ComponentName(packageName, className));
9093 }
9094
9095 sa.recycle();
9096
9097 int outerDepth = parser.getDepth();
9098 int type;
9099 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9100 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9101 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9102 continue;
9103 }
9104
9105 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009106 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009107 sa = resources.obtainAttributes(attrs,
9108 com.android.internal.R.styleable.IntentCategory);
9109 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9110 sa.recycle();
9111
9112 if (cat != null) {
9113 intent.addCategory(cat);
9114 }
9115 XmlUtils.skipCurrentTag(parser);
9116
Craig Mautner21d24a22014-04-23 11:45:37 -07009117 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009118 if (intent.mExtras == null) {
9119 intent.mExtras = new Bundle();
9120 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009121 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009122 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009123
9124 } else {
9125 XmlUtils.skipCurrentTag(parser);
9126 }
9127 }
9128
9129 return intent;
9130 }
Nick Pellyccae4122012-01-09 14:12:58 -08009131
Craig Mautner21d24a22014-04-23 11:45:37 -07009132 /** @hide */
9133 public void saveToXml(XmlSerializer out) throws IOException {
9134 if (mAction != null) {
9135 out.attribute(null, ATTR_ACTION, mAction);
9136 }
9137 if (mData != null) {
9138 out.attribute(null, ATTR_DATA, mData.toString());
9139 }
9140 if (mType != null) {
9141 out.attribute(null, ATTR_TYPE, mType);
9142 }
9143 if (mComponent != null) {
9144 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9145 }
9146 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9147
9148 if (mCategories != null) {
9149 out.startTag(null, TAG_CATEGORIES);
9150 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9151 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9152 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009153 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009154 }
9155 }
9156
9157 /** @hide */
9158 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9159 XmlPullParserException {
9160 Intent intent = new Intent();
9161 final int outerDepth = in.getDepth();
9162
9163 int attrCount = in.getAttributeCount();
9164 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9165 final String attrName = in.getAttributeName(attrNdx);
9166 final String attrValue = in.getAttributeValue(attrNdx);
9167 if (ATTR_ACTION.equals(attrName)) {
9168 intent.setAction(attrValue);
9169 } else if (ATTR_DATA.equals(attrName)) {
9170 intent.setData(Uri.parse(attrValue));
9171 } else if (ATTR_TYPE.equals(attrName)) {
9172 intent.setType(attrValue);
9173 } else if (ATTR_COMPONENT.equals(attrName)) {
9174 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9175 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009176 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009177 } else {
9178 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9179 }
9180 }
9181
9182 int event;
9183 String name;
9184 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9185 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9186 if (event == XmlPullParser.START_TAG) {
9187 name = in.getName();
9188 if (TAG_CATEGORIES.equals(name)) {
9189 attrCount = in.getAttributeCount();
9190 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9191 intent.addCategory(in.getAttributeValue(attrNdx));
9192 }
9193 } else {
9194 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9195 XmlUtils.skipCurrentTag(in);
9196 }
9197 }
9198 }
9199
9200 return intent;
9201 }
9202
Nick Pellyccae4122012-01-09 14:12:58 -08009203 /**
9204 * Normalize a MIME data type.
9205 *
9206 * <p>A normalized MIME type has white-space trimmed,
9207 * content-type parameters removed, and is lower-case.
9208 * This aligns the type with Android best practices for
9209 * intent filtering.
9210 *
9211 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9212 * "text/x-vCard" becomes "text/x-vcard".
9213 *
9214 * <p>All MIME types received from outside Android (such as user input,
9215 * or external sources like Bluetooth, NFC, or the Internet) should
9216 * be normalized before they are used to create an Intent.
9217 *
9218 * @param type MIME data type to normalize
9219 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009220 * @see #setType
9221 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009222 */
9223 public static String normalizeMimeType(String type) {
9224 if (type == null) {
9225 return null;
9226 }
9227
Elliott Hughescb64d432013-08-02 10:00:44 -07009228 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009229
9230 final int semicolonIndex = type.indexOf(';');
9231 if (semicolonIndex != -1) {
9232 type = type.substring(0, semicolonIndex);
9233 }
9234 return type;
9235 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009236
9237 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009238 * Prepare this {@link Intent} to leave an app process.
9239 *
9240 * @hide
9241 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009242 public void prepareToLeaveProcess(Context context) {
9243 final boolean leavingPackage = (mComponent == null)
9244 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9245 prepareToLeaveProcess(leavingPackage);
9246 }
9247
9248 /**
9249 * Prepare this {@link Intent} to leave an app process.
9250 *
9251 * @hide
9252 */
9253 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009254 setAllowFds(false);
9255
9256 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009257 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009258 }
9259 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009260 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009261 }
9262
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009263 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9264 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009265 switch (mAction) {
9266 case ACTION_MEDIA_REMOVED:
9267 case ACTION_MEDIA_UNMOUNTED:
9268 case ACTION_MEDIA_CHECKING:
9269 case ACTION_MEDIA_NOFS:
9270 case ACTION_MEDIA_MOUNTED:
9271 case ACTION_MEDIA_SHARED:
9272 case ACTION_MEDIA_UNSHARED:
9273 case ACTION_MEDIA_BAD_REMOVAL:
9274 case ACTION_MEDIA_UNMOUNTABLE:
9275 case ACTION_MEDIA_EJECT:
9276 case ACTION_MEDIA_SCANNER_STARTED:
9277 case ACTION_MEDIA_SCANNER_FINISHED:
9278 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009279 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9280 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009281 // Ignore legacy actions
9282 break;
9283 default:
9284 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009285 }
9286 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009287
9288 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9289 && leavingPackage) {
9290 switch (mAction) {
9291 case ACTION_PROVIDER_CHANGED:
9292 // Ignore actions that don't need to grant
9293 break;
9294 default:
9295 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9296 }
9297 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009298 }
9299
9300 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009301 * @hide
9302 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009303 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009304 // We just entered destination process, so we should be able to read all
9305 // parcelables inside.
9306 setDefusable(true);
9307
9308 if (mSelector != null) {
9309 mSelector.prepareToEnterProcess();
9310 }
9311 if (mClipData != null) {
9312 mClipData.prepareToEnterProcess();
9313 }
9314
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009315 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009316 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9317 fixUris(mContentUserHint);
9318 mContentUserHint = UserHandle.USER_CURRENT;
9319 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009320 }
9321 }
9322
9323 /**
9324 * @hide
9325 */
9326 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009327 Uri data = getData();
9328 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009329 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009330 }
9331 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009332 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009333 }
9334 String action = getAction();
9335 if (ACTION_SEND.equals(action)) {
9336 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9337 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009338 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009339 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009340 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009341 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9342 if (streams != null) {
9343 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9344 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009345 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009346 }
9347 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9348 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009349 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9350 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9351 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9352 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9353 if (output != null) {
9354 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9355 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009356 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009357 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009358
9359 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009360 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009361 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9362 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009363 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009364 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009365 * @hide
9366 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009367 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009368 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009369 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009370
9371 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009372 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009373
9374 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009375 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009376 // Inspect contained intents to see if we need to migrate extras. We
9377 // don't promote ClipData to the parent, since ChooserActivity will
9378 // already start the picked item as the caller, and we can't combine
9379 // the flags in a safe way.
9380
9381 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009382 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009383 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9384 if (intent != null) {
9385 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009386 }
9387 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009388 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009389 try {
9390 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9391 if (intents != null) {
9392 for (int i = 0; i < intents.length; i++) {
9393 final Intent intent = (Intent) intents[i];
9394 if (intent != null) {
9395 migrated |= intent.migrateExtraStreamToClipData();
9396 }
9397 }
9398 }
9399 } catch (ClassCastException e) {
9400 }
9401 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009402
9403 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009404 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009405 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9406 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9407 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9408 if (stream != null || text != null || htmlText != null) {
9409 final ClipData clipData = new ClipData(
9410 null, new String[] { getType() },
9411 new ClipData.Item(text, htmlText, null, stream));
9412 setClipData(clipData);
9413 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009414 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009415 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009416 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009417 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009418
9419 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009420 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009421 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9422 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9423 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9424 int num = -1;
9425 if (streams != null) {
9426 num = streams.size();
9427 }
9428 if (texts != null) {
9429 if (num >= 0 && num != texts.size()) {
9430 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009431 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009432 }
9433 num = texts.size();
9434 }
9435 if (htmlTexts != null) {
9436 if (num >= 0 && num != htmlTexts.size()) {
9437 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009438 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009439 }
9440 num = htmlTexts.size();
9441 }
9442 if (num > 0) {
9443 final ClipData clipData = new ClipData(
9444 null, new String[] { getType() },
9445 makeClipItem(streams, texts, htmlTexts, 0));
9446
9447 for (int i = 1; i < num; i++) {
9448 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9449 }
9450
9451 setClipData(clipData);
9452 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009453 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009454 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009455 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009456 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009457 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9458 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9459 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9460 final Uri output;
9461 try {
9462 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9463 } catch (ClassCastException e) {
9464 return false;
9465 }
9466 if (output != null) {
9467 setClipData(ClipData.newRawUri("", output));
9468 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9469 return true;
9470 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009471 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009472
9473 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009474 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009475
9476 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9477 ArrayList<String> htmlTexts, int which) {
9478 Uri uri = streams != null ? streams.get(which) : null;
9479 CharSequence text = texts != null ? texts.get(which) : null;
9480 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9481 return new ClipData.Item(text, htmlText, null, uri);
9482 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009483
9484 /** @hide */
9485 public boolean isDocument() {
9486 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9487 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009488}