blob: 1ee0bb1cbaf0b5c93e903c07aadf07779ebceff6 [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 =
Clara Bayarri847d8682017-03-06 16:48:44 +00001458 "com.android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001459
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 =
Clara Bayarri847d8682017-03-06 16:48:44 +00001468 "com.android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001469
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 */
2876 public static final String ACTION_PRE_BOOT_COMPLETED =
2877 "android.intent.action.PRE_BOOT_COMPLETED";
2878
Amith Yamasani13593602012-03-22 16:16:17 -07002879 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002880 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002881 * on restricted users. The broadcast intent contains an extra
2882 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2883 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2884 * String[] depending on the restriction type.<p/>
2885 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002886 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2887 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2888 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002889 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2890 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002891 * @see RestrictionEntry
2892 */
2893 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2894 "android.intent.action.GET_RESTRICTION_ENTRIES";
2895
2896 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002897 * Sent the first time a user is starting, to allow system apps to
2898 * perform one time initialization. (This will not be seen by third
2899 * party applications because a newly initialized user does not have any
2900 * third party applications installed for it.) This is sent early in
2901 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002902 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2903 * broadcast, since it is part of a visible user interaction; be as quick
2904 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002905 */
2906 public static final String ACTION_USER_INITIALIZE =
2907 "android.intent.action.USER_INITIALIZE";
2908
2909 /**
2910 * Sent when a user switch is happening, causing the process's user to be
2911 * brought to the foreground. This is only sent to receivers registered
2912 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2913 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002914 * foreground. This is sent as a foreground
2915 * broadcast, since it is part of a visible user interaction; be as quick
2916 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002917 */
2918 public static final String ACTION_USER_FOREGROUND =
2919 "android.intent.action.USER_FOREGROUND";
2920
2921 /**
2922 * Sent when a user switch is happening, causing the process's user to be
2923 * sent to the background. This is only sent to receivers registered
2924 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2925 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002926 * background. This is sent as a foreground
2927 * broadcast, since it is part of a visible user interaction; be as quick
2928 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002929 */
2930 public static final String ACTION_USER_BACKGROUND =
2931 "android.intent.action.USER_BACKGROUND";
2932
2933 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002934 * Broadcast sent to the system when a user is added. Carries an extra
2935 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2936 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002937 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002938 * @hide
2939 */
2940 public static final String ACTION_USER_ADDED =
2941 "android.intent.action.USER_ADDED";
2942
2943 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002944 * Broadcast sent by the system when a user is started. Carries an extra
2945 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002946 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002947 * that has been started. This is sent as a foreground
2948 * broadcast, since it is part of a visible user interaction; be as quick
2949 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002950 * @hide
2951 */
2952 public static final String ACTION_USER_STARTED =
2953 "android.intent.action.USER_STARTED";
2954
2955 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002956 * Broadcast sent when a user is in the process of starting. Carries an extra
2957 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2958 * sent to registered receivers, not manifest receivers. It is sent to all
2959 * users (including the one that is being started). You must hold
2960 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2961 * this broadcast. This is sent as a background broadcast, since
2962 * its result is not part of the primary UX flow; to safely keep track of
2963 * started/stopped state of a user you can use this in conjunction with
2964 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2965 * other user state broadcasts since those are foreground broadcasts so can
2966 * execute in a different order.
2967 * @hide
2968 */
2969 public static final String ACTION_USER_STARTING =
2970 "android.intent.action.USER_STARTING";
2971
2972 /**
2973 * Broadcast sent when a user is going to be stopped. Carries an extra
2974 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2975 * sent to registered receivers, not manifest receivers. It is sent to all
2976 * users (including the one that is being stopped). You must hold
2977 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2978 * this broadcast. The user will not stop until all receivers have
2979 * handled the broadcast. This is sent as a background broadcast, since
2980 * its result is not part of the primary UX flow; to safely keep track of
2981 * started/stopped state of a user you can use this in conjunction with
2982 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2983 * other user state broadcasts since those are foreground broadcasts so can
2984 * execute in a different order.
2985 * @hide
2986 */
2987 public static final String ACTION_USER_STOPPING =
2988 "android.intent.action.USER_STOPPING";
2989
2990 /**
2991 * Broadcast sent to the system when a user is stopped. Carries an extra
2992 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2993 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2994 * specific package. This is only sent to registered receivers, not manifest
2995 * receivers. It is sent to all running users <em>except</em> the one that
2996 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002997 * @hide
2998 */
2999 public static final String ACTION_USER_STOPPED =
3000 "android.intent.action.USER_STOPPED";
3001
3002 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003003 * 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 -07003004 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003005 * one that has been removed. The user will not be completely removed until all receivers have
3006 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003007 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003008 * @hide
3009 */
3010 public static final String ACTION_USER_REMOVED =
3011 "android.intent.action.USER_REMOVED";
3012
3013 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003014 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003015 * the userHandle of the user to become the current one. This is only sent to
3016 * registered receivers, not manifest receivers. It is sent to all running users.
3017 * You must hold
3018 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003019 * @hide
3020 */
3021 public static final String ACTION_USER_SWITCHED =
3022 "android.intent.action.USER_SWITCHED";
3023
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003024 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003025 * Broadcast Action: Sent when the credential-encrypted private storage has
3026 * become unlocked for the target user. This is only sent to registered
3027 * receivers, not manifest receivers.
3028 */
3029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3030 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3031
3032 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003033 * Broadcast sent to the system when a user's information changes. Carries an extra
3034 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003035 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003036 * @hide
3037 */
3038 public static final String ACTION_USER_INFO_CHANGED =
3039 "android.intent.action.USER_INFO_CHANGED";
3040
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003041 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003042 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3043 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003044 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3045 * that need to display merged content across both primary and managed profiles need to
3046 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003047 * not manifest receivers.
3048 */
3049 public static final String ACTION_MANAGED_PROFILE_ADDED =
3050 "android.intent.action.MANAGED_PROFILE_ADDED";
3051
3052 /**
3053 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003054 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3055 * Only applications (for example Launchers) that need to display merged content across both
3056 * primary and managed profiles need to worry about this broadcast. This is only sent to
3057 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003058 */
3059 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3060 "android.intent.action.MANAGED_PROFILE_REMOVED";
3061
3062 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003063 * Broadcast sent to the primary user when the credential-encrypted private storage for
3064 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3065 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3066 * Launchers) that need to display merged content across both primary and managed profiles
3067 * need to worry about this broadcast. This is only sent to registered receivers,
3068 * not manifest receivers.
3069 */
3070 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3071 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3072
3073 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003074 * Broadcast sent to the primary user when an associated managed profile has become available.
3075 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003076 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3077 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3078 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003079 */
Rubin Xue95057a2016-04-01 16:49:25 +01003080 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3081 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3082
3083 /**
3084 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3085 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3086 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3087 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3088 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3089 */
3090 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3091 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003092
3093 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003094 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3095 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3096 * the device was locked or unlocked.
3097 *
3098 * This is only sent to registered receivers.
3099 *
3100 * @hide
3101 */
3102 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3103 "android.intent.action.DEVICE_LOCKED_CHANGED";
3104
3105 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003106 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3107 */
3108 public static final String ACTION_QUICK_CLOCK =
3109 "android.intent.action.QUICK_CLOCK";
3110
Michael Wright0087a142013-02-05 16:29:39 -08003111 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003112 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003113 * @hide
3114 */
3115 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
Clara Bayarri847d8682017-03-06 16:48:44 +00003116 "com.android.intent.action.SHOW_BRIGHTNESS_DIALOG";
Michael Wright0087a142013-02-05 16:29:39 -08003117
Justin Kohd378ad72013-04-01 12:18:26 -07003118 /**
3119 * Broadcast Action: A global button was pressed. Includes a single
3120 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3121 * caused the broadcast.
3122 * @hide
3123 */
3124 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3125
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003126 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003127 * Broadcast Action: Sent when media resource is granted.
3128 * <p>
3129 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3130 * granted.
3131 * </p>
3132 * <p class="note">
3133 * This is a protected intent that can only be sent by the system.
3134 * </p>
3135 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003136 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003137 * </p>
3138 *
3139 * @hide
3140 */
3141 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3142 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3143
3144 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003145 * Broadcast Action: An overlay package has been installed. The data
3146 * contains the name of the added overlay package.
3147 * @hide
3148 */
3149 public static final String ACTION_OVERLAY_ADDED = "android.intent.action.OVERLAY_ADDED";
3150
3151 /**
3152 * Broadcast Action: An overlay package has changed. The data contains the
3153 * name of the overlay package which has changed. This is broadcast on all
3154 * changes to the OverlayInfo returned by {@link
3155 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3156 * most common change is a state change that will change whether the
3157 * overlay is enabled or not.
3158 * @hide
3159 */
3160 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3161
3162 /**
3163 * Broadcast Action: An overlay package has been removed. The data contains
3164 * the name of the overlay package which has been removed.
3165 * @hide
3166 */
3167 public static final String ACTION_OVERLAY_REMOVED = "android.intent.action.OVERLAY_REMOVED";
3168
3169 /**
3170 * Broadcast Action: The order of a package's list of overlay packages has
3171 * changed. The data contains the package name of the overlay package that
3172 * had its position in the list adjusted.
3173 * @hide
3174 */
3175 public static final String
3176 ACTION_OVERLAY_PRIORITY_CHANGED = "android.intent.action.OVERLAY_PRIORITY_CHANGED";
3177
3178 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003179 * Activity Action: Allow the user to select and return one or more existing
3180 * documents. When invoked, the system will display the various
3181 * {@link DocumentsProvider} instances installed on the device, letting the
3182 * user interactively navigate through them. These documents include local
3183 * media, such as photos and video, and documents provided by installed
3184 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003185 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003186 * Each document is represented as a {@code content://} URI backed by a
3187 * {@link DocumentsProvider}, which can be opened as a stream with
3188 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3189 * {@link android.provider.DocumentsContract.Document} metadata.
3190 * <p>
3191 * All selected documents are returned to the calling application with
3192 * persistable read and write permission grants. If you want to maintain
3193 * access to the documents across device reboots, you need to explicitly
3194 * take the persistable permissions using
3195 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3196 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003197 * Callers must indicate the acceptable document MIME types through
3198 * {@link #setType(String)}. For example, to select photos, use
3199 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3200 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3201 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003202 * <p>
3203 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003204 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3205 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003206 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003207 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3208 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003209 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003210 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003211 * Callers can set a document URI through
3212 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3213 * location of documents navigator. System will do its best to launch the
3214 * navigator in the specified document if it's a folder, or the folder that
3215 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003216 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003217 * Output: The URI of the item that was picked, returned in
3218 * {@link #getData()}. This must be a {@code content://} URI so that any
3219 * receiver can access it. If multiple documents were selected, they are
3220 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003221 *
3222 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003223 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003224 * @see #ACTION_CREATE_DOCUMENT
3225 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003226 */
3227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3228 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3229
3230 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003231 * Activity Action: Allow the user to create a new document. When invoked,
3232 * the system will display the various {@link DocumentsProvider} instances
3233 * installed on the device, letting the user navigate through them. The
3234 * returned document may be a newly created document with no content, or it
3235 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003236 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003237 * Each document is represented as a {@code content://} URI backed by a
3238 * {@link DocumentsProvider}, which can be opened as a stream with
3239 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3240 * {@link android.provider.DocumentsContract.Document} metadata.
3241 * <p>
3242 * Callers must indicate the concrete MIME type of the document being
3243 * created by setting {@link #setType(String)}. This MIME type cannot be
3244 * changed after the document is created.
3245 * <p>
3246 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3247 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003248 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003249 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3250 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003251 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003252 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003253 * Callers can set a document URI through
3254 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3255 * location of documents navigator. System will do its best to launch the
3256 * navigator in the specified document if it's a folder, or the folder that
3257 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003258 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003259 * Output: The URI of the item that was created. This must be a
3260 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003261 *
3262 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003263 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003264 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003265 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003266 */
3267 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3268 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3269
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003270 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003271 * Activity Action: Allow the user to pick a directory subtree. When
3272 * invoked, the system will display the various {@link DocumentsProvider}
3273 * instances installed on the device, letting the user navigate through
3274 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003275 * <p>
3276 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003277 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3278 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3279 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003280 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003281 * Callers can set a document URI through
3282 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3283 * location of documents navigator. System will do its best to launch the
3284 * navigator in the specified document if it's a folder, or the folder that
3285 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003286 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003287 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003288 *
3289 * @see DocumentsContract
3290 */
3291 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003292 public static final String
3293 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003294
Felipe Lemec7b1f892016-01-15 15:02:31 -08003295 /**
Peng Xua35b5532016-01-20 00:05:45 -08003296 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3297 * exisiting sensor being disconnected.
3298 *
3299 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3300 *
3301 * {@hide}
3302 */
3303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3304 public static final String
3305 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3306
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003307 /**
3308 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3309 *
3310 * {@hide}
3311 */
3312 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003313 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3314
Christopher Tate6597e342015-02-17 12:15:25 -08003315 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003316 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3317 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3318 *
3319 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3320 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003321 * @hide
3322 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003323 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003324 public static final String EXTRA_FORCE_MASTER_CLEAR =
3325 "android.intent.extra.FORCE_MASTER_CLEAR";
3326
3327 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003328 * A broadcast action to trigger a factory reset.
3329 *
3330 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3331 *
3332 * <p>Not for use by third-party applications.
3333 *
3334 * @see #EXTRA_FORCE_MASTER_CLEAR
3335 *
3336 * {@hide}
3337 */
3338 @SystemApi
3339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3340 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3341
3342 /**
3343 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3344 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3345 *
3346 * <p>Not for use by third-party applications.
3347 *
3348 * @hide
3349 */
3350 @SystemApi
3351 public static final String EXTRA_FORCE_FACTORY_RESET =
3352 "android.intent.extra.FORCE_FACTORY_RESET";
3353
3354 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003355 * Broadcast action: report that a settings element is being restored from backup. The intent
3356 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3357 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3358 * is the value of that settings entry prior to the restore operation. All of these values are
3359 * represented as strings.
3360 *
3361 * <p>This broadcast is sent only for settings provider entries known to require special handling
3362 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3363 * the provider's backup agent implementation.
3364 *
3365 * @see #EXTRA_SETTING_NAME
3366 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3367 * @see #EXTRA_SETTING_NEW_VALUE
3368 * {@hide}
3369 */
3370 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3371
3372 /** {@hide} */
3373 public static final String EXTRA_SETTING_NAME = "setting_name";
3374 /** {@hide} */
3375 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3376 /** {@hide} */
3377 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3378
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003379 /**
3380 * Activity Action: Process a piece of text.
3381 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3382 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3383 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3384 */
3385 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3386 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3387 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003388 * The name of the extra used to define the text to be processed, as a
3389 * CharSequence. Note that this may be a styled CharSequence, so you must use
3390 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003391 */
3392 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3393 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003394 * 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 +00003395 */
3396 public static final String EXTRA_PROCESS_TEXT_READONLY =
3397 "android.intent.extra.PROCESS_TEXT_READONLY";
3398
Bryce Leebc58f592015-09-25 16:43:01 -07003399 /**
3400 * Broadcast action: reports when a new thermal event has been reached. When the device
3401 * is reaching its maximum temperatue, the thermal level reported
3402 * {@hide}
3403 */
3404 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3405 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3406
3407 /** {@hide} */
3408 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3409
3410 /**
3411 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003412 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003413 * {@hide}
3414 */
3415 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3416
3417 /**
3418 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003419 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003420 * {@hide}
3421 */
3422 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3423
3424 /**
3425 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003426 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003427 * {@hide}
3428 */
3429 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3430
3431
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003432 // ---------------------------------------------------------------------
3433 // ---------------------------------------------------------------------
3434 // Standard intent categories (see addCategory()).
3435
3436 /**
3437 * Set if the activity should be an option for the default action
3438 * (center press) to perform on a piece of data. Setting this will
3439 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003440 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441 * Intent when initiating an action -- it is for use in intent filters
3442 * specified in packages.
3443 */
3444 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3445 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3446 /**
3447 * Activities that can be safely invoked from a browser must support this
3448 * category. For example, if the user is viewing a web page or an e-mail
3449 * and clicks on a link in the text, the Intent generated execute that
3450 * link will require the BROWSABLE category, so that only activities
3451 * supporting this category will be considered as possible actions. By
3452 * supporting this category, you are promising that there is nothing
3453 * damaging (without user intervention) that can happen by invoking any
3454 * matching Intent.
3455 */
3456 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3457 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3458 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003459 * Categories for activities that can participate in voice interaction.
3460 * An activity that supports this category must be prepared to run with
3461 * no UI shown at all (though in some case it may have a UI shown), and
3462 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3463 */
3464 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3465 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3466 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003467 * Set if the activity should be considered as an alternative action to
3468 * the data the user is currently viewing. See also
3469 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3470 * applies to the selection in a list of items.
3471 *
3472 * <p>Supporting this category means that you would like your activity to be
3473 * displayed in the set of alternative things the user can do, usually as
3474 * part of the current activity's options menu. You will usually want to
3475 * include a specific label in the &lt;intent-filter&gt; of this action
3476 * describing to the user what it does.
3477 *
3478 * <p>The action of IntentFilter with this category is important in that it
3479 * describes the specific action the target will perform. This generally
3480 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3481 * a specific name such as "com.android.camera.action.CROP. Only one
3482 * alternative of any particular action will be shown to the user, so using
3483 * a specific action like this makes sure that your alternative will be
3484 * displayed while also allowing other applications to provide their own
3485 * overrides of that particular action.
3486 */
3487 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3488 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3489 /**
3490 * Set if the activity should be considered as an alternative selection
3491 * action to the data the user has currently selected. This is like
3492 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3493 * of items from which the user can select, giving them alternatives to the
3494 * default action that will be performed on it.
3495 */
3496 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3497 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3498 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003499 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003500 */
3501 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3502 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3503 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003504 * Should be displayed in the top-level launcher.
3505 */
3506 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3507 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3508 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003509 * Indicates an activity optimized for Leanback mode, and that should
3510 * be displayed in the Leanback launcher.
3511 */
3512 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3513 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3514 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003515 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3516 * @hide
3517 */
3518 @SystemApi
3519 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3520 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003521 * Provides information about the package it is in; typically used if
3522 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3523 * a front-door to the user without having to be shown in the all apps list.
3524 */
3525 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3526 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3527 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003528 * This is the home activity, that is the first activity that is displayed
3529 * when the device boots.
3530 */
3531 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3532 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3533 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003534 * This is the home activity that is displayed when the device is finished setting up and ready
3535 * for use.
3536 * @hide
3537 */
3538 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3539 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3540 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003541 * This is the setup wizard activity, that is the first activity that is displayed
3542 * when the user sets up the device for the first time.
3543 * @hide
3544 */
3545 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3546 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3547 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003548 * This activity is a preference panel.
3549 */
3550 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3551 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3552 /**
3553 * This activity is a development preference panel.
3554 */
3555 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3556 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3557 /**
3558 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003559 */
3560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3561 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3562 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003563 * This activity allows the user to browse and download new applications.
3564 */
3565 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3566 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003568 * This activity may be exercised by the monkey or other automated test tools.
3569 */
3570 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3571 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3572 /**
3573 * To be used as a test (not part of the normal user experience).
3574 */
3575 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3576 /**
3577 * To be used as a unit test (run through the Test Harness).
3578 */
3579 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3580 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003581 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003582 * experience).
3583 */
3584 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003585
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003586 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003587 * Used to indicate that an intent only wants URIs that can be opened with
3588 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3589 * must support at least the columns defined in {@link OpenableColumns} when
3590 * queried.
3591 *
3592 * @see #ACTION_GET_CONTENT
3593 * @see #ACTION_OPEN_DOCUMENT
3594 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003595 */
3596 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3597 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3598
3599 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003600 * Used to indicate that an intent filter can accept files which are not necessarily
3601 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3602 * at least streamable via
3603 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3604 * using one of the stream types exposed via
3605 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3606 *
3607 * @see #ACTION_SEND
3608 * @see #ACTION_SEND_MULTIPLE
3609 */
3610 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3611 public static final String CATEGORY_TYPED_OPENABLE =
3612 "android.intent.category.TYPED_OPENABLE";
3613
3614 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003615 * To be used as code under test for framework instrumentation tests.
3616 */
3617 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3618 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003619 /**
3620 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003621 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3622 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003623 */
3624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3625 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3626 /**
3627 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003628 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3629 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003630 */
3631 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3632 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003633 /**
3634 * An activity to run when device is inserted into a analog (low end) dock.
3635 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3636 * information, see {@link android.app.UiModeManager}.
3637 */
3638 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3639 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3640
3641 /**
3642 * An activity to run when device is inserted into a digital (high end) dock.
3643 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3644 * information, see {@link android.app.UiModeManager}.
3645 */
3646 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3647 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003648
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003649 /**
3650 * Used to indicate that the activity can be used in a car environment.
3651 */
3652 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3653 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3654
Zak Cohendb6ca492017-01-26 14:09:00 -08003655 /**
3656 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
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_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003662 // ---------------------------------------------------------------------
3663 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003664 // Application launch intent categories (see addCategory()).
3665
3666 /**
3667 * Used with {@link #ACTION_MAIN} to launch the browser application.
3668 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003669 * <p>NOTE: This should not be used as the primary key of an Intent,
3670 * since it will not result in the app launching with the correct
3671 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003672 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003673 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003674 */
3675 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3676 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3677
3678 /**
3679 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3680 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003681 * <p>NOTE: This should not be used as the primary key of an Intent,
3682 * since it will not result in the app launching with the correct
3683 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003684 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003685 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003686 */
3687 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3688 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3689
3690 /**
3691 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3692 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003693 * <p>NOTE: This should not be used as the primary key of an Intent,
3694 * since it will not result in the app launching with the correct
3695 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003696 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003697 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003698 */
3699 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3700 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3701
3702 /**
3703 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3704 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003705 * <p>NOTE: This should not be used as the primary key of an Intent,
3706 * since it will not result in the app launching with the correct
3707 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003708 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003709 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003710 */
3711 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3712 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3713
3714 /**
3715 * Used with {@link #ACTION_MAIN} to launch the email application.
3716 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003717 * <p>NOTE: This should not be used as the primary key of an Intent,
3718 * since it will not result in the app launching with the correct
3719 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003720 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003721 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003722 */
3723 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3724 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3725
3726 /**
3727 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3728 * The activity should be able to view and manipulate image and video files
3729 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003730 * <p>NOTE: This should not be used as the primary key of an Intent,
3731 * since it will not result in the app launching with the correct
3732 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003733 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003734 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003735 */
3736 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3737 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3738
3739 /**
3740 * Used with {@link #ACTION_MAIN} to launch the maps application.
3741 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003742 * <p>NOTE: This should not be used as the primary key of an Intent,
3743 * since it will not result in the app launching with the correct
3744 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003745 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003746 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003747 */
3748 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3749 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3750
3751 /**
3752 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3753 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003754 * <p>NOTE: This should not be used as the primary key of an Intent,
3755 * since it will not result in the app launching with the correct
3756 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003757 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003758 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003759 */
3760 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3761 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3762
3763 /**
3764 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003765 * The activity should be able to play, browse, or manipulate music files
3766 * stored on the device.
3767 * <p>NOTE: This should not be used as the primary key of an Intent,
3768 * since it will not result in the app launching with the correct
3769 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003770 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003771 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003772 */
3773 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3774 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3775
3776 // ---------------------------------------------------------------------
3777 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003778 // Standard extra data keys.
3779
3780 /**
3781 * The initial data to place in a newly created record. Use with
3782 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3783 * fields as would be given to the underlying ContentProvider.insert()
3784 * call.
3785 */
3786 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3787
3788 /**
3789 * A constant CharSequence that is associated with the Intent, used with
3790 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3791 * this may be a styled CharSequence, so you must use
3792 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3793 * retrieve it.
3794 */
3795 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3796
3797 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003798 * A constant String that is associated with the Intent, used with
3799 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3800 * as HTML formatted text. Note that you <em>must</em> also supply
3801 * {@link #EXTRA_TEXT}.
3802 */
3803 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3804
3805 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003806 * A content: URI holding a stream of data associated with the Intent,
3807 * used with {@link #ACTION_SEND} to supply the data being sent.
3808 */
3809 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3810
3811 /**
3812 * A String[] holding e-mail addresses that should be delivered to.
3813 */
3814 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3815
3816 /**
3817 * A String[] holding e-mail addresses that should be carbon copied.
3818 */
3819 public static final String EXTRA_CC = "android.intent.extra.CC";
3820
3821 /**
3822 * A String[] holding e-mail addresses that should be blind carbon copied.
3823 */
3824 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3825
3826 /**
3827 * A constant string holding the desired subject line of a message.
3828 */
3829 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3830
3831 /**
3832 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003833 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003834 */
3835 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3836
3837 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003838 * An int representing the user id to be used.
3839 *
3840 * @hide
3841 */
3842 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3843
3844 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003845 * An int representing the task id to be retrieved. This is used when a launch from recents is
3846 * intercepted by another action such as credentials confirmation to remember which task should
3847 * be resumed when complete.
3848 *
3849 * @hide
3850 */
3851 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3852
3853 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003854 * An Intent[] describing additional, alternate choices you would like shown with
3855 * {@link #ACTION_CHOOSER}.
3856 *
3857 * <p>An app may be capable of providing several different payload types to complete a
3858 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3859 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3860 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3861 * photo data or a hosted link where the photos can be viewed.</p>
3862 *
3863 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3864 * first/primary/preferred intent in the set. Additional intents specified in
3865 * this extra are ordered; by default intents that appear earlier in the array will be
3866 * preferred over intents that appear later in the array as matches for the same
3867 * target component. To alter this preference, a calling app may also supply
3868 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3869 */
3870 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3871
3872 /**
Adam Powell52c39212016-04-07 15:14:18 -07003873 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3874 * and omitted from a list of components presented to the user.
3875 *
3876 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3877 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3878 * from your own package or other apps from your organization if the idea of sending to those
3879 * targets would be redundant with other app functionality. Filtered components will not
3880 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3881 */
3882 public static final String EXTRA_EXCLUDE_COMPONENTS
3883 = "android.intent.extra.EXCLUDE_COMPONENTS";
3884
3885 /**
3886 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3887 * describing additional high-priority deep-link targets for the chooser to present to the user.
3888 *
3889 * <p>Targets provided in this way will be presented inline with all other targets provided
3890 * by services from other apps. They will be prioritized before other service targets, but
3891 * after those targets provided by sources that the user has manually pinned to the front.</p>
3892 *
3893 * @see #ACTION_CHOOSER
3894 */
3895 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3896
3897 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003898 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3899 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3900 *
3901 * <p>An app preparing an action for another app to complete may wish to allow the user to
3902 * disambiguate between several options for completing the action based on the chosen target
3903 * or otherwise refine the action before it is invoked.
3904 * </p>
3905 *
3906 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3907 * <ul>
3908 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3909 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3910 * chosen target beyond the first</li>
3911 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3912 * should fill in and send once the disambiguation is complete</li>
3913 * </ul>
3914 */
3915 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3916 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3917
3918 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08003919 * An {@code ArrayList} of {@code String} annotations describing content for
3920 * {@link #ACTION_CHOOSER}.
3921 *
3922 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
3923 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
3924 *
3925 * <p>Annotations should describe the major components or topics of the content. It is up to
3926 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
3927 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
3928 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
3929 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
3930 * use the following annotations when applicable:</p>
3931 * <ul>
3932 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
3933 * health & beauty, and office supplies.</li>
3934 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
3935 * happy, and sad.</li>
3936 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
3937 * face, finger, standing, and walking.</li>
3938 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
3939 * child, and baby.</li>
3940 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
3941 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
3942 * <li>"party": represents that the topic of the content is mainly about parties.</li>
3943 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
3944 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
3945 * flowers.</li>
3946 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
3947 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
3948 * sunglasses, jewelry, handbags and clothing.</li>
3949 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
3950 * paper, and silk.</li>
3951 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
3952 * cars, and boats.</li>
3953 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
3954 * posters.</li>
3955 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
3956 * and designs of houses.</li>
3957 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
3958 * Christmas and Thanksgiving.</li>
3959 * </ul>
3960 */
3961 public static final String EXTRA_CONTENT_ANNOTATIONS
3962 = "android.intent.extra.CONTENT_ANNOTATIONS";
3963
3964 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003965 * A {@link ResultReceiver} used to return data back to the sender.
3966 *
3967 * <p>Used to complete an app-specific
3968 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3969 *
3970 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3971 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3972 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3973 * when the user selects a target component from the chooser. It is up to the recipient
3974 * to send a result to this ResultReceiver to signal that disambiguation is complete
3975 * and that the chooser should invoke the user's choice.</p>
3976 *
3977 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3978 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3979 * to match and fill in the final Intent or ChooserTarget before starting it.
3980 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3981 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3982 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3983 *
3984 * <p>The result code passed to the ResultReceiver should be
3985 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3986 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3987 * the chooser should finish without starting a target.</p>
3988 */
3989 public static final String EXTRA_RESULT_RECEIVER
3990 = "android.intent.extra.RESULT_RECEIVER";
3991
3992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003993 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003994 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003995 */
3996 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3997
3998 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003999 * A Parcelable[] of {@link Intent} or
4000 * {@link android.content.pm.LabeledIntent} objects as set with
4001 * {@link #putExtra(String, Parcelable[])} of additional activities to place
4002 * a the front of the list of choices, when shown to the user with a
4003 * {@link #ACTION_CHOOSER}.
4004 */
4005 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
4006
4007 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004008 * A {@link IntentSender} to start after ephemeral installation success.
4009 * @hide
4010 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004011 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4012
4013 /**
4014 * A {@link IntentSender} to start after ephemeral installation failure.
4015 * @hide
4016 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004017 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4018
4019 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004020 * The host name that triggered an ephemeral resolution.
4021 * @hide
4022 */
4023 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4024
4025 /**
4026 * An opaque token to track ephemeral resolution.
4027 * @hide
4028 */
4029 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4030
4031 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004032 * The version code of the app to install components from.
4033 * @hide
4034 */
4035 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4036
4037 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004038 * A Bundle forming a mapping of potential target package names to different extras Bundles
4039 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4040 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4041 * be currently installed on the device.
4042 *
4043 * <p>An application may choose to provide alternate extras for the case where a user
4044 * selects an activity from a predetermined set of target packages. If the activity
4045 * the user selects from the chooser belongs to a package with its package name as
4046 * a key in this bundle, the corresponding extras for that package will be merged with
4047 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4048 * extra has the same key as an extra already present in the intent it will overwrite
4049 * the extra from the intent.</p>
4050 *
4051 * <p><em>Examples:</em>
4052 * <ul>
4053 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4054 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4055 * parameters for that target.</li>
4056 * <li>An application may offer additional metadata for known targets of a given intent
4057 * to pass along information only relevant to that target such as account or content
4058 * identifiers already known to that application.</li>
4059 * </ul></p>
4060 */
4061 public static final String EXTRA_REPLACEMENT_EXTRAS =
4062 "android.intent.extra.REPLACEMENT_EXTRAS";
4063
4064 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004065 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4066 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4067 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4068 * {@link ComponentName} of the chosen component.
4069 *
4070 * <p>In some situations this callback may never come, for example if the user abandons
4071 * the chooser, switches to another task or any number of other reasons. Apps should not
4072 * be written assuming that this callback will always occur.</p>
4073 */
4074 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4075 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4076
4077 /**
4078 * The {@link ComponentName} chosen by the user to complete an action.
4079 *
4080 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4081 */
4082 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4083
4084 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004085 * A {@link android.view.KeyEvent} object containing the event that
4086 * triggered the creation of the Intent it is in.
4087 */
4088 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4089
4090 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004091 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4092 * before shutting down.
4093 *
4094 * {@hide}
4095 */
4096 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4097
4098 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004099 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4100 * requested by the user.
4101 *
4102 * {@hide}
4103 */
4104 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4105 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4106
4107 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004108 * 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 -07004109 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4110 * of restarting the application.
4111 */
4112 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4113
4114 /**
4115 * A String holding the phone number originally entered in
4116 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4117 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4118 */
4119 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004120
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004121 /**
4122 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4123 * intents to supply the uid the package had been assigned. Also an optional
4124 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4125 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4126 * purpose.
4127 */
4128 public static final String EXTRA_UID = "android.intent.extra.UID";
4129
4130 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004131 * @hide String array of package names.
4132 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004133 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004134 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4135
4136 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004137 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4138 * intents to indicate whether this represents a full uninstall (removing
4139 * both the code and its data) or a partial uninstall (leaving its data,
4140 * implying that this is an update).
4141 */
4142 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004143
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004144 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004145 * @hide
4146 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4147 * intents to indicate that at this point the package has been removed for
4148 * all users on the device.
4149 */
4150 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4151 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4152
4153 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004154 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4155 * intents to indicate that this is a replacement of the package, so this
4156 * broadcast will immediately be followed by an add broadcast for a
4157 * different version of the same package.
4158 */
4159 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004160
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004161 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004162 * Used as an int extra field in {@link android.app.AlarmManager} intents
4163 * to tell the application being invoked how many pending alarms are being
4164 * delievered with the intent. For one-shot alarms this will always be 1.
4165 * For recurring alarms, this might be greater than 1 if the device was
4166 * asleep or powered off at the time an earlier alarm would have been
4167 * delivered.
4168 */
4169 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004170
Jacek Surazski86b6c532009-05-13 14:38:28 +02004171 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004172 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4173 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004174 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4175 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004176 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4177 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4178 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004179 */
4180 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4181
4182 /**
4183 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4184 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004185 */
4186 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4187
4188 /**
4189 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4190 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004191 */
4192 public static final int EXTRA_DOCK_STATE_DESK = 1;
4193
4194 /**
4195 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4196 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004197 */
4198 public static final int EXTRA_DOCK_STATE_CAR = 2;
4199
4200 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004201 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4202 * to represent that the phone is in a analog (low end) dock.
4203 */
4204 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4205
4206 /**
4207 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4208 * to represent that the phone is in a digital (high end) dock.
4209 */
4210 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4211
4212 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004213 * Boolean that can be supplied as meta-data with a dock activity, to
4214 * indicate that the dock should take over the home key when it is active.
4215 */
4216 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004217
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004218 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004219 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4220 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004221 */
4222 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4223
4224 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004225 * Used in the extra field in the remote intent. It's astring token passed with the
4226 * remote intent.
4227 */
4228 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4229 "android.intent.extra.remote_intent_token";
4230
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004231 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004232 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004233 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004234 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004235 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004236 "android.intent.extra.changed_component_name";
4237
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004238 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004239 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004240 * and contains a string array of all of the components that have changed. If
4241 * the state of the overall package has changed, then it will contain an entry
4242 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004243 */
4244 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4245 "android.intent.extra.changed_component_name_list";
4246
4247 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004248 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004249 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004250 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4251 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4252 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004253 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004254 */
4255 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4256 "android.intent.extra.changed_package_list";
4257
4258 /**
4259 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004260 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4261 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004262 * and contains an integer array of uids of all of the components
4263 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004264 */
4265 public static final String EXTRA_CHANGED_UID_LIST =
4266 "android.intent.extra.changed_uid_list";
4267
4268 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004269 * @hide
4270 * Magic extra system code can use when binding, to give a label for
4271 * who it is that has bound to a service. This is an integer giving
4272 * a framework string resource that can be displayed to the user.
4273 */
4274 public static final String EXTRA_CLIENT_LABEL =
4275 "android.intent.extra.client_label";
4276
4277 /**
4278 * @hide
4279 * Magic extra system code can use when binding, to give a PendingIntent object
4280 * that can be launched for the user to disable the system's use of this
4281 * service.
4282 */
4283 public static final String EXTRA_CLIENT_INTENT =
4284 "android.intent.extra.client_intent";
4285
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004286 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004287 * Extra used to indicate that an intent should only return data that is on
4288 * the local device. This is a boolean extra; the default is false. If true,
4289 * an implementation should only allow the user to select data that is
4290 * already on the device, not requiring it be downloaded from a remote
4291 * service when opened.
4292 *
4293 * @see #ACTION_GET_CONTENT
4294 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004295 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004296 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004297 */
4298 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004299 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004300
Amith Yamasani13593602012-03-22 16:16:17 -07004301 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004302 * Extra used to indicate that an intent can allow the user to select and
4303 * return multiple items. This is a boolean extra; the default is false. If
4304 * true, an implementation is allowed to present the user with a UI where
4305 * they can pick multiple items that are all returned to the caller. When
4306 * this happens, they should be returned as the {@link #getClipData()} part
4307 * of the result Intent.
4308 *
4309 * @see #ACTION_GET_CONTENT
4310 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004311 */
4312 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004313 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004314
4315 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004316 * The integer userHandle carried with broadcast intents related to addition, removal and
4317 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4318 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4319 *
Amith Yamasani13593602012-03-22 16:16:17 -07004320 * @hide
4321 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004322 public static final String EXTRA_USER_HANDLE =
4323 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004324
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004325 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004326 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4327 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4328 */
4329 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004330 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004331
4332 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004333 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004334 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4335 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004336 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004337 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4338
4339 /**
4340 * Extra sent in the intent to the BroadcastReceiver that handles
4341 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4342 * the restrictions as key/value pairs.
4343 */
4344 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4345 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004346
Amith Yamasani86118ba2013-03-28 14:33:16 -07004347 /**
4348 * Extra used in the response from a BroadcastReceiver that handles
4349 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4350 */
4351 public static final String EXTRA_RESTRICTIONS_INTENT =
4352 "android.intent.extra.restrictions_intent";
4353
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004354 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004355 * Extra used to communicate a set of acceptable MIME types. The type of the
4356 * extra is {@code String[]}. Values may be a combination of concrete MIME
4357 * types (such as "image/png") and/or partial MIME types (such as
4358 * "audio/*").
4359 *
4360 * @see #ACTION_GET_CONTENT
4361 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004362 */
4363 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4364
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004365 /**
4366 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4367 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004368 * When this is true, hardware devices can use this information to determine that
4369 * they shouldn't do a complete shutdown of their device since this is not a
4370 * complete shutdown down to the kernel, but only user space restarting.
4371 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004372 */
4373 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4374 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4375
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004376 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004377 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4378 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4379 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4380 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004381 *
4382 * @hide for internal use only.
4383 */
4384 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4385 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004386 /** @hide */
4387 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4388 /** @hide */
4389 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4390 /** @hide */
4391 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004392
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004393 /** {@hide} */
4394 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4395
Rubin Xue8490f12015-06-25 12:17:48 +01004396 /** {@hide} */
4397 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4398
Santos Cordon15a13782015-03-31 18:32:31 -07004399 /**
4400 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4401 * activation request.
4402 * TODO: Add information about the structure and response data used with the pending intent.
4403 * @hide
4404 */
4405 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4406 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4407
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004408 /**
4409 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004410 *
4411 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004412 * @see ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004413 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004414 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4415
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004416 /**
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004417 * Tells the quick viewer to show additional UI actions suitable for the passed Uris,
4418 * such as opening in other apps, sharing, opening, editing, printing, deleting,
4419 * casting, etc.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004420 *
4421 * <p>The value is boolean. By default false.
4422 * @see ACTION_QUICK_VIEW
4423 */
Tomasz Mikolajewski17c50da2017-02-16 14:38:04 +09004424 public static final String EXTRA_QUICK_VIEW_ADVANCED =
4425 "android.intent.extra.QUICK_VIEW_ADVANCED";
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004426
4427 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004428 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004429 * When a profile goes into quiet mode, all apps in the profile are killed and the
4430 * profile user is stopped. Widgets originating from the profile are masked, and app
4431 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004432 */
4433 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004434
4435 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004436 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004437 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004438 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4439 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004440 *
4441 * @hide
4442 */
4443 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4444 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4445
4446 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004447 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4448 * whether to show the chooser or not when there is only one application available
4449 * to choose from.
4450 *
4451 * @hide
4452 */
4453 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4454 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4455
4456 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004457 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004458 * to represent that a video codec is allowed to use.
4459 *
4460 * @hide
4461 */
4462 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4463
4464 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004465 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004466 * to represent that a audio codec is allowed to use.
4467 *
4468 * @hide
4469 */
4470 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4471
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004472 // ---------------------------------------------------------------------
4473 // ---------------------------------------------------------------------
4474 // Intent flags (see mFlags variable).
4475
Tor Norbyed9273d62013-05-30 15:59:53 -07004476 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004477 @IntDef(flag = true, value = {
4478 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4479 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004480 @Retention(RetentionPolicy.SOURCE)
4481 public @interface GrantUriMode {}
4482
Jeff Sharkey846318a2014-04-04 12:12:41 -07004483 /** @hide */
4484 @IntDef(flag = true, value = {
4485 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4486 @Retention(RetentionPolicy.SOURCE)
4487 public @interface AccessUriMode {}
4488
4489 /**
4490 * Test if given mode flags specify an access mode, which must be at least
4491 * read and/or write.
4492 *
4493 * @hide
4494 */
4495 public static boolean isAccessUriMode(int modeFlags) {
4496 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4497 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4498 }
4499
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004500 /**
4501 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004502 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004503 * specified in its ClipData. When applying to an Intent's ClipData,
4504 * all URIs as well as recursive traversals through data or other ClipData
4505 * in Intent items will be granted; only the grant flags of the top-level
4506 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004507 */
4508 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4509 /**
4510 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004511 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004512 * specified in its ClipData. When applying to an Intent's ClipData,
4513 * all URIs as well as recursive traversals through data or other ClipData
4514 * in Intent items will be granted; only the grant flags of the top-level
4515 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004516 */
4517 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4518 /**
4519 * Can be set by the caller to indicate that this Intent is coming from
4520 * a background operation, not from direct user interaction.
4521 */
4522 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4523 /**
4524 * A flag you can enable for debugging: when set, log messages will be
4525 * printed during the resolution of this intent to show you what has
4526 * been found to create the final resolved list.
4527 */
4528 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004529 /**
4530 * If set, this intent will not match any components in packages that
4531 * are currently stopped. If this is not set, then the default behavior
4532 * is to include such applications in the result.
4533 */
4534 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4535 /**
4536 * If set, this intent will always match any components in packages that
4537 * are currently stopped. This is the default behavior when
4538 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4539 * flags are set, this one wins (it allows overriding of exclude for
4540 * places where the framework may automatically set the exclude flag).
4541 */
4542 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004543
4544 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004545 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004546 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004547 * persisted across device reboots until explicitly revoked with
4548 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4549 * grant for possible persisting; the receiving application must call
4550 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4551 * actually persist.
4552 *
4553 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4554 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4555 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004556 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004557 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004558 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004559
4560 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004561 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4562 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4563 * applies to any URI that is a prefix match against the original granted
4564 * URI. (Without this flag, the URI must match exactly for access to be
4565 * granted.) Another URI is considered a prefix match only when scheme,
4566 * authority, and all path segments defined by the prefix are an exact
4567 * match.
4568 */
4569 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4570
4571 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004572 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004573 * homework and verified that they correctly handle packages and components
4574 * that come and go over time. In particular:
4575 * <ul>
4576 * <li>Apps installed on external storage, which will appear to be
4577 * uninstalled while the the device is ejected.
4578 * <li>Apps with encryption unaware components, which will appear to not
4579 * exist while the device is locked.
4580 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004581 *
4582 * @hide
4583 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004584 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004585
4586 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004587 * Internal flag used to indicate ephemeral applications should not be
4588 * considered when resolving the intent.
4589 *
4590 * @hide
4591 */
4592 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4593
4594 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004595 * If set, the new activity is not kept in the history stack. As soon as
4596 * the user navigates away from it, the activity is finished. This may also
4597 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4598 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004599 *
4600 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4601 * is never invoked when the current activity starts a new activity which
4602 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004603 */
4604 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4605 /**
4606 * If set, the activity will not be launched if it is already running
4607 * at the top of the history stack.
4608 */
4609 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4610 /**
4611 * If set, this activity will become the start of a new task on this
4612 * history stack. A task (from the activity that started it to the
4613 * next task activity) defines an atomic group of activities that the
4614 * user can move to. Tasks can be moved to the foreground and background;
4615 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004616 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004617 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4618 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004619 *
4620 * <p>This flag is generally used by activities that want
4621 * to present a "launcher" style behavior: they give the user a list of
4622 * separate things that can be done, which otherwise run completely
4623 * independently of the activity launching them.
4624 *
4625 * <p>When using this flag, if a task is already running for the activity
4626 * you are now starting, then a new activity will not be started; instead,
4627 * the current task will simply be brought to the front of the screen with
4628 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4629 * to disable this behavior.
4630 *
4631 * <p>This flag can not be used when the caller is requesting a result from
4632 * the activity being launched.
4633 */
4634 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4635 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004636 * This flag is used to create a new task and launch an activity into it.
4637 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4638 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4639 * search through existing tasks for ones matching this Intent. Only if no such
4640 * task is found would a new task be created. When paired with
4641 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4642 * the search for a matching task and unconditionally start a new task.
4643 *
4644 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4645 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004646 * top-level application launcher.</strong> Used in conjunction with
4647 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4648 * behavior of bringing an existing task to the foreground. When set,
4649 * a new task is <em>always</em> started to host the Activity for the
4650 * Intent, regardless of whether there is already an existing task running
4651 * the same thing.
4652 *
4653 * <p><strong>Because the default system does not include graphical task management,
4654 * you should not use this flag unless you provide some way for a user to
4655 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004656 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004657 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4658 * creating new document tasks.
4659 *
4660 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004661 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662 *
Scott Main7aee61f2011-02-08 11:25:01 -08004663 * <p>See
4664 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4665 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004666 *
4667 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4668 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004669 */
4670 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4671 /**
4672 * If set, and the activity being launched is already running in the
4673 * current task, then instead of launching a new instance of that activity,
4674 * all of the other activities on top of it will be closed and this Intent
4675 * will be delivered to the (now on top) old activity as a new Intent.
4676 *
4677 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4678 * If D calls startActivity() with an Intent that resolves to the component
4679 * of activity B, then C and D will be finished and B receive the given
4680 * Intent, resulting in the stack now being: A, B.
4681 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004682 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004683 * either receive the new intent you are starting here in its
4684 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004685 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004686 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4687 * the same intent, then it will be finished and re-created; for all other
4688 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4689 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004690 *
4691 * <p>This launch mode can also be used to good effect in conjunction with
4692 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4693 * of a task, it will bring any currently running instance of that task
4694 * to the foreground, and then clear it to its root state. This is
4695 * especially useful, for example, when launching an activity from the
4696 * notification manager.
4697 *
Scott Main7aee61f2011-02-08 11:25:01 -08004698 * <p>See
4699 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4700 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004701 */
4702 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4703 /**
4704 * If set and this intent is being used to launch a new activity from an
4705 * existing one, then the reply target of the existing activity will be
4706 * transfered to the new activity. This way the new activity can call
4707 * {@link android.app.Activity#setResult} and have that result sent back to
4708 * the reply target of the original activity.
4709 */
4710 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4711 /**
4712 * If set and this intent is being used to launch a new activity from an
4713 * existing one, the current activity will not be counted as the top
4714 * activity for deciding whether the new intent should be delivered to
4715 * the top instead of starting a new one. The previous activity will
4716 * be used as the top, with the assumption being that the current activity
4717 * will finish itself immediately.
4718 */
4719 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4720 /**
4721 * If set, the new activity is not kept in the list of recently launched
4722 * activities.
4723 */
4724 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4725 /**
4726 * This flag is not normally set by application code, but set for you by
4727 * the system as described in the
4728 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4729 * launchMode} documentation for the singleTask mode.
4730 */
4731 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4732 /**
4733 * If set, and this activity is either being started in a new task or
4734 * bringing to the top an existing task, then it will be launched as
4735 * the front door of the task. This will result in the application of
4736 * any affinities needed to have that task in the proper state (either
4737 * moving activities to or from it), or simply resetting that task to
4738 * its initial state if needed.
4739 */
4740 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4741 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004742 * This flag is not normally set by application code, but set for you by
4743 * the system if this activity is being launched from history
4744 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004745 */
4746 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004747 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004748 * @deprecated As of API 21 this performs identically to
4749 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004750 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004751 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004752 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004753 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004754 * This flag is used to open a document into a new task rooted at the activity launched
4755 * by this Intent. Through the use of this flag, or its equivalent attribute,
4756 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004757 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004758 *
Craig Mautner026596b2014-05-21 15:35:44 -07004759 * <p>The use of the activity attribute form of this,
4760 * {@link android.R.attr#documentLaunchMode}, is
4761 * preferred over the Intent flag described here. The attribute form allows the
4762 * Activity to specify multiple document behavior for all launchers of the Activity
4763 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004764 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004765 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4766 * it is kept after the activity is finished is different than the use of
4767 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4768 * this flag is being used to create a new recents entry, then by default that entry
4769 * will be removed once the activity is finished. You can modify this behavior with
4770 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4771 *
Craig Mautner026596b2014-05-21 15:35:44 -07004772 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4773 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4774 * equivalent of the Activity manifest specifying {@link
4775 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4776 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4777 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004778 *
Craig Mautner026596b2014-05-21 15:35:44 -07004779 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004780 *
Craig Mautner026596b2014-05-21 15:35:44 -07004781 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004782 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4783 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004784 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004785 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004786 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004787 * callback from occurring on the current frontmost activity before it is
4788 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004789 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004790 * <p>Typically, an activity can rely on that callback to indicate that an
4791 * explicit user action has caused their activity to be moved out of the
4792 * foreground. The callback marks an appropriate point in the activity's
4793 * lifecycle for it to dismiss any notifications that it intends to display
4794 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004795 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004796 * <p>If an activity is ever started via any non-user-driven events such as
4797 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4798 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004799 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004800 */
4801 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004802 /**
4803 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4804 * this flag will cause the launched activity to be brought to the front of its
4805 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004806 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004807 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4808 * If D calls startActivity() with an Intent that resolves to the component
4809 * of activity B, then B will be brought to the front of the history stack,
4810 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004811 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004812 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004813 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004814 */
4815 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004816 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004817 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4818 * this flag will prevent the system from applying an activity transition
4819 * animation to go to the next activity state. This doesn't mean an
4820 * animation will never run -- if another activity change happens that doesn't
4821 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004822 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004823 * when you are going to do a series of activity operations but the
4824 * animation seen by the user shouldn't be driven by the first activity
4825 * change but rather a later one.
4826 */
4827 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4828 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004829 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4830 * this flag will cause any existing task that would be associated with the
4831 * activity to be cleared before the activity is started. That is, the activity
4832 * becomes the new root of an otherwise empty task, and any old activities
4833 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4834 */
4835 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4836 /**
4837 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4838 * this flag will cause a newly launching task to be placed on top of the current
4839 * home activity task (if there is one). That is, pressing back from the task
4840 * will always return the user to home even if that was not the last activity they
4841 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4842 */
4843 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4844 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004845 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4846 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004847 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004848 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004849 * this flag. When set and the task's activity is finished, the recents
4850 * entry will remain in the interface for the user to re-launch it, like a
4851 * recents entry for a top-level application.
4852 * <p>
4853 * The receiving activity can override this request with
4854 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4855 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004856 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004857 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004858 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004859
4860 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004861 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4862 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004863 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4864 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004865 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004866 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004867
4868 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004869 * If set, when sending a broadcast only registered receivers will be
4870 * called -- no BroadcastReceiver components will be launched.
4871 */
4872 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004873 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004874 * If set, when sending a broadcast the new broadcast will replace
4875 * any existing pending broadcast that matches it. Matching is defined
4876 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4877 * true for the intents of the two broadcasts. When a match is found,
4878 * the new broadcast (and receivers associated with it) will replace the
4879 * existing one in the pending broadcast list, remaining at the same
4880 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004881 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004882 * <p>This flag is most typically used with sticky broadcasts, which
4883 * only care about delivering the most recent values of the broadcast
4884 * to their receivers.
4885 */
4886 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4887 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004888 * If set, when sending a broadcast the recipient is allowed to run at
4889 * foreground priority, with a shorter timeout interval. During normal
4890 * broadcasts the receivers are not automatically hoisted out of the
4891 * background priority class.
4892 */
4893 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4894 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004895 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4896 * They can still propagate results through to later receivers, but they can not prevent
4897 * later receivers from seeing the broadcast.
4898 */
4899 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4900 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004901 * If set, when sending a broadcast <i>before boot has completed</i> only
4902 * registered receivers will be called -- no BroadcastReceiver components
4903 * will be launched. Sticky intent state will be recorded properly even
4904 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4905 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004906 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004907 * <p>This flag is only for use by system sevices as a convenience to
4908 * avoid having to implement a more complex mechanism around detection
4909 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004910 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004911 * @hide
4912 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004913 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004914 /**
4915 * Set when this broadcast is for a boot upgrade, a special mode that
4916 * allows the broadcast to be sent before the system is ready and launches
4917 * the app process with no providers running in it.
4918 * @hide
4919 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004920 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004921 /**
4922 * If set, the broadcast will always go to manifest receivers in background (cached
4923 * or not running) apps, regardless of whether that would be done by default. By
4924 * default they will only receive broadcasts if the broadcast has specified an
4925 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08004926 *
4927 * NOTE: dumpstate uses this flag numerically, so when its value is changed
4928 * the broadcast code there must also be changed to match.
4929 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004930 * @hide
4931 */
4932 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4933 /**
4934 * If set, the broadcast will never go to manifest receivers in background (cached
4935 * or not running) apps, regardless of whether that would be done by default. By
4936 * default they will receive broadcasts if the broadcast has specified an
4937 * explicit component or package name.
4938 * @hide
4939 */
4940 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07004941 /**
4942 * If set, this broadcast is being sent from the shell.
4943 * @hide
4944 */
4945 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004946
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004947 /**
4948 * @hide Flags that can't be changed with PendingIntent.
4949 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004950 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4951 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4952 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004953
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004954 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004955 // ---------------------------------------------------------------------
4956 // toUri() and parseUri() options.
4957
4958 /**
4959 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4960 * always has the "intent:" scheme. This syntax can be used when you want
4961 * to later disambiguate between URIs that are intended to describe an
4962 * Intent vs. all others that should be treated as raw URIs. When used
4963 * with {@link #parseUri}, any other scheme will result in a generic
4964 * VIEW action for that raw URI.
4965 */
4966 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004967
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004968 /**
4969 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4970 * always has the "android-app:" scheme. This is a variation of
4971 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4972 * http/https URI being delivered to a specific package name. The format
4973 * is:
4974 *
4975 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004976 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004977 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004978 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4979 * you must also include a scheme; including a path also requires both a host and a scheme.
4980 * The final #Intent; fragment can be used without a scheme, host, or path.
4981 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004982 * used with intents that have a {@link #setSelector}, since the base intent
4983 * will always have an explicit package name.</p>
4984 *
4985 * <p>Some examples of how this scheme maps to Intent objects:</p>
4986 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4987 * <colgroup align="left" />
4988 * <colgroup align="left" />
4989 * <thead>
4990 * <tr><th>URI</th> <th>Intent</th></tr>
4991 * </thead>
4992 *
4993 * <tbody>
4994 * <tr><td><code>android-app://com.example.app</code></td>
4995 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4996 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4997 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4998 * </table></td>
4999 * </tr>
5000 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
5001 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5002 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5003 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
5004 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5005 * </table></td>
5006 * </tr>
5007 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5008 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5009 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5010 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5011 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5012 * </table></td>
5013 * </tr>
5014 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5015 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5016 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5017 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5018 * </table></td>
5019 * </tr>
5020 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5021 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5022 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5023 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5024 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5025 * </table></td>
5026 * </tr>
5027 * <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>
5028 * <td><table border="" style="margin:0" >
5029 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5030 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5031 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5032 * </table></td>
5033 * </tr>
5034 * </tbody>
5035 * </table>
5036 */
5037 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5038
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005039 /**
5040 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5041 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5042 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5043 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5044 * generated Intent can not cause unexpected data access to happen.
5045 *
5046 * <p>If you do not trust the source of the URI being parsed, you should still do further
5047 * processing to protect yourself from it. In particular, when using it to start an
5048 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5049 * that can handle it.</p>
5050 */
5051 public static final int URI_ALLOW_UNSAFE = 1<<2;
5052
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005053 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005054
5055 private String mAction;
5056 private Uri mData;
5057 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005058 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005059 private ComponentName mComponent;
5060 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005061 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005062 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005063 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005064 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005065 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005066 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005067
5068 // ---------------------------------------------------------------------
5069
5070 /**
5071 * Create an empty intent.
5072 */
5073 public Intent() {
5074 }
5075
5076 /**
5077 * Copy constructor.
5078 */
5079 public Intent(Intent o) {
5080 this.mAction = o.mAction;
5081 this.mData = o.mData;
5082 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005083 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005084 this.mComponent = o.mComponent;
5085 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005086 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005088 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089 }
5090 if (o.mExtras != null) {
5091 this.mExtras = new Bundle(o.mExtras);
5092 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005093 if (o.mSourceBounds != null) {
5094 this.mSourceBounds = new Rect(o.mSourceBounds);
5095 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005096 if (o.mSelector != null) {
5097 this.mSelector = new Intent(o.mSelector);
5098 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005099 if (o.mClipData != null) {
5100 this.mClipData = new ClipData(o.mClipData);
5101 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005102 }
5103
5104 @Override
5105 public Object clone() {
5106 return new Intent(this);
5107 }
5108
5109 private Intent(Intent o, boolean all) {
5110 this.mAction = o.mAction;
5111 this.mData = o.mData;
5112 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005113 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005114 this.mComponent = o.mComponent;
5115 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005116 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005117 }
5118 }
5119
5120 /**
5121 * Make a clone of only the parts of the Intent that are relevant for
5122 * filter matching: the action, data, type, component, and categories.
5123 */
5124 public Intent cloneFilter() {
5125 return new Intent(this, false);
5126 }
5127
5128 /**
5129 * Create an intent with a given action. All other fields (data, type,
5130 * class) are null. Note that the action <em>must</em> be in a
5131 * namespace because Intents are used globally in the system -- for
5132 * example the system VIEW action is android.intent.action.VIEW; an
5133 * application's custom action would be something like
5134 * com.google.app.myapp.CUSTOM_ACTION.
5135 *
5136 * @param action The Intent action, such as ACTION_VIEW.
5137 */
5138 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005139 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005140 }
5141
5142 /**
5143 * Create an intent with a given action and for a given data url. Note
5144 * that the action <em>must</em> be in a namespace because Intents are
5145 * used globally in the system -- for example the system VIEW action is
5146 * android.intent.action.VIEW; an application's custom action would be
5147 * something like com.google.app.myapp.CUSTOM_ACTION.
5148 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005149 * <p><em>Note: scheme and host name matching in the Android framework is
5150 * case-sensitive, unlike the formal RFC. As a result,
5151 * you should always ensure that you write your Uri with these elements
5152 * using lower case letters, and normalize any Uris you receive from
5153 * outside of Android to ensure the scheme and host is lower case.</em></p>
5154 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005155 * @param action The Intent action, such as ACTION_VIEW.
5156 * @param uri The Intent data URI.
5157 */
5158 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005159 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005160 mData = uri;
5161 }
5162
5163 /**
5164 * Create an intent for a specific component. All other fields (action, data,
5165 * type, class) are null, though they can be modified later with explicit
5166 * calls. This provides a convenient way to create an intent that is
5167 * intended to execute a hard-coded class name, rather than relying on the
5168 * system to find an appropriate class for you; see {@link #setComponent}
5169 * for more information on the repercussions of this.
5170 *
5171 * @param packageContext A Context of the application package implementing
5172 * this class.
5173 * @param cls The component class that is to be used for the intent.
5174 *
5175 * @see #setClass
5176 * @see #setComponent
5177 * @see #Intent(String, android.net.Uri , Context, Class)
5178 */
5179 public Intent(Context packageContext, Class<?> cls) {
5180 mComponent = new ComponentName(packageContext, cls);
5181 }
5182
5183 /**
5184 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005185 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005186 * construct the Intent and then calling {@link #setClass} to set its
5187 * class.
5188 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005189 * <p><em>Note: scheme and host name matching in the Android framework is
5190 * case-sensitive, unlike the formal RFC. As a result,
5191 * you should always ensure that you write your Uri with these elements
5192 * using lower case letters, and normalize any Uris you receive from
5193 * outside of Android to ensure the scheme and host is lower case.</em></p>
5194 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005195 * @param action The Intent action, such as ACTION_VIEW.
5196 * @param uri The Intent data URI.
5197 * @param packageContext A Context of the application package implementing
5198 * this class.
5199 * @param cls The component class that is to be used for the intent.
5200 *
5201 * @see #Intent(String, android.net.Uri)
5202 * @see #Intent(Context, Class)
5203 * @see #setClass
5204 * @see #setComponent
5205 */
5206 public Intent(String action, Uri uri,
5207 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005208 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005209 mData = uri;
5210 mComponent = new ComponentName(packageContext, cls);
5211 }
5212
5213 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005214 * Create an intent to launch the main (root) activity of a task. This
5215 * is the Intent that is started when the application's is launched from
5216 * Home. For anything else that wants to launch an application in the
5217 * same way, it is important that they use an Intent structured the same
5218 * way, and can use this function to ensure this is the case.
5219 *
5220 * <p>The returned Intent has the given Activity component as its explicit
5221 * component, {@link #ACTION_MAIN} as its action, and includes the
5222 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5223 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5224 * to do that through {@link #addFlags(int)} on the returned Intent.
5225 *
5226 * @param mainActivity The main activity component that this Intent will
5227 * launch.
5228 * @return Returns a newly created Intent that can be used to launch the
5229 * activity as a main application entry.
5230 *
5231 * @see #setClass
5232 * @see #setComponent
5233 */
5234 public static Intent makeMainActivity(ComponentName mainActivity) {
5235 Intent intent = new Intent(ACTION_MAIN);
5236 intent.setComponent(mainActivity);
5237 intent.addCategory(CATEGORY_LAUNCHER);
5238 return intent;
5239 }
5240
5241 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005242 * Make an Intent for the main activity of an application, without
5243 * specifying a specific activity to run but giving a selector to find
5244 * the activity. This results in a final Intent that is structured
5245 * the same as when the application is launched from
5246 * Home. For anything else that wants to launch an application in the
5247 * same way, it is important that they use an Intent structured the same
5248 * way, and can use this function to ensure this is the case.
5249 *
5250 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5251 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5252 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5253 * to do that through {@link #addFlags(int)} on the returned Intent.
5254 *
5255 * @param selectorAction The action name of the Intent's selector.
5256 * @param selectorCategory The name of a category to add to the Intent's
5257 * selector.
5258 * @return Returns a newly created Intent that can be used to launch the
5259 * activity as a main application entry.
5260 *
5261 * @see #setSelector(Intent)
5262 */
5263 public static Intent makeMainSelectorActivity(String selectorAction,
5264 String selectorCategory) {
5265 Intent intent = new Intent(ACTION_MAIN);
5266 intent.addCategory(CATEGORY_LAUNCHER);
5267 Intent selector = new Intent();
5268 selector.setAction(selectorAction);
5269 selector.addCategory(selectorCategory);
5270 intent.setSelector(selector);
5271 return intent;
5272 }
5273
5274 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005275 * Make an Intent that can be used to re-launch an application's task
5276 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5277 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5278 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5279 *
5280 * @param mainActivity The activity component that is the root of the
5281 * task; this is the activity that has been published in the application's
5282 * manifest as the main launcher icon.
5283 *
5284 * @return Returns a newly created Intent that can be used to relaunch the
5285 * activity's task in its root state.
5286 */
5287 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5288 Intent intent = makeMainActivity(mainActivity);
5289 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5290 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5291 return intent;
5292 }
5293
5294 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005295 * Call {@link #parseUri} with 0 flags.
5296 * @deprecated Use {@link #parseUri} instead.
5297 */
5298 @Deprecated
5299 public static Intent getIntent(String uri) throws URISyntaxException {
5300 return parseUri(uri, 0);
5301 }
Tom Taylord4a47292009-12-21 13:59:18 -08005302
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005303 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005304 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005305 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005306 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005307 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005308 *
5309 * <p>The URI given here must not be relative -- that is, it must include
5310 * the scheme and full path.
5311 *
5312 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005313 * @param flags Additional processing flags. Either 0,
5314 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 *
5316 * @return Intent The newly created Intent object.
5317 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005318 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5319 * it bad (as parsed by the Uri class) or the Intent data within the
5320 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005321 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005322 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005323 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005324 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005325 int i = 0;
5326 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005327 final boolean androidApp = uri.startsWith("android-app:");
5328
5329 // Validate intent scheme if requested.
5330 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5331 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005332 Intent intent = new Intent(ACTION_VIEW);
5333 try {
5334 intent.setData(Uri.parse(uri));
5335 } catch (IllegalArgumentException e) {
5336 throw new URISyntaxException(uri, e.getMessage());
5337 }
5338 return intent;
5339 }
5340 }
Tom Taylord4a47292009-12-21 13:59:18 -08005341
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005342 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005343 // simple case
5344 if (i == -1) {
5345 if (!androidApp) {
5346 return new Intent(ACTION_VIEW, Uri.parse(uri));
5347 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005348
5349 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005350 } else if (!uri.startsWith("#Intent;", i)) {
5351 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005352 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005353 } else {
5354 i = -1;
5355 }
5356 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005357
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005358 // new format
5359 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005360 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005361 boolean explicitAction = false;
5362 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005363
5364 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005365 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005366 String data;
5367 if (i >= 0) {
5368 data = uri.substring(0, i);
5369 i += 8; // length of "#Intent;"
5370 } else {
5371 data = uri;
5372 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005373
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005374 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005375 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005376 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005377 if (eq < 0) eq = i-1;
5378 int semi = uri.indexOf(';', i);
5379 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005380
5381 // action
5382 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005383 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005384 if (!inSelector) {
5385 explicitAction = true;
5386 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005387 }
5388
5389 // categories
5390 else if (uri.startsWith("category=", i)) {
5391 intent.addCategory(value);
5392 }
5393
5394 // type
5395 else if (uri.startsWith("type=", i)) {
5396 intent.mType = value;
5397 }
5398
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005399 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005400 else if (uri.startsWith("launchFlags=", i)) {
5401 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005402 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5403 intent.mFlags &= ~IMMUTABLE_FLAGS;
5404 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005405 }
5406
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005407 // package
5408 else if (uri.startsWith("package=", i)) {
5409 intent.mPackage = value;
5410 }
5411
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005412 // component
5413 else if (uri.startsWith("component=", i)) {
5414 intent.mComponent = ComponentName.unflattenFromString(value);
5415 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005416
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005417 // scheme
5418 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005419 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005420 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005421 } else {
5422 scheme = value;
5423 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005424 }
5425
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005426 // source bounds
5427 else if (uri.startsWith("sourceBounds=", i)) {
5428 intent.mSourceBounds = Rect.unflattenFromString(value);
5429 }
5430
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005431 // selector
5432 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5433 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005434 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005435 }
5436
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005437 // extra
5438 else {
5439 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005440 // create Bundle if it doesn't already exist
5441 if (intent.mExtras == null) intent.mExtras = new Bundle();
5442 Bundle b = intent.mExtras;
5443 // add EXTRA
5444 if (uri.startsWith("S.", i)) b.putString(key, value);
5445 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5446 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5447 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5448 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5449 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5450 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5451 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5452 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5453 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5454 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005455
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005456 // move to the next item
5457 i = semi + 1;
5458 }
5459
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005460 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005461 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005462 if (baseIntent.mPackage == null) {
5463 baseIntent.setSelector(intent);
5464 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005465 intent = baseIntent;
5466 }
5467
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005468 if (data != null) {
5469 if (data.startsWith("intent:")) {
5470 data = data.substring(7);
5471 if (scheme != null) {
5472 data = scheme + ':' + data;
5473 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005474 } else if (data.startsWith("android-app:")) {
5475 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5476 // Correctly formed android-app, first part is package name.
5477 int end = data.indexOf('/', 14);
5478 if (end < 0) {
5479 // All we have is a package name.
5480 intent.mPackage = data.substring(14);
5481 if (!explicitAction) {
5482 intent.setAction(ACTION_MAIN);
5483 }
5484 data = "";
5485 } else {
5486 // Target the Intent at the given package name always.
5487 String authority = null;
5488 intent.mPackage = data.substring(14, end);
5489 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005490 if ((end+1) < data.length()) {
5491 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5492 // Found a scheme, remember it.
5493 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005494 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005495 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5496 // Found a authority, remember it.
5497 authority = data.substring(end+1, newEnd);
5498 end = newEnd;
5499 }
5500 } else {
5501 // All we have is a scheme.
5502 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005503 }
5504 }
5505 if (scheme == null) {
5506 // If there was no scheme, then this just targets the package.
5507 if (!explicitAction) {
5508 intent.setAction(ACTION_MAIN);
5509 }
5510 data = "";
5511 } else if (authority == null) {
5512 data = scheme + ":";
5513 } else {
5514 data = scheme + "://" + authority + data.substring(end);
5515 }
5516 }
5517 } else {
5518 data = "";
5519 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005520 }
Tom Taylord4a47292009-12-21 13:59:18 -08005521
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005522 if (data.length() > 0) {
5523 try {
5524 intent.mData = Uri.parse(data);
5525 } catch (IllegalArgumentException e) {
5526 throw new URISyntaxException(uri, e.getMessage());
5527 }
5528 }
5529 }
Tom Taylord4a47292009-12-21 13:59:18 -08005530
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005531 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005532
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005533 } catch (IndexOutOfBoundsException e) {
5534 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5535 }
5536 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005537
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005538 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005539 return getIntentOld(uri, 0);
5540 }
5541
5542 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005543 Intent intent;
5544
5545 int i = uri.lastIndexOf('#');
5546 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005547 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005548 final int intentFragmentStart = i;
5549 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005550
5551 i++;
5552
5553 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005554 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005555 i += 7;
5556 int j = uri.indexOf(')', i);
5557 action = uri.substring(i, j);
5558 i = j + 1;
5559 }
5560
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005561 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005562
5563 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005564 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005565 i += 11;
5566 int j = uri.indexOf(')', i);
5567 while (i < j) {
5568 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005569 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005570 if (i < sep) {
5571 intent.addCategory(uri.substring(i, sep));
5572 }
5573 i = sep + 1;
5574 }
5575 i = j + 1;
5576 }
5577
5578 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005579 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005580 i += 5;
5581 int j = uri.indexOf(')', i);
5582 intent.mType = uri.substring(i, j);
5583 i = j + 1;
5584 }
5585
5586 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005587 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005588 i += 12;
5589 int j = uri.indexOf(')', i);
5590 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005591 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5592 intent.mFlags &= ~IMMUTABLE_FLAGS;
5593 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005594 i = j + 1;
5595 }
5596
5597 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005598 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005599 i += 10;
5600 int j = uri.indexOf(')', i);
5601 int sep = uri.indexOf('!', i);
5602 if (sep >= 0 && sep < j) {
5603 String pkg = uri.substring(i, sep);
5604 String cls = uri.substring(sep + 1, j);
5605 intent.mComponent = new ComponentName(pkg, cls);
5606 }
5607 i = j + 1;
5608 }
5609
5610 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005611 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005612 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005613
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005614 final int closeParen = uri.indexOf(')', i);
5615 if (closeParen == -1) throw new URISyntaxException(uri,
5616 "EXTRA missing trailing ')'", i);
5617
5618 while (i < closeParen) {
5619 // fetch the key value
5620 int j = uri.indexOf('=', i);
5621 if (j <= i + 1 || i >= closeParen) {
5622 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5623 }
5624 char type = uri.charAt(i);
5625 i++;
5626 String key = uri.substring(i, j);
5627 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005629 // get type-value
5630 j = uri.indexOf('!', i);
5631 if (j == -1 || j >= closeParen) j = closeParen;
5632 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5633 String value = uri.substring(i, j);
5634 i = j;
5635
5636 // create Bundle if it doesn't already exist
5637 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005639 // add item to bundle
5640 try {
5641 switch (type) {
5642 case 'S':
5643 intent.mExtras.putString(key, Uri.decode(value));
5644 break;
5645 case 'B':
5646 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5647 break;
5648 case 'b':
5649 intent.mExtras.putByte(key, Byte.parseByte(value));
5650 break;
5651 case 'c':
5652 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5653 break;
5654 case 'd':
5655 intent.mExtras.putDouble(key, Double.parseDouble(value));
5656 break;
5657 case 'f':
5658 intent.mExtras.putFloat(key, Float.parseFloat(value));
5659 break;
5660 case 'i':
5661 intent.mExtras.putInt(key, Integer.parseInt(value));
5662 break;
5663 case 'l':
5664 intent.mExtras.putLong(key, Long.parseLong(value));
5665 break;
5666 case 's':
5667 intent.mExtras.putShort(key, Short.parseShort(value));
5668 break;
5669 default:
5670 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5671 }
5672 } catch (NumberFormatException e) {
5673 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5674 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005676 char ch = uri.charAt(i);
5677 if (ch == ')') break;
5678 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5679 i++;
5680 }
5681 }
5682
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005683 if (isIntentFragment) {
5684 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5685 } else {
5686 intent.mData = Uri.parse(uri);
5687 }
Tom Taylord4a47292009-12-21 13:59:18 -08005688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005689 if (intent.mAction == null) {
5690 // By default, if no action is specified, then use VIEW.
5691 intent.mAction = ACTION_VIEW;
5692 }
5693
5694 } else {
5695 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5696 }
5697
5698 return intent;
5699 }
5700
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005701 /** @hide */
5702 public interface CommandOptionHandler {
5703 boolean handleOption(String opt, ShellCommand cmd);
5704 }
5705
5706 /** @hide */
5707 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5708 throws URISyntaxException {
5709 Intent intent = new Intent();
5710 Intent baseIntent = intent;
5711 boolean hasIntentInfo = false;
5712
5713 Uri data = null;
5714 String type = null;
5715
5716 String opt;
5717 while ((opt=cmd.getNextOption()) != null) {
5718 switch (opt) {
5719 case "-a":
5720 intent.setAction(cmd.getNextArgRequired());
5721 if (intent == baseIntent) {
5722 hasIntentInfo = true;
5723 }
5724 break;
5725 case "-d":
5726 data = Uri.parse(cmd.getNextArgRequired());
5727 if (intent == baseIntent) {
5728 hasIntentInfo = true;
5729 }
5730 break;
5731 case "-t":
5732 type = cmd.getNextArgRequired();
5733 if (intent == baseIntent) {
5734 hasIntentInfo = true;
5735 }
5736 break;
5737 case "-c":
5738 intent.addCategory(cmd.getNextArgRequired());
5739 if (intent == baseIntent) {
5740 hasIntentInfo = true;
5741 }
5742 break;
5743 case "-e":
5744 case "--es": {
5745 String key = cmd.getNextArgRequired();
5746 String value = cmd.getNextArgRequired();
5747 intent.putExtra(key, value);
5748 }
5749 break;
5750 case "--esn": {
5751 String key = cmd.getNextArgRequired();
5752 intent.putExtra(key, (String) null);
5753 }
5754 break;
5755 case "--ei": {
5756 String key = cmd.getNextArgRequired();
5757 String value = cmd.getNextArgRequired();
5758 intent.putExtra(key, Integer.decode(value));
5759 }
5760 break;
5761 case "--eu": {
5762 String key = cmd.getNextArgRequired();
5763 String value = cmd.getNextArgRequired();
5764 intent.putExtra(key, Uri.parse(value));
5765 }
5766 break;
5767 case "--ecn": {
5768 String key = cmd.getNextArgRequired();
5769 String value = cmd.getNextArgRequired();
5770 ComponentName cn = ComponentName.unflattenFromString(value);
5771 if (cn == null)
5772 throw new IllegalArgumentException("Bad component name: " + value);
5773 intent.putExtra(key, cn);
5774 }
5775 break;
5776 case "--eia": {
5777 String key = cmd.getNextArgRequired();
5778 String value = cmd.getNextArgRequired();
5779 String[] strings = value.split(",");
5780 int[] list = new int[strings.length];
5781 for (int i = 0; i < strings.length; i++) {
5782 list[i] = Integer.decode(strings[i]);
5783 }
5784 intent.putExtra(key, list);
5785 }
5786 break;
5787 case "--eial": {
5788 String key = cmd.getNextArgRequired();
5789 String value = cmd.getNextArgRequired();
5790 String[] strings = value.split(",");
5791 ArrayList<Integer> list = new ArrayList<>(strings.length);
5792 for (int i = 0; i < strings.length; i++) {
5793 list.add(Integer.decode(strings[i]));
5794 }
5795 intent.putExtra(key, list);
5796 }
5797 break;
5798 case "--el": {
5799 String key = cmd.getNextArgRequired();
5800 String value = cmd.getNextArgRequired();
5801 intent.putExtra(key, Long.valueOf(value));
5802 }
5803 break;
5804 case "--ela": {
5805 String key = cmd.getNextArgRequired();
5806 String value = cmd.getNextArgRequired();
5807 String[] strings = value.split(",");
5808 long[] list = new long[strings.length];
5809 for (int i = 0; i < strings.length; i++) {
5810 list[i] = Long.valueOf(strings[i]);
5811 }
5812 intent.putExtra(key, list);
5813 hasIntentInfo = true;
5814 }
5815 break;
5816 case "--elal": {
5817 String key = cmd.getNextArgRequired();
5818 String value = cmd.getNextArgRequired();
5819 String[] strings = value.split(",");
5820 ArrayList<Long> list = new ArrayList<>(strings.length);
5821 for (int i = 0; i < strings.length; i++) {
5822 list.add(Long.valueOf(strings[i]));
5823 }
5824 intent.putExtra(key, list);
5825 hasIntentInfo = true;
5826 }
5827 break;
5828 case "--ef": {
5829 String key = cmd.getNextArgRequired();
5830 String value = cmd.getNextArgRequired();
5831 intent.putExtra(key, Float.valueOf(value));
5832 hasIntentInfo = true;
5833 }
5834 break;
5835 case "--efa": {
5836 String key = cmd.getNextArgRequired();
5837 String value = cmd.getNextArgRequired();
5838 String[] strings = value.split(",");
5839 float[] list = new float[strings.length];
5840 for (int i = 0; i < strings.length; i++) {
5841 list[i] = Float.valueOf(strings[i]);
5842 }
5843 intent.putExtra(key, list);
5844 hasIntentInfo = true;
5845 }
5846 break;
5847 case "--efal": {
5848 String key = cmd.getNextArgRequired();
5849 String value = cmd.getNextArgRequired();
5850 String[] strings = value.split(",");
5851 ArrayList<Float> list = new ArrayList<>(strings.length);
5852 for (int i = 0; i < strings.length; i++) {
5853 list.add(Float.valueOf(strings[i]));
5854 }
5855 intent.putExtra(key, list);
5856 hasIntentInfo = true;
5857 }
5858 break;
5859 case "--esa": {
5860 String key = cmd.getNextArgRequired();
5861 String value = cmd.getNextArgRequired();
5862 // Split on commas unless they are preceeded by an escape.
5863 // The escape character must be escaped for the string and
5864 // again for the regex, thus four escape characters become one.
5865 String[] strings = value.split("(?<!\\\\),");
5866 intent.putExtra(key, strings);
5867 hasIntentInfo = true;
5868 }
5869 break;
5870 case "--esal": {
5871 String key = cmd.getNextArgRequired();
5872 String value = cmd.getNextArgRequired();
5873 // Split on commas unless they are preceeded by an escape.
5874 // The escape character must be escaped for the string and
5875 // again for the regex, thus four escape characters become one.
5876 String[] strings = value.split("(?<!\\\\),");
5877 ArrayList<String> list = new ArrayList<>(strings.length);
5878 for (int i = 0; i < strings.length; i++) {
5879 list.add(strings[i]);
5880 }
5881 intent.putExtra(key, list);
5882 hasIntentInfo = true;
5883 }
5884 break;
5885 case "--ez": {
5886 String key = cmd.getNextArgRequired();
5887 String value = cmd.getNextArgRequired().toLowerCase();
5888 // Boolean.valueOf() results in false for anything that is not "true", which is
5889 // error-prone in shell commands
5890 boolean arg;
5891 if ("true".equals(value) || "t".equals(value)) {
5892 arg = true;
5893 } else if ("false".equals(value) || "f".equals(value)) {
5894 arg = false;
5895 } else {
5896 try {
5897 arg = Integer.decode(value) != 0;
5898 } catch (NumberFormatException ex) {
5899 throw new IllegalArgumentException("Invalid boolean value: " + value);
5900 }
5901 }
5902
5903 intent.putExtra(key, arg);
5904 }
5905 break;
5906 case "-n": {
5907 String str = cmd.getNextArgRequired();
5908 ComponentName cn = ComponentName.unflattenFromString(str);
5909 if (cn == null)
5910 throw new IllegalArgumentException("Bad component name: " + str);
5911 intent.setComponent(cn);
5912 if (intent == baseIntent) {
5913 hasIntentInfo = true;
5914 }
5915 }
5916 break;
5917 case "-p": {
5918 String str = cmd.getNextArgRequired();
5919 intent.setPackage(str);
5920 if (intent == baseIntent) {
5921 hasIntentInfo = true;
5922 }
5923 }
5924 break;
5925 case "-f":
5926 String str = cmd.getNextArgRequired();
5927 intent.setFlags(Integer.decode(str).intValue());
5928 break;
5929 case "--grant-read-uri-permission":
5930 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5931 break;
5932 case "--grant-write-uri-permission":
5933 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5934 break;
5935 case "--grant-persistable-uri-permission":
5936 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5937 break;
5938 case "--grant-prefix-uri-permission":
5939 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5940 break;
5941 case "--exclude-stopped-packages":
5942 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5943 break;
5944 case "--include-stopped-packages":
5945 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5946 break;
5947 case "--debug-log-resolution":
5948 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5949 break;
5950 case "--activity-brought-to-front":
5951 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5952 break;
5953 case "--activity-clear-top":
5954 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5955 break;
5956 case "--activity-clear-when-task-reset":
5957 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5958 break;
5959 case "--activity-exclude-from-recents":
5960 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5961 break;
5962 case "--activity-launched-from-history":
5963 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5964 break;
5965 case "--activity-multiple-task":
5966 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5967 break;
5968 case "--activity-no-animation":
5969 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5970 break;
5971 case "--activity-no-history":
5972 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5973 break;
5974 case "--activity-no-user-action":
5975 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5976 break;
5977 case "--activity-previous-is-top":
5978 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5979 break;
5980 case "--activity-reorder-to-front":
5981 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5982 break;
5983 case "--activity-reset-task-if-needed":
5984 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5985 break;
5986 case "--activity-single-top":
5987 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5988 break;
5989 case "--activity-clear-task":
5990 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5991 break;
5992 case "--activity-task-on-home":
5993 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5994 break;
5995 case "--receiver-registered-only":
5996 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5997 break;
5998 case "--receiver-replace-pending":
5999 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
6000 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006001 case "--receiver-foreground":
6002 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
6003 break;
Dianne Hackborn797772b12017-02-08 16:33:43 -08006004 case "--receiver-no-abort":
6005 intent.addFlags(Intent.FLAG_RECEIVER_NO_ABORT);
6006 break;
6007 case "--receiver-include-background":
6008 intent.addFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND);
6009 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006010 case "--selector":
6011 intent.setDataAndType(data, type);
6012 intent = new Intent();
6013 break;
6014 default:
6015 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6016 // Okay, caller handled this option.
6017 } else {
6018 throw new IllegalArgumentException("Unknown option: " + opt);
6019 }
6020 break;
6021 }
6022 }
6023 intent.setDataAndType(data, type);
6024
6025 final boolean hasSelector = intent != baseIntent;
6026 if (hasSelector) {
6027 // A selector was specified; fix up.
6028 baseIntent.setSelector(intent);
6029 intent = baseIntent;
6030 }
6031
6032 String arg = cmd.getNextArg();
6033 baseIntent = null;
6034 if (arg == null) {
6035 if (hasSelector) {
6036 // If a selector has been specified, and no arguments
6037 // have been supplied for the main Intent, then we can
6038 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6039 // need to have a component name specified yet, the
6040 // selector will take care of that.
6041 baseIntent = new Intent(Intent.ACTION_MAIN);
6042 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6043 }
6044 } else if (arg.indexOf(':') >= 0) {
6045 // The argument is a URI. Fully parse it, and use that result
6046 // to fill in any data not specified so far.
6047 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6048 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6049 } else if (arg.indexOf('/') >= 0) {
6050 // The argument is a component name. Build an Intent to launch
6051 // it.
6052 baseIntent = new Intent(Intent.ACTION_MAIN);
6053 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6054 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6055 } else {
6056 // Assume the argument is a package name.
6057 baseIntent = new Intent(Intent.ACTION_MAIN);
6058 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6059 baseIntent.setPackage(arg);
6060 }
6061 if (baseIntent != null) {
6062 Bundle extras = intent.getExtras();
6063 intent.replaceExtras((Bundle)null);
6064 Bundle uriExtras = baseIntent.getExtras();
6065 baseIntent.replaceExtras((Bundle)null);
6066 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6067 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6068 for (String c : cats) {
6069 baseIntent.removeCategory(c);
6070 }
6071 }
6072 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6073 if (extras == null) {
6074 extras = uriExtras;
6075 } else if (uriExtras != null) {
6076 uriExtras.putAll(extras);
6077 extras = uriExtras;
6078 }
6079 intent.replaceExtras(extras);
6080 hasIntentInfo = true;
6081 }
6082
6083 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6084 return intent;
6085 }
6086
6087 /** @hide */
6088 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6089 final String[] lines = new String[] {
6090 "<INTENT> specifications include these flags and arguments:",
6091 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6092 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6093 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6094 " [--esn <EXTRA_KEY> ...]",
6095 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6096 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6097 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6098 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6099 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6100 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6101 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6102 " (mutiple extras passed as Integer[])",
6103 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6104 " (mutiple extras passed as List<Integer>)",
6105 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6106 " (mutiple extras passed as Long[])",
6107 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6108 " (mutiple extras passed as List<Long>)",
6109 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6110 " (mutiple extras passed as Float[])",
6111 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6112 " (mutiple extras passed as List<Float>)",
6113 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6114 " (mutiple extras passed as String[]; to embed a comma into a string,",
6115 " escape it using \"\\,\")",
6116 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6117 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6118 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006119 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006120 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6121 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6122 " [--debug-log-resolution] [--exclude-stopped-packages]",
6123 " [--include-stopped-packages]",
6124 " [--activity-brought-to-front] [--activity-clear-top]",
6125 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6126 " [--activity-launched-from-history] [--activity-multiple-task]",
6127 " [--activity-no-animation] [--activity-no-history]",
6128 " [--activity-no-user-action] [--activity-previous-is-top]",
6129 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6130 " [--activity-single-top] [--activity-clear-task]",
6131 " [--activity-task-on-home]",
6132 " [--receiver-registered-only] [--receiver-replace-pending]",
Dianne Hackborn797772b12017-02-08 16:33:43 -08006133 " [--receiver-foreground] [--receiver-no-abort]",
6134 " [--receiver-include-background]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006135 " [--selector]",
6136 " [<URI> | <PACKAGE> | <COMPONENT>]"
6137 };
6138 for (String line : lines) {
6139 pw.print(prefix);
6140 pw.println(line);
6141 }
6142 }
6143
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006144 /**
6145 * Retrieve the general action to be performed, such as
6146 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6147 * the information in the intent should be interpreted -- most importantly,
6148 * what to do with the data returned by {@link #getData}.
6149 *
6150 * @return The action of this intent or null if none is specified.
6151 *
6152 * @see #setAction
6153 */
6154 public String getAction() {
6155 return mAction;
6156 }
6157
6158 /**
6159 * Retrieve data this intent is operating on. This URI specifies the name
6160 * of the data; often it uses the content: scheme, specifying data in a
6161 * content provider. Other schemes may be handled by specific activities,
6162 * such as http: by the web browser.
6163 *
6164 * @return The URI of the data this intent is targeting or null.
6165 *
6166 * @see #getScheme
6167 * @see #setData
6168 */
6169 public Uri getData() {
6170 return mData;
6171 }
6172
6173 /**
6174 * The same as {@link #getData()}, but returns the URI as an encoded
6175 * String.
6176 */
6177 public String getDataString() {
6178 return mData != null ? mData.toString() : null;
6179 }
6180
6181 /**
6182 * Return the scheme portion of the intent's data. If the data is null or
6183 * does not include a scheme, null is returned. Otherwise, the scheme
6184 * prefix without the final ':' is returned, i.e. "http".
6185 *
6186 * <p>This is the same as calling getData().getScheme() (and checking for
6187 * null data).
6188 *
6189 * @return The scheme of this intent.
6190 *
6191 * @see #getData
6192 */
6193 public String getScheme() {
6194 return mData != null ? mData.getScheme() : null;
6195 }
6196
6197 /**
6198 * Retrieve any explicit MIME type included in the intent. This is usually
6199 * null, as the type is determined by the intent data.
6200 *
6201 * @return If a type was manually set, it is returned; else null is
6202 * returned.
6203 *
6204 * @see #resolveType(ContentResolver)
6205 * @see #setType
6206 */
6207 public String getType() {
6208 return mType;
6209 }
6210
6211 /**
6212 * Return the MIME data type of this intent. If the type field is
6213 * explicitly set, that is simply returned. Otherwise, if the data is set,
6214 * the type of that data is returned. If neither fields are set, a null is
6215 * returned.
6216 *
6217 * @return The MIME type of this intent.
6218 *
6219 * @see #getType
6220 * @see #resolveType(ContentResolver)
6221 */
6222 public String resolveType(Context context) {
6223 return resolveType(context.getContentResolver());
6224 }
6225
6226 /**
6227 * Return the MIME data type of this intent. If the type field is
6228 * explicitly set, that is simply returned. Otherwise, if the data is set,
6229 * the type of that data is returned. If neither fields are set, a null is
6230 * returned.
6231 *
6232 * @param resolver A ContentResolver that can be used to determine the MIME
6233 * type of the intent's data.
6234 *
6235 * @return The MIME type of this intent.
6236 *
6237 * @see #getType
6238 * @see #resolveType(Context)
6239 */
6240 public String resolveType(ContentResolver resolver) {
6241 if (mType != null) {
6242 return mType;
6243 }
6244 if (mData != null) {
6245 if ("content".equals(mData.getScheme())) {
6246 return resolver.getType(mData);
6247 }
6248 }
6249 return null;
6250 }
6251
6252 /**
6253 * Return the MIME data type of this intent, only if it will be needed for
6254 * intent resolution. This is not generally useful for application code;
6255 * it is used by the frameworks for communicating with back-end system
6256 * services.
6257 *
6258 * @param resolver A ContentResolver that can be used to determine the MIME
6259 * type of the intent's data.
6260 *
6261 * @return The MIME type of this intent, or null if it is unknown or not
6262 * needed.
6263 */
6264 public String resolveTypeIfNeeded(ContentResolver resolver) {
6265 if (mComponent != null) {
6266 return mType;
6267 }
6268 return resolveType(resolver);
6269 }
6270
6271 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006272 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006273 *
6274 * @param category The category to check.
6275 *
6276 * @return boolean True if the intent contains the category, else false.
6277 *
6278 * @see #getCategories
6279 * @see #addCategory
6280 */
6281 public boolean hasCategory(String category) {
6282 return mCategories != null && mCategories.contains(category);
6283 }
6284
6285 /**
6286 * Return the set of all categories in the intent. If there are no categories,
6287 * returns NULL.
6288 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006289 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006290 *
6291 * @see #hasCategory
6292 * @see #addCategory
6293 */
6294 public Set<String> getCategories() {
6295 return mCategories;
6296 }
6297
6298 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006299 * Return the specific selector associated with this Intent. If there is
6300 * none, returns null. See {@link #setSelector} for more information.
6301 *
6302 * @see #setSelector
6303 */
6304 public Intent getSelector() {
6305 return mSelector;
6306 }
6307
6308 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006309 * Return the {@link ClipData} associated with this Intent. If there is
6310 * none, returns null. See {@link #setClipData} for more information.
6311 *
John Spurlock125d1332013-11-25 11:58:37 -05006312 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006313 */
6314 public ClipData getClipData() {
6315 return mClipData;
6316 }
6317
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006318 /** @hide */
6319 public int getContentUserHint() {
6320 return mContentUserHint;
6321 }
6322
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006323 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006324 * Sets the ClassLoader that will be used when unmarshalling
6325 * any Parcelable values from the extras of this Intent.
6326 *
6327 * @param loader a ClassLoader, or null to use the default loader
6328 * at the time of unmarshalling.
6329 */
6330 public void setExtrasClassLoader(ClassLoader loader) {
6331 if (mExtras != null) {
6332 mExtras.setClassLoader(loader);
6333 }
6334 }
6335
6336 /**
6337 * Returns true if an extra value is associated with the given name.
6338 * @param name the extra's name
6339 * @return true if the given extra is present.
6340 */
6341 public boolean hasExtra(String name) {
6342 return mExtras != null && mExtras.containsKey(name);
6343 }
6344
6345 /**
6346 * Returns true if the Intent's extras contain a parcelled file descriptor.
6347 * @return true if the Intent contains a parcelled file descriptor.
6348 */
6349 public boolean hasFileDescriptors() {
6350 return mExtras != null && mExtras.hasFileDescriptors();
6351 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006352
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006353 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006354 public void setAllowFds(boolean allowFds) {
6355 if (mExtras != null) {
6356 mExtras.setAllowFds(allowFds);
6357 }
6358 }
6359
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006360 /** {@hide} */
6361 public void setDefusable(boolean defusable) {
6362 if (mExtras != null) {
6363 mExtras.setDefusable(defusable);
6364 }
6365 }
6366
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006367 /**
6368 * Retrieve extended data from the intent.
6369 *
6370 * @param name The name of the desired item.
6371 *
6372 * @return the value of an item that previously added with putExtra()
6373 * or null if none was found.
6374 *
6375 * @deprecated
6376 * @hide
6377 */
6378 @Deprecated
6379 public Object getExtra(String name) {
6380 return getExtra(name, null);
6381 }
6382
6383 /**
6384 * Retrieve extended data from the intent.
6385 *
6386 * @param name The name of the desired item.
6387 * @param defaultValue the value to be returned if no value of the desired
6388 * type is stored with the given name.
6389 *
6390 * @return the value of an item that previously added with putExtra()
6391 * or the default value if none was found.
6392 *
6393 * @see #putExtra(String, boolean)
6394 */
6395 public boolean getBooleanExtra(String name, boolean defaultValue) {
6396 return mExtras == null ? defaultValue :
6397 mExtras.getBoolean(name, defaultValue);
6398 }
6399
6400 /**
6401 * Retrieve extended data from the intent.
6402 *
6403 * @param name The name of the desired item.
6404 * @param defaultValue the value to be returned if no value of the desired
6405 * type is stored with the given name.
6406 *
6407 * @return the value of an item that previously added with putExtra()
6408 * or the default value if none was found.
6409 *
6410 * @see #putExtra(String, byte)
6411 */
6412 public byte getByteExtra(String name, byte defaultValue) {
6413 return mExtras == null ? defaultValue :
6414 mExtras.getByte(name, defaultValue);
6415 }
6416
6417 /**
6418 * Retrieve extended data from the intent.
6419 *
6420 * @param name The name of the desired item.
6421 * @param defaultValue the value to be returned if no value of the desired
6422 * type is stored with the given name.
6423 *
6424 * @return the value of an item that previously added with putExtra()
6425 * or the default value if none was found.
6426 *
6427 * @see #putExtra(String, short)
6428 */
6429 public short getShortExtra(String name, short defaultValue) {
6430 return mExtras == null ? defaultValue :
6431 mExtras.getShort(name, defaultValue);
6432 }
6433
6434 /**
6435 * Retrieve extended data from the intent.
6436 *
6437 * @param name The name of the desired item.
6438 * @param defaultValue the value to be returned if no value of the desired
6439 * type is stored with the given name.
6440 *
6441 * @return the value of an item that previously added with putExtra()
6442 * or the default value if none was found.
6443 *
6444 * @see #putExtra(String, char)
6445 */
6446 public char getCharExtra(String name, char defaultValue) {
6447 return mExtras == null ? defaultValue :
6448 mExtras.getChar(name, defaultValue);
6449 }
6450
6451 /**
6452 * Retrieve extended data from the intent.
6453 *
6454 * @param name The name of the desired item.
6455 * @param defaultValue the value to be returned if no value of the desired
6456 * type is stored with the given name.
6457 *
6458 * @return the value of an item that previously added with putExtra()
6459 * or the default value if none was found.
6460 *
6461 * @see #putExtra(String, int)
6462 */
6463 public int getIntExtra(String name, int defaultValue) {
6464 return mExtras == null ? defaultValue :
6465 mExtras.getInt(name, defaultValue);
6466 }
6467
6468 /**
6469 * Retrieve extended data from the intent.
6470 *
6471 * @param name The name of the desired item.
6472 * @param defaultValue the value to be returned if no value of the desired
6473 * type is stored with the given name.
6474 *
6475 * @return the value of an item that previously added with putExtra()
6476 * or the default value if none was found.
6477 *
6478 * @see #putExtra(String, long)
6479 */
6480 public long getLongExtra(String name, long defaultValue) {
6481 return mExtras == null ? defaultValue :
6482 mExtras.getLong(name, defaultValue);
6483 }
6484
6485 /**
6486 * Retrieve extended data from the intent.
6487 *
6488 * @param name The name of the desired item.
6489 * @param defaultValue the value to be returned if no value of the desired
6490 * type is stored with the given name.
6491 *
6492 * @return the value of an item that previously added with putExtra(),
6493 * or the default value if no such item is present
6494 *
6495 * @see #putExtra(String, float)
6496 */
6497 public float getFloatExtra(String name, float defaultValue) {
6498 return mExtras == null ? defaultValue :
6499 mExtras.getFloat(name, defaultValue);
6500 }
6501
6502 /**
6503 * Retrieve extended data from the intent.
6504 *
6505 * @param name The name of the desired item.
6506 * @param defaultValue the value to be returned if no value of the desired
6507 * type is stored with the given name.
6508 *
6509 * @return the value of an item that previously added with putExtra()
6510 * or the default value if none was found.
6511 *
6512 * @see #putExtra(String, double)
6513 */
6514 public double getDoubleExtra(String name, double defaultValue) {
6515 return mExtras == null ? defaultValue :
6516 mExtras.getDouble(name, defaultValue);
6517 }
6518
6519 /**
6520 * Retrieve extended data from the intent.
6521 *
6522 * @param name The name of the desired item.
6523 *
6524 * @return the value of an item that previously added with putExtra()
6525 * or null if no String value was found.
6526 *
6527 * @see #putExtra(String, String)
6528 */
6529 public String getStringExtra(String name) {
6530 return mExtras == null ? null : mExtras.getString(name);
6531 }
6532
6533 /**
6534 * Retrieve extended data from the intent.
6535 *
6536 * @param name The name of the desired item.
6537 *
6538 * @return the value of an item that previously added with putExtra()
6539 * or null if no CharSequence value was found.
6540 *
6541 * @see #putExtra(String, CharSequence)
6542 */
6543 public CharSequence getCharSequenceExtra(String name) {
6544 return mExtras == null ? null : mExtras.getCharSequence(name);
6545 }
6546
6547 /**
6548 * Retrieve extended data from the intent.
6549 *
6550 * @param name The name of the desired item.
6551 *
6552 * @return the value of an item that previously added with putExtra()
6553 * or null if no Parcelable value was found.
6554 *
6555 * @see #putExtra(String, Parcelable)
6556 */
6557 public <T extends Parcelable> T getParcelableExtra(String name) {
6558 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6559 }
6560
6561 /**
6562 * Retrieve extended data from the intent.
6563 *
6564 * @param name The name of the desired item.
6565 *
6566 * @return the value of an item that previously added with putExtra()
6567 * or null if no Parcelable[] value was found.
6568 *
6569 * @see #putExtra(String, Parcelable[])
6570 */
6571 public Parcelable[] getParcelableArrayExtra(String name) {
6572 return mExtras == null ? null : mExtras.getParcelableArray(name);
6573 }
6574
6575 /**
6576 * Retrieve extended data from the intent.
6577 *
6578 * @param name The name of the desired item.
6579 *
6580 * @return the value of an item that previously added with putExtra()
6581 * or null if no ArrayList<Parcelable> value was found.
6582 *
6583 * @see #putParcelableArrayListExtra(String, ArrayList)
6584 */
6585 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6586 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6587 }
6588
6589 /**
6590 * Retrieve extended data from the intent.
6591 *
6592 * @param name The name of the desired item.
6593 *
6594 * @return the value of an item that previously added with putExtra()
6595 * or null if no Serializable value was found.
6596 *
6597 * @see #putExtra(String, Serializable)
6598 */
6599 public Serializable getSerializableExtra(String name) {
6600 return mExtras == null ? null : mExtras.getSerializable(name);
6601 }
6602
6603 /**
6604 * Retrieve extended data from the intent.
6605 *
6606 * @param name The name of the desired item.
6607 *
6608 * @return the value of an item that previously added with putExtra()
6609 * or null if no ArrayList<Integer> value was found.
6610 *
6611 * @see #putIntegerArrayListExtra(String, ArrayList)
6612 */
6613 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6614 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6615 }
6616
6617 /**
6618 * Retrieve extended data from the intent.
6619 *
6620 * @param name The name of the desired item.
6621 *
6622 * @return the value of an item that previously added with putExtra()
6623 * or null if no ArrayList<String> value was found.
6624 *
6625 * @see #putStringArrayListExtra(String, ArrayList)
6626 */
6627 public ArrayList<String> getStringArrayListExtra(String name) {
6628 return mExtras == null ? null : mExtras.getStringArrayList(name);
6629 }
6630
6631 /**
6632 * Retrieve extended data from the intent.
6633 *
6634 * @param name The name of the desired item.
6635 *
6636 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006637 * or null if no ArrayList<CharSequence> value was found.
6638 *
6639 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6640 */
6641 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6642 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6643 }
6644
6645 /**
6646 * Retrieve extended data from the intent.
6647 *
6648 * @param name The name of the desired item.
6649 *
6650 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006651 * or null if no boolean array value was found.
6652 *
6653 * @see #putExtra(String, boolean[])
6654 */
6655 public boolean[] getBooleanArrayExtra(String name) {
6656 return mExtras == null ? null : mExtras.getBooleanArray(name);
6657 }
6658
6659 /**
6660 * Retrieve extended data from the intent.
6661 *
6662 * @param name The name of the desired item.
6663 *
6664 * @return the value of an item that previously added with putExtra()
6665 * or null if no byte array value was found.
6666 *
6667 * @see #putExtra(String, byte[])
6668 */
6669 public byte[] getByteArrayExtra(String name) {
6670 return mExtras == null ? null : mExtras.getByteArray(name);
6671 }
6672
6673 /**
6674 * Retrieve extended data from the intent.
6675 *
6676 * @param name The name of the desired item.
6677 *
6678 * @return the value of an item that previously added with putExtra()
6679 * or null if no short array value was found.
6680 *
6681 * @see #putExtra(String, short[])
6682 */
6683 public short[] getShortArrayExtra(String name) {
6684 return mExtras == null ? null : mExtras.getShortArray(name);
6685 }
6686
6687 /**
6688 * Retrieve extended data from the intent.
6689 *
6690 * @param name The name of the desired item.
6691 *
6692 * @return the value of an item that previously added with putExtra()
6693 * or null if no char array value was found.
6694 *
6695 * @see #putExtra(String, char[])
6696 */
6697 public char[] getCharArrayExtra(String name) {
6698 return mExtras == null ? null : mExtras.getCharArray(name);
6699 }
6700
6701 /**
6702 * Retrieve extended data from the intent.
6703 *
6704 * @param name The name of the desired item.
6705 *
6706 * @return the value of an item that previously added with putExtra()
6707 * or null if no int array value was found.
6708 *
6709 * @see #putExtra(String, int[])
6710 */
6711 public int[] getIntArrayExtra(String name) {
6712 return mExtras == null ? null : mExtras.getIntArray(name);
6713 }
6714
6715 /**
6716 * Retrieve extended data from the intent.
6717 *
6718 * @param name The name of the desired item.
6719 *
6720 * @return the value of an item that previously added with putExtra()
6721 * or null if no long array value was found.
6722 *
6723 * @see #putExtra(String, long[])
6724 */
6725 public long[] getLongArrayExtra(String name) {
6726 return mExtras == null ? null : mExtras.getLongArray(name);
6727 }
6728
6729 /**
6730 * Retrieve extended data from the intent.
6731 *
6732 * @param name The name of the desired item.
6733 *
6734 * @return the value of an item that previously added with putExtra()
6735 * or null if no float array value was found.
6736 *
6737 * @see #putExtra(String, float[])
6738 */
6739 public float[] getFloatArrayExtra(String name) {
6740 return mExtras == null ? null : mExtras.getFloatArray(name);
6741 }
6742
6743 /**
6744 * Retrieve extended data from the intent.
6745 *
6746 * @param name The name of the desired item.
6747 *
6748 * @return the value of an item that previously added with putExtra()
6749 * or null if no double array value was found.
6750 *
6751 * @see #putExtra(String, double[])
6752 */
6753 public double[] getDoubleArrayExtra(String name) {
6754 return mExtras == null ? null : mExtras.getDoubleArray(name);
6755 }
6756
6757 /**
6758 * Retrieve extended data from the intent.
6759 *
6760 * @param name The name of the desired item.
6761 *
6762 * @return the value of an item that previously added with putExtra()
6763 * or null if no String array value was found.
6764 *
6765 * @see #putExtra(String, String[])
6766 */
6767 public String[] getStringArrayExtra(String name) {
6768 return mExtras == null ? null : mExtras.getStringArray(name);
6769 }
6770
6771 /**
6772 * Retrieve extended data from the intent.
6773 *
6774 * @param name The name of the desired item.
6775 *
6776 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006777 * or null if no CharSequence array value was found.
6778 *
6779 * @see #putExtra(String, CharSequence[])
6780 */
6781 public CharSequence[] getCharSequenceArrayExtra(String name) {
6782 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6783 }
6784
6785 /**
6786 * Retrieve extended data from the intent.
6787 *
6788 * @param name The name of the desired item.
6789 *
6790 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006791 * or null if no Bundle value was found.
6792 *
6793 * @see #putExtra(String, Bundle)
6794 */
6795 public Bundle getBundleExtra(String name) {
6796 return mExtras == null ? null : mExtras.getBundle(name);
6797 }
6798
6799 /**
6800 * Retrieve extended data from the intent.
6801 *
6802 * @param name The name of the desired item.
6803 *
6804 * @return the value of an item that previously added with putExtra()
6805 * or null if no IBinder value was found.
6806 *
6807 * @see #putExtra(String, IBinder)
6808 *
6809 * @deprecated
6810 * @hide
6811 */
6812 @Deprecated
6813 public IBinder getIBinderExtra(String name) {
6814 return mExtras == null ? null : mExtras.getIBinder(name);
6815 }
6816
6817 /**
6818 * Retrieve extended data from the intent.
6819 *
6820 * @param name The name of the desired item.
6821 * @param defaultValue The default value to return in case no item is
6822 * associated with the key 'name'
6823 *
6824 * @return the value of an item that previously added with putExtra()
6825 * or defaultValue if none was found.
6826 *
6827 * @see #putExtra
6828 *
6829 * @deprecated
6830 * @hide
6831 */
6832 @Deprecated
6833 public Object getExtra(String name, Object defaultValue) {
6834 Object result = defaultValue;
6835 if (mExtras != null) {
6836 Object result2 = mExtras.get(name);
6837 if (result2 != null) {
6838 result = result2;
6839 }
6840 }
6841
6842 return result;
6843 }
6844
6845 /**
6846 * Retrieves a map of extended data from the intent.
6847 *
6848 * @return the map of all extras previously added with putExtra(),
6849 * or null if none have been added.
6850 */
6851 public Bundle getExtras() {
6852 return (mExtras != null)
6853 ? new Bundle(mExtras)
6854 : null;
6855 }
6856
6857 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006858 * Filter extras to only basic types.
6859 * @hide
6860 */
6861 public void removeUnsafeExtras() {
6862 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006863 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006864 }
6865 }
6866
6867 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006868 * Retrieve any special flags associated with this intent. You will
6869 * normally just set them with {@link #setFlags} and let the system
6870 * take the appropriate action with them.
6871 *
6872 * @return int The currently set flags.
6873 *
6874 * @see #setFlags
6875 */
6876 public int getFlags() {
6877 return mFlags;
6878 }
6879
Dianne Hackborne7f97212011-02-24 14:40:20 -08006880 /** @hide */
6881 public boolean isExcludingStopped() {
6882 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6883 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6884 }
6885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006886 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006887 * Retrieve the application package name this Intent is limited to. When
6888 * resolving an Intent, if non-null this limits the resolution to only
6889 * components in the given application package.
6890 *
6891 * @return The name of the application package for the Intent.
6892 *
6893 * @see #resolveActivity
6894 * @see #setPackage
6895 */
6896 public String getPackage() {
6897 return mPackage;
6898 }
6899
6900 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006901 * Retrieve the concrete component associated with the intent. When receiving
6902 * an intent, this is the component that was found to best handle it (that is,
6903 * yourself) and will always be non-null; in all other cases it will be
6904 * null unless explicitly set.
6905 *
6906 * @return The name of the application component to handle the intent.
6907 *
6908 * @see #resolveActivity
6909 * @see #setComponent
6910 */
6911 public ComponentName getComponent() {
6912 return mComponent;
6913 }
6914
6915 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006916 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6917 * used as a hint to the receiver for animations and the like. Null means that there
6918 * is no source bounds.
6919 */
6920 public Rect getSourceBounds() {
6921 return mSourceBounds;
6922 }
6923
6924 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006925 * Return the Activity component that should be used to handle this intent.
6926 * The appropriate component is determined based on the information in the
6927 * intent, evaluated as follows:
6928 *
6929 * <p>If {@link #getComponent} returns an explicit class, that is returned
6930 * without any further consideration.
6931 *
6932 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6933 * category to be considered.
6934 *
6935 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6936 * action.
6937 *
6938 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6939 * this type.
6940 *
6941 * <p>If {@link #addCategory} has added any categories, the activity must
6942 * handle ALL of the categories specified.
6943 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006944 * <p>If {@link #getPackage} is non-NULL, only activity components in
6945 * that application package will be considered.
6946 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006947 * <p>If there are no activities that satisfy all of these conditions, a
6948 * null string is returned.
6949 *
6950 * <p>If multiple activities are found to satisfy the intent, the one with
6951 * the highest priority will be used. If there are multiple activities
6952 * with the same priority, the system will either pick the best activity
6953 * based on user preference, or resolve to a system class that will allow
6954 * the user to pick an activity and forward from there.
6955 *
6956 * <p>This method is implemented simply by calling
6957 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6958 * true.</p>
6959 * <p> This API is called for you as part of starting an activity from an
6960 * intent. You do not normally need to call it yourself.</p>
6961 *
6962 * @param pm The package manager with which to resolve the Intent.
6963 *
6964 * @return Name of the component implementing an activity that can
6965 * display the intent.
6966 *
6967 * @see #setComponent
6968 * @see #getComponent
6969 * @see #resolveActivityInfo
6970 */
6971 public ComponentName resolveActivity(PackageManager pm) {
6972 if (mComponent != null) {
6973 return mComponent;
6974 }
6975
6976 ResolveInfo info = pm.resolveActivity(
6977 this, PackageManager.MATCH_DEFAULT_ONLY);
6978 if (info != null) {
6979 return new ComponentName(
6980 info.activityInfo.applicationInfo.packageName,
6981 info.activityInfo.name);
6982 }
6983
6984 return null;
6985 }
6986
6987 /**
6988 * Resolve the Intent into an {@link ActivityInfo}
6989 * describing the activity that should execute the intent. Resolution
6990 * follows the same rules as described for {@link #resolveActivity}, but
6991 * you get back the completely information about the resolved activity
6992 * instead of just its class name.
6993 *
6994 * @param pm The package manager with which to resolve the Intent.
6995 * @param flags Addition information to retrieve as per
6996 * {@link PackageManager#getActivityInfo(ComponentName, int)
6997 * PackageManager.getActivityInfo()}.
6998 *
6999 * @return PackageManager.ActivityInfo
7000 *
7001 * @see #resolveActivity
7002 */
7003 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
7004 ActivityInfo ai = null;
7005 if (mComponent != null) {
7006 try {
7007 ai = pm.getActivityInfo(mComponent, flags);
7008 } catch (PackageManager.NameNotFoundException e) {
7009 // ignore
7010 }
7011 } else {
7012 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007013 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007014 if (info != null) {
7015 ai = info.activityInfo;
7016 }
7017 }
7018
7019 return ai;
7020 }
7021
7022 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007023 * Special function for use by the system to resolve service
7024 * intents to system apps. Throws an exception if there are
7025 * multiple potential matches to the Intent. Returns null if
7026 * there are no matches.
7027 * @hide
7028 */
7029 public ComponentName resolveSystemService(PackageManager pm, int flags) {
7030 if (mComponent != null) {
7031 return mComponent;
7032 }
7033
7034 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7035 if (results == null) {
7036 return null;
7037 }
7038 ComponentName comp = null;
7039 for (int i=0; i<results.size(); i++) {
7040 ResolveInfo ri = results.get(i);
7041 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7042 continue;
7043 }
7044 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7045 ri.serviceInfo.name);
7046 if (comp != null) {
7047 throw new IllegalStateException("Multiple system services handle " + this
7048 + ": " + comp + ", " + foundComp);
7049 }
7050 comp = foundComp;
7051 }
7052 return comp;
7053 }
7054
7055 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007056 * Set the general action to be performed.
7057 *
7058 * @param action An action name, such as ACTION_VIEW. Application-specific
7059 * actions should be prefixed with the vendor's package name.
7060 *
7061 * @return Returns the same Intent object, for chaining multiple calls
7062 * into a single statement.
7063 *
7064 * @see #getAction
7065 */
7066 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007067 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007068 return this;
7069 }
7070
7071 /**
7072 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007073 * clears any type that was previously set by {@link #setType} or
7074 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007075 *
Nick Pellyccae4122012-01-09 14:12:58 -08007076 * <p><em>Note: scheme matching in the Android framework is
7077 * case-sensitive, unlike the formal RFC. As a result,
7078 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007079 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007080 * {@link #setDataAndNormalize}
7081 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007082 *
Nick Pellyccae4122012-01-09 14:12:58 -08007083 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007084 *
7085 * @return Returns the same Intent object, for chaining multiple calls
7086 * into a single statement.
7087 *
7088 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007089 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007090 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007091 */
7092 public Intent setData(Uri data) {
7093 mData = data;
7094 mType = null;
7095 return this;
7096 }
7097
7098 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007099 * Normalize and set the data this intent is operating on.
7100 *
7101 * <p>This method automatically clears any type that was
7102 * previously set (for example, by {@link #setType}).
7103 *
7104 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007105 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007106 * so really this is just a convenience method for
7107 * <pre>
7108 * setData(data.normalize())
7109 * </pre>
7110 *
7111 * @param data The Uri of the data this intent is now targeting.
7112 *
7113 * @return Returns the same Intent object, for chaining multiple calls
7114 * into a single statement.
7115 *
7116 * @see #getData
7117 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007118 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007119 */
7120 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007121 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007122 }
7123
7124 /**
7125 * Set an explicit MIME data type.
7126 *
7127 * <p>This is used to create intents that only specify a type and not data,
7128 * for example to indicate the type of data to return.
7129 *
7130 * <p>This method automatically clears any data that was
7131 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007132 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007133 * <p><em>Note: MIME type matching in the Android framework is
7134 * case-sensitive, unlike formal RFC MIME types. As a result,
7135 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007136 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7137 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007138 *
7139 * @param type The MIME type of the data being handled by this intent.
7140 *
7141 * @return Returns the same Intent object, for chaining multiple calls
7142 * into a single statement.
7143 *
7144 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007145 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007146 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007147 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007148 */
7149 public Intent setType(String type) {
7150 mData = null;
7151 mType = type;
7152 return this;
7153 }
7154
7155 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007156 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007157 *
Nick Pellyccae4122012-01-09 14:12:58 -08007158 * <p>This is used to create intents that only specify a type and not data,
7159 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007160 *
Nick Pellyccae4122012-01-09 14:12:58 -08007161 * <p>This method automatically clears any data that was
7162 * previously set (for example by {@link #setData}).
7163 *
7164 * <p>The MIME type is normalized using
7165 * {@link #normalizeMimeType} before it is set,
7166 * so really this is just a convenience method for
7167 * <pre>
7168 * setType(Intent.normalizeMimeType(type))
7169 * </pre>
7170 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007171 * @param type The MIME type of the data being handled by this intent.
7172 *
7173 * @return Returns the same Intent object, for chaining multiple calls
7174 * into a single statement.
7175 *
Nick Pellyccae4122012-01-09 14:12:58 -08007176 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007177 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007178 * @see #normalizeMimeType
7179 */
7180 public Intent setTypeAndNormalize(String type) {
7181 return setType(normalizeMimeType(type));
7182 }
7183
7184 /**
7185 * (Usually optional) Set the data for the intent along with an explicit
7186 * MIME data type. This method should very rarely be used -- it allows you
7187 * to override the MIME type that would ordinarily be inferred from the
7188 * data with your own type given here.
7189 *
7190 * <p><em>Note: MIME type and Uri scheme matching in the
7191 * Android framework is case-sensitive, unlike the formal RFC definitions.
7192 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007193 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007194 * {@link #setDataAndTypeAndNormalize}
7195 * to ensure that they are converted to lower case.</em>
7196 *
7197 * @param data The Uri of the data this intent is now targeting.
7198 * @param type The MIME type of the data being handled by this intent.
7199 *
7200 * @return Returns the same Intent object, for chaining multiple calls
7201 * into a single statement.
7202 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007203 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007204 * @see #setData
7205 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007206 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007207 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007208 */
7209 public Intent setDataAndType(Uri data, String type) {
7210 mData = data;
7211 mType = type;
7212 return this;
7213 }
7214
7215 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007216 * (Usually optional) Normalize and set both the data Uri and an explicit
7217 * MIME data type. This method should very rarely be used -- it allows you
7218 * to override the MIME type that would ordinarily be inferred from the
7219 * data with your own type given here.
7220 *
7221 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007222 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007223 * before they are set, so really this is just a convenience method for
7224 * <pre>
7225 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7226 * </pre>
7227 *
7228 * @param data The Uri of the data this intent is now targeting.
7229 * @param type The MIME type of the data being handled by this intent.
7230 *
7231 * @return Returns the same Intent object, for chaining multiple calls
7232 * into a single statement.
7233 *
7234 * @see #setType
7235 * @see #setData
7236 * @see #setDataAndType
7237 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007238 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007239 */
7240 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007241 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007242 }
7243
7244 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007245 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007246 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007247 * activities that provide <em>all</em> of the requested categories will be
7248 * used.
7249 *
7250 * @param category The desired category. This can be either one of the
7251 * predefined Intent categories, or a custom category in your own
7252 * namespace.
7253 *
7254 * @return Returns the same Intent object, for chaining multiple calls
7255 * into a single statement.
7256 *
7257 * @see #hasCategory
7258 * @see #removeCategory
7259 */
7260 public Intent addCategory(String category) {
7261 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007262 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007263 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007264 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007265 return this;
7266 }
7267
7268 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007269 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007270 *
7271 * @param category The category to remove.
7272 *
7273 * @see #addCategory
7274 */
7275 public void removeCategory(String category) {
7276 if (mCategories != null) {
7277 mCategories.remove(category);
7278 if (mCategories.size() == 0) {
7279 mCategories = null;
7280 }
7281 }
7282 }
7283
7284 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007285 * Set a selector for this Intent. This is a modification to the kinds of
7286 * things the Intent will match. If the selector is set, it will be used
7287 * when trying to find entities that can handle the Intent, instead of the
7288 * main contents of the Intent. This allows you build an Intent containing
7289 * a generic protocol while targeting it more specifically.
7290 *
7291 * <p>An example of where this may be used is with things like
7292 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7293 * Intent that will launch the Browser application. However, the correct
7294 * main entry point of an application is actually {@link #ACTION_MAIN}
7295 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7296 * used to specify the actual Activity to launch. If you launch the browser
7297 * with something different, undesired behavior may happen if the user has
7298 * previously or later launches it the normal way, since they do not match.
7299 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7300 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7301 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7302 *
7303 * <p>Setting a selector does not impact the behavior of
7304 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7305 * desired behavior of a selector -- it does not impact the base meaning
7306 * of the Intent, just what kinds of things will be matched against it
7307 * when determining who can handle it.</p>
7308 *
7309 * <p>You can not use both a selector and {@link #setPackage(String)} on
7310 * the same base Intent.</p>
7311 *
7312 * @param selector The desired selector Intent; set to null to not use
7313 * a special selector.
7314 */
7315 public void setSelector(Intent selector) {
7316 if (selector == this) {
7317 throw new IllegalArgumentException(
7318 "Intent being set as a selector of itself");
7319 }
7320 if (selector != null && mPackage != null) {
7321 throw new IllegalArgumentException(
7322 "Can't set selector when package name is already set");
7323 }
7324 mSelector = selector;
7325 }
7326
7327 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007328 * Set a {@link ClipData} associated with this Intent. This replaces any
7329 * previously set ClipData.
7330 *
7331 * <p>The ClipData in an intent is not used for Intent matching or other
7332 * such operations. Semantically it is like extras, used to transmit
7333 * additional data with the Intent. The main feature of using this over
7334 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7335 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7336 * items included in the clip data. This is useful, in particular, if
7337 * you want to transmit an Intent containing multiple <code>content:</code>
7338 * URIs for which the recipient may not have global permission to access the
7339 * content provider.
7340 *
7341 * <p>If the ClipData contains items that are themselves Intents, any
7342 * grant flags in those Intents will be ignored. Only the top-level flags
7343 * of the main Intent are respected, and will be applied to all Uri or
7344 * Intent items in the clip (or sub-items of the clip).
7345 *
7346 * <p>The MIME type, label, and icon in the ClipData object are not
7347 * directly used by Intent. Applications should generally rely on the
7348 * MIME type of the Intent itself, not what it may find in the ClipData.
7349 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007350 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007351 *
7352 * @param clip The new clip to set. May be null to clear the current clip.
7353 */
7354 public void setClipData(ClipData clip) {
7355 mClipData = clip;
7356 }
7357
7358 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007359 * This is NOT a secure mechanism to identify the user who sent the intent.
7360 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7361 * who sent the intent.
7362 * @hide
7363 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007364 public void prepareToLeaveUser(int userId) {
7365 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7366 // We want mContentUserHint to refer to the original user, so don't do anything.
7367 if (mContentUserHint == UserHandle.USER_CURRENT) {
7368 mContentUserHint = userId;
7369 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007370 }
7371
7372 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007373 * Add extended data to the intent. The name must include a package
7374 * prefix, for example the app com.android.contacts would use names
7375 * like "com.android.contacts.ShowAll".
7376 *
7377 * @param name The name of the extra data, with package prefix.
7378 * @param value The boolean data value.
7379 *
7380 * @return Returns the same Intent object, for chaining multiple calls
7381 * into a single statement.
7382 *
7383 * @see #putExtras
7384 * @see #removeExtra
7385 * @see #getBooleanExtra(String, boolean)
7386 */
7387 public Intent putExtra(String name, boolean value) {
7388 if (mExtras == null) {
7389 mExtras = new Bundle();
7390 }
7391 mExtras.putBoolean(name, value);
7392 return this;
7393 }
7394
7395 /**
7396 * Add extended data to the intent. The name must include a package
7397 * prefix, for example the app com.android.contacts would use names
7398 * like "com.android.contacts.ShowAll".
7399 *
7400 * @param name The name of the extra data, with package prefix.
7401 * @param value The byte data value.
7402 *
7403 * @return Returns the same Intent object, for chaining multiple calls
7404 * into a single statement.
7405 *
7406 * @see #putExtras
7407 * @see #removeExtra
7408 * @see #getByteExtra(String, byte)
7409 */
7410 public Intent putExtra(String name, byte value) {
7411 if (mExtras == null) {
7412 mExtras = new Bundle();
7413 }
7414 mExtras.putByte(name, value);
7415 return this;
7416 }
7417
7418 /**
7419 * Add extended data to the intent. The name must include a package
7420 * prefix, for example the app com.android.contacts would use names
7421 * like "com.android.contacts.ShowAll".
7422 *
7423 * @param name The name of the extra data, with package prefix.
7424 * @param value The char data value.
7425 *
7426 * @return Returns the same Intent object, for chaining multiple calls
7427 * into a single statement.
7428 *
7429 * @see #putExtras
7430 * @see #removeExtra
7431 * @see #getCharExtra(String, char)
7432 */
7433 public Intent putExtra(String name, char value) {
7434 if (mExtras == null) {
7435 mExtras = new Bundle();
7436 }
7437 mExtras.putChar(name, value);
7438 return this;
7439 }
7440
7441 /**
7442 * Add extended data to the intent. The name must include a package
7443 * prefix, for example the app com.android.contacts would use names
7444 * like "com.android.contacts.ShowAll".
7445 *
7446 * @param name The name of the extra data, with package prefix.
7447 * @param value The short data value.
7448 *
7449 * @return Returns the same Intent object, for chaining multiple calls
7450 * into a single statement.
7451 *
7452 * @see #putExtras
7453 * @see #removeExtra
7454 * @see #getShortExtra(String, short)
7455 */
7456 public Intent putExtra(String name, short value) {
7457 if (mExtras == null) {
7458 mExtras = new Bundle();
7459 }
7460 mExtras.putShort(name, value);
7461 return this;
7462 }
7463
7464 /**
7465 * Add extended data to the intent. The name must include a package
7466 * prefix, for example the app com.android.contacts would use names
7467 * like "com.android.contacts.ShowAll".
7468 *
7469 * @param name The name of the extra data, with package prefix.
7470 * @param value The integer data value.
7471 *
7472 * @return Returns the same Intent object, for chaining multiple calls
7473 * into a single statement.
7474 *
7475 * @see #putExtras
7476 * @see #removeExtra
7477 * @see #getIntExtra(String, int)
7478 */
7479 public Intent putExtra(String name, int value) {
7480 if (mExtras == null) {
7481 mExtras = new Bundle();
7482 }
7483 mExtras.putInt(name, value);
7484 return this;
7485 }
7486
7487 /**
7488 * Add extended data to the intent. The name must include a package
7489 * prefix, for example the app com.android.contacts would use names
7490 * like "com.android.contacts.ShowAll".
7491 *
7492 * @param name The name of the extra data, with package prefix.
7493 * @param value The long data value.
7494 *
7495 * @return Returns the same Intent object, for chaining multiple calls
7496 * into a single statement.
7497 *
7498 * @see #putExtras
7499 * @see #removeExtra
7500 * @see #getLongExtra(String, long)
7501 */
7502 public Intent putExtra(String name, long value) {
7503 if (mExtras == null) {
7504 mExtras = new Bundle();
7505 }
7506 mExtras.putLong(name, value);
7507 return this;
7508 }
7509
7510 /**
7511 * Add extended data to the intent. The name must include a package
7512 * prefix, for example the app com.android.contacts would use names
7513 * like "com.android.contacts.ShowAll".
7514 *
7515 * @param name The name of the extra data, with package prefix.
7516 * @param value The float data value.
7517 *
7518 * @return Returns the same Intent object, for chaining multiple calls
7519 * into a single statement.
7520 *
7521 * @see #putExtras
7522 * @see #removeExtra
7523 * @see #getFloatExtra(String, float)
7524 */
7525 public Intent putExtra(String name, float value) {
7526 if (mExtras == null) {
7527 mExtras = new Bundle();
7528 }
7529 mExtras.putFloat(name, value);
7530 return this;
7531 }
7532
7533 /**
7534 * Add extended data to the intent. The name must include a package
7535 * prefix, for example the app com.android.contacts would use names
7536 * like "com.android.contacts.ShowAll".
7537 *
7538 * @param name The name of the extra data, with package prefix.
7539 * @param value The double data value.
7540 *
7541 * @return Returns the same Intent object, for chaining multiple calls
7542 * into a single statement.
7543 *
7544 * @see #putExtras
7545 * @see #removeExtra
7546 * @see #getDoubleExtra(String, double)
7547 */
7548 public Intent putExtra(String name, double value) {
7549 if (mExtras == null) {
7550 mExtras = new Bundle();
7551 }
7552 mExtras.putDouble(name, value);
7553 return this;
7554 }
7555
7556 /**
7557 * Add extended data to the intent. The name must include a package
7558 * prefix, for example the app com.android.contacts would use names
7559 * like "com.android.contacts.ShowAll".
7560 *
7561 * @param name The name of the extra data, with package prefix.
7562 * @param value The String data value.
7563 *
7564 * @return Returns the same Intent object, for chaining multiple calls
7565 * into a single statement.
7566 *
7567 * @see #putExtras
7568 * @see #removeExtra
7569 * @see #getStringExtra(String)
7570 */
7571 public Intent putExtra(String name, String value) {
7572 if (mExtras == null) {
7573 mExtras = new Bundle();
7574 }
7575 mExtras.putString(name, value);
7576 return this;
7577 }
7578
7579 /**
7580 * Add extended data to the intent. The name must include a package
7581 * prefix, for example the app com.android.contacts would use names
7582 * like "com.android.contacts.ShowAll".
7583 *
7584 * @param name The name of the extra data, with package prefix.
7585 * @param value The CharSequence data value.
7586 *
7587 * @return Returns the same Intent object, for chaining multiple calls
7588 * into a single statement.
7589 *
7590 * @see #putExtras
7591 * @see #removeExtra
7592 * @see #getCharSequenceExtra(String)
7593 */
7594 public Intent putExtra(String name, CharSequence value) {
7595 if (mExtras == null) {
7596 mExtras = new Bundle();
7597 }
7598 mExtras.putCharSequence(name, value);
7599 return this;
7600 }
7601
7602 /**
7603 * Add extended data to the intent. The name must include a package
7604 * prefix, for example the app com.android.contacts would use names
7605 * like "com.android.contacts.ShowAll".
7606 *
7607 * @param name The name of the extra data, with package prefix.
7608 * @param value The Parcelable data value.
7609 *
7610 * @return Returns the same Intent object, for chaining multiple calls
7611 * into a single statement.
7612 *
7613 * @see #putExtras
7614 * @see #removeExtra
7615 * @see #getParcelableExtra(String)
7616 */
7617 public Intent putExtra(String name, Parcelable value) {
7618 if (mExtras == null) {
7619 mExtras = new Bundle();
7620 }
7621 mExtras.putParcelable(name, value);
7622 return this;
7623 }
7624
7625 /**
7626 * Add extended data to the intent. The name must include a package
7627 * prefix, for example the app com.android.contacts would use names
7628 * like "com.android.contacts.ShowAll".
7629 *
7630 * @param name The name of the extra data, with package prefix.
7631 * @param value The Parcelable[] data value.
7632 *
7633 * @return Returns the same Intent object, for chaining multiple calls
7634 * into a single statement.
7635 *
7636 * @see #putExtras
7637 * @see #removeExtra
7638 * @see #getParcelableArrayExtra(String)
7639 */
7640 public Intent putExtra(String name, Parcelable[] value) {
7641 if (mExtras == null) {
7642 mExtras = new Bundle();
7643 }
7644 mExtras.putParcelableArray(name, value);
7645 return this;
7646 }
7647
7648 /**
7649 * Add extended data to the intent. The name must include a package
7650 * prefix, for example the app com.android.contacts would use names
7651 * like "com.android.contacts.ShowAll".
7652 *
7653 * @param name The name of the extra data, with package prefix.
7654 * @param value The ArrayList<Parcelable> data value.
7655 *
7656 * @return Returns the same Intent object, for chaining multiple calls
7657 * into a single statement.
7658 *
7659 * @see #putExtras
7660 * @see #removeExtra
7661 * @see #getParcelableArrayListExtra(String)
7662 */
7663 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7664 if (mExtras == null) {
7665 mExtras = new Bundle();
7666 }
7667 mExtras.putParcelableArrayList(name, value);
7668 return this;
7669 }
7670
7671 /**
7672 * Add extended data to the intent. The name must include a package
7673 * prefix, for example the app com.android.contacts would use names
7674 * like "com.android.contacts.ShowAll".
7675 *
7676 * @param name The name of the extra data, with package prefix.
7677 * @param value The ArrayList<Integer> data value.
7678 *
7679 * @return Returns the same Intent object, for chaining multiple calls
7680 * into a single statement.
7681 *
7682 * @see #putExtras
7683 * @see #removeExtra
7684 * @see #getIntegerArrayListExtra(String)
7685 */
7686 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7687 if (mExtras == null) {
7688 mExtras = new Bundle();
7689 }
7690 mExtras.putIntegerArrayList(name, value);
7691 return this;
7692 }
7693
7694 /**
7695 * Add extended data to the intent. The name must include a package
7696 * prefix, for example the app com.android.contacts would use names
7697 * like "com.android.contacts.ShowAll".
7698 *
7699 * @param name The name of the extra data, with package prefix.
7700 * @param value The ArrayList<String> data value.
7701 *
7702 * @return Returns the same Intent object, for chaining multiple calls
7703 * into a single statement.
7704 *
7705 * @see #putExtras
7706 * @see #removeExtra
7707 * @see #getStringArrayListExtra(String)
7708 */
7709 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7710 if (mExtras == null) {
7711 mExtras = new Bundle();
7712 }
7713 mExtras.putStringArrayList(name, value);
7714 return this;
7715 }
7716
7717 /**
7718 * Add extended data to the intent. The name must include a package
7719 * prefix, for example the app com.android.contacts would use names
7720 * like "com.android.contacts.ShowAll".
7721 *
7722 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007723 * @param value The ArrayList<CharSequence> data value.
7724 *
7725 * @return Returns the same Intent object, for chaining multiple calls
7726 * into a single statement.
7727 *
7728 * @see #putExtras
7729 * @see #removeExtra
7730 * @see #getCharSequenceArrayListExtra(String)
7731 */
7732 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7733 if (mExtras == null) {
7734 mExtras = new Bundle();
7735 }
7736 mExtras.putCharSequenceArrayList(name, value);
7737 return this;
7738 }
7739
7740 /**
7741 * Add extended data to the intent. The name must include a package
7742 * prefix, for example the app com.android.contacts would use names
7743 * like "com.android.contacts.ShowAll".
7744 *
7745 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007746 * @param value The Serializable data value.
7747 *
7748 * @return Returns the same Intent object, for chaining multiple calls
7749 * into a single statement.
7750 *
7751 * @see #putExtras
7752 * @see #removeExtra
7753 * @see #getSerializableExtra(String)
7754 */
7755 public Intent putExtra(String name, Serializable value) {
7756 if (mExtras == null) {
7757 mExtras = new Bundle();
7758 }
7759 mExtras.putSerializable(name, value);
7760 return this;
7761 }
7762
7763 /**
7764 * Add extended data to the intent. The name must include a package
7765 * prefix, for example the app com.android.contacts would use names
7766 * like "com.android.contacts.ShowAll".
7767 *
7768 * @param name The name of the extra data, with package prefix.
7769 * @param value The boolean array data value.
7770 *
7771 * @return Returns the same Intent object, for chaining multiple calls
7772 * into a single statement.
7773 *
7774 * @see #putExtras
7775 * @see #removeExtra
7776 * @see #getBooleanArrayExtra(String)
7777 */
7778 public Intent putExtra(String name, boolean[] value) {
7779 if (mExtras == null) {
7780 mExtras = new Bundle();
7781 }
7782 mExtras.putBooleanArray(name, value);
7783 return this;
7784 }
7785
7786 /**
7787 * Add extended data to the intent. The name must include a package
7788 * prefix, for example the app com.android.contacts would use names
7789 * like "com.android.contacts.ShowAll".
7790 *
7791 * @param name The name of the extra data, with package prefix.
7792 * @param value The byte array data value.
7793 *
7794 * @return Returns the same Intent object, for chaining multiple calls
7795 * into a single statement.
7796 *
7797 * @see #putExtras
7798 * @see #removeExtra
7799 * @see #getByteArrayExtra(String)
7800 */
7801 public Intent putExtra(String name, byte[] value) {
7802 if (mExtras == null) {
7803 mExtras = new Bundle();
7804 }
7805 mExtras.putByteArray(name, value);
7806 return this;
7807 }
7808
7809 /**
7810 * Add extended data to the intent. The name must include a package
7811 * prefix, for example the app com.android.contacts would use names
7812 * like "com.android.contacts.ShowAll".
7813 *
7814 * @param name The name of the extra data, with package prefix.
7815 * @param value The short array data value.
7816 *
7817 * @return Returns the same Intent object, for chaining multiple calls
7818 * into a single statement.
7819 *
7820 * @see #putExtras
7821 * @see #removeExtra
7822 * @see #getShortArrayExtra(String)
7823 */
7824 public Intent putExtra(String name, short[] value) {
7825 if (mExtras == null) {
7826 mExtras = new Bundle();
7827 }
7828 mExtras.putShortArray(name, value);
7829 return this;
7830 }
7831
7832 /**
7833 * Add extended data to the intent. The name must include a package
7834 * prefix, for example the app com.android.contacts would use names
7835 * like "com.android.contacts.ShowAll".
7836 *
7837 * @param name The name of the extra data, with package prefix.
7838 * @param value The char array data value.
7839 *
7840 * @return Returns the same Intent object, for chaining multiple calls
7841 * into a single statement.
7842 *
7843 * @see #putExtras
7844 * @see #removeExtra
7845 * @see #getCharArrayExtra(String)
7846 */
7847 public Intent putExtra(String name, char[] value) {
7848 if (mExtras == null) {
7849 mExtras = new Bundle();
7850 }
7851 mExtras.putCharArray(name, value);
7852 return this;
7853 }
7854
7855 /**
7856 * Add extended data to the intent. The name must include a package
7857 * prefix, for example the app com.android.contacts would use names
7858 * like "com.android.contacts.ShowAll".
7859 *
7860 * @param name The name of the extra data, with package prefix.
7861 * @param value The int array data value.
7862 *
7863 * @return Returns the same Intent object, for chaining multiple calls
7864 * into a single statement.
7865 *
7866 * @see #putExtras
7867 * @see #removeExtra
7868 * @see #getIntArrayExtra(String)
7869 */
7870 public Intent putExtra(String name, int[] value) {
7871 if (mExtras == null) {
7872 mExtras = new Bundle();
7873 }
7874 mExtras.putIntArray(name, value);
7875 return this;
7876 }
7877
7878 /**
7879 * Add extended data to the intent. The name must include a package
7880 * prefix, for example the app com.android.contacts would use names
7881 * like "com.android.contacts.ShowAll".
7882 *
7883 * @param name The name of the extra data, with package prefix.
7884 * @param value The byte array data value.
7885 *
7886 * @return Returns the same Intent object, for chaining multiple calls
7887 * into a single statement.
7888 *
7889 * @see #putExtras
7890 * @see #removeExtra
7891 * @see #getLongArrayExtra(String)
7892 */
7893 public Intent putExtra(String name, long[] value) {
7894 if (mExtras == null) {
7895 mExtras = new Bundle();
7896 }
7897 mExtras.putLongArray(name, value);
7898 return this;
7899 }
7900
7901 /**
7902 * Add extended data to the intent. The name must include a package
7903 * prefix, for example the app com.android.contacts would use names
7904 * like "com.android.contacts.ShowAll".
7905 *
7906 * @param name The name of the extra data, with package prefix.
7907 * @param value The float array data value.
7908 *
7909 * @return Returns the same Intent object, for chaining multiple calls
7910 * into a single statement.
7911 *
7912 * @see #putExtras
7913 * @see #removeExtra
7914 * @see #getFloatArrayExtra(String)
7915 */
7916 public Intent putExtra(String name, float[] value) {
7917 if (mExtras == null) {
7918 mExtras = new Bundle();
7919 }
7920 mExtras.putFloatArray(name, value);
7921 return this;
7922 }
7923
7924 /**
7925 * Add extended data to the intent. The name must include a package
7926 * prefix, for example the app com.android.contacts would use names
7927 * like "com.android.contacts.ShowAll".
7928 *
7929 * @param name The name of the extra data, with package prefix.
7930 * @param value The double array data value.
7931 *
7932 * @return Returns the same Intent object, for chaining multiple calls
7933 * into a single statement.
7934 *
7935 * @see #putExtras
7936 * @see #removeExtra
7937 * @see #getDoubleArrayExtra(String)
7938 */
7939 public Intent putExtra(String name, double[] value) {
7940 if (mExtras == null) {
7941 mExtras = new Bundle();
7942 }
7943 mExtras.putDoubleArray(name, value);
7944 return this;
7945 }
7946
7947 /**
7948 * Add extended data to the intent. The name must include a package
7949 * prefix, for example the app com.android.contacts would use names
7950 * like "com.android.contacts.ShowAll".
7951 *
7952 * @param name The name of the extra data, with package prefix.
7953 * @param value The String array data value.
7954 *
7955 * @return Returns the same Intent object, for chaining multiple calls
7956 * into a single statement.
7957 *
7958 * @see #putExtras
7959 * @see #removeExtra
7960 * @see #getStringArrayExtra(String)
7961 */
7962 public Intent putExtra(String name, String[] value) {
7963 if (mExtras == null) {
7964 mExtras = new Bundle();
7965 }
7966 mExtras.putStringArray(name, value);
7967 return this;
7968 }
7969
7970 /**
7971 * Add extended data to the intent. The name must include a package
7972 * prefix, for example the app com.android.contacts would use names
7973 * like "com.android.contacts.ShowAll".
7974 *
7975 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007976 * @param value The CharSequence array data value.
7977 *
7978 * @return Returns the same Intent object, for chaining multiple calls
7979 * into a single statement.
7980 *
7981 * @see #putExtras
7982 * @see #removeExtra
7983 * @see #getCharSequenceArrayExtra(String)
7984 */
7985 public Intent putExtra(String name, CharSequence[] value) {
7986 if (mExtras == null) {
7987 mExtras = new Bundle();
7988 }
7989 mExtras.putCharSequenceArray(name, value);
7990 return this;
7991 }
7992
7993 /**
7994 * Add extended data to the intent. The name must include a package
7995 * prefix, for example the app com.android.contacts would use names
7996 * like "com.android.contacts.ShowAll".
7997 *
7998 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007999 * @param value The Bundle data value.
8000 *
8001 * @return Returns the same Intent object, for chaining multiple calls
8002 * into a single statement.
8003 *
8004 * @see #putExtras
8005 * @see #removeExtra
8006 * @see #getBundleExtra(String)
8007 */
8008 public Intent putExtra(String name, Bundle value) {
8009 if (mExtras == null) {
8010 mExtras = new Bundle();
8011 }
8012 mExtras.putBundle(name, value);
8013 return this;
8014 }
8015
8016 /**
8017 * Add extended data to the intent. The name must include a package
8018 * prefix, for example the app com.android.contacts would use names
8019 * like "com.android.contacts.ShowAll".
8020 *
8021 * @param name The name of the extra data, with package prefix.
8022 * @param value The IBinder data value.
8023 *
8024 * @return Returns the same Intent object, for chaining multiple calls
8025 * into a single statement.
8026 *
8027 * @see #putExtras
8028 * @see #removeExtra
8029 * @see #getIBinderExtra(String)
8030 *
8031 * @deprecated
8032 * @hide
8033 */
8034 @Deprecated
8035 public Intent putExtra(String name, IBinder value) {
8036 if (mExtras == null) {
8037 mExtras = new Bundle();
8038 }
8039 mExtras.putIBinder(name, value);
8040 return this;
8041 }
8042
8043 /**
8044 * Copy all extras in 'src' in to this intent.
8045 *
8046 * @param src Contains the extras to copy.
8047 *
8048 * @see #putExtra
8049 */
8050 public Intent putExtras(Intent src) {
8051 if (src.mExtras != null) {
8052 if (mExtras == null) {
8053 mExtras = new Bundle(src.mExtras);
8054 } else {
8055 mExtras.putAll(src.mExtras);
8056 }
8057 }
8058 return this;
8059 }
8060
8061 /**
8062 * Add a set of extended data to the intent. The keys must include a package
8063 * prefix, for example the app com.android.contacts would use names
8064 * like "com.android.contacts.ShowAll".
8065 *
8066 * @param extras The Bundle of extras to add to this intent.
8067 *
8068 * @see #putExtra
8069 * @see #removeExtra
8070 */
8071 public Intent putExtras(Bundle extras) {
8072 if (mExtras == null) {
8073 mExtras = new Bundle();
8074 }
8075 mExtras.putAll(extras);
8076 return this;
8077 }
8078
8079 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008080 * Completely replace the extras in the Intent with the extras in the
8081 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008082 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008083 * @param src The exact extras contained in this Intent are copied
8084 * into the target intent, replacing any that were previously there.
8085 */
8086 public Intent replaceExtras(Intent src) {
8087 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8088 return this;
8089 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008090
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008091 /**
8092 * Completely replace the extras in the Intent with the given Bundle of
8093 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008094 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008095 * @param extras The new set of extras in the Intent, or null to erase
8096 * all extras.
8097 */
8098 public Intent replaceExtras(Bundle extras) {
8099 mExtras = extras != null ? new Bundle(extras) : null;
8100 return this;
8101 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008102
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008103 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008104 * Remove extended data from the intent.
8105 *
8106 * @see #putExtra
8107 */
8108 public void removeExtra(String name) {
8109 if (mExtras != null) {
8110 mExtras.remove(name);
8111 if (mExtras.size() == 0) {
8112 mExtras = null;
8113 }
8114 }
8115 }
8116
8117 /**
8118 * Set special flags controlling how this intent is handled. Most values
8119 * here depend on the type of component being executed by the Intent,
8120 * specifically the FLAG_ACTIVITY_* flags are all for use with
8121 * {@link Context#startActivity Context.startActivity()} and the
8122 * FLAG_RECEIVER_* flags are all for use with
8123 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8124 *
Scott Main7aee61f2011-02-08 11:25:01 -08008125 * <p>See the
8126 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8127 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008128 * the behavior of your application.
8129 *
8130 * @param flags The desired flags.
8131 *
8132 * @return Returns the same Intent object, for chaining multiple calls
8133 * into a single statement.
8134 *
8135 * @see #getFlags
8136 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008137 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008138 *
8139 * @see #FLAG_GRANT_READ_URI_PERMISSION
8140 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008141 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8142 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008143 * @see #FLAG_DEBUG_LOG_RESOLUTION
8144 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008145 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008146 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008147 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008148 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008149 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8150 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008151 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008152 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008153 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008154 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008155 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008156 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008157 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008158 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8159 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008160 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008161 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008162 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008163 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8164 */
8165 public Intent setFlags(int flags) {
8166 mFlags = flags;
8167 return this;
8168 }
8169
8170 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008171 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008172 *
8173 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008174 * @return Returns the same Intent object, for chaining multiple calls into
8175 * a single statement.
8176 * @see #setFlags(int)
8177 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008178 */
8179 public Intent addFlags(int flags) {
8180 mFlags |= flags;
8181 return this;
8182 }
8183
8184 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008185 * Remove these flags from the intent.
8186 *
8187 * @param flags The flags to remove.
8188 * @see #setFlags(int)
8189 * @see #addFlags(int)
8190 */
8191 public void removeFlags(int flags) {
8192 mFlags &= ~flags;
8193 }
8194
8195 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008196 * (Usually optional) Set an explicit application package name that limits
8197 * the components this Intent will resolve to. If left to the default
8198 * value of null, all components in all applications will considered.
8199 * If non-null, the Intent can only match the components in the given
8200 * application package.
8201 *
8202 * @param packageName The name of the application package to handle the
8203 * intent, or null to allow any application package.
8204 *
8205 * @return Returns the same Intent object, for chaining multiple calls
8206 * into a single statement.
8207 *
8208 * @see #getPackage
8209 * @see #resolveActivity
8210 */
8211 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008212 if (packageName != null && mSelector != null) {
8213 throw new IllegalArgumentException(
8214 "Can't set package name when selector is already set");
8215 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008216 mPackage = packageName;
8217 return this;
8218 }
8219
8220 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008221 * (Usually optional) Explicitly set the component to handle the intent.
8222 * If left with the default value of null, the system will determine the
8223 * appropriate class to use based on the other fields (action, data,
8224 * type, categories) in the Intent. If this class is defined, the
8225 * specified class will always be used regardless of the other fields. You
8226 * should only set this value when you know you absolutely want a specific
8227 * class to be used; otherwise it is better to let the system find the
8228 * appropriate class so that you will respect the installed applications
8229 * and user preferences.
8230 *
8231 * @param component The name of the application component to handle the
8232 * intent, or null to let the system find one for you.
8233 *
8234 * @return Returns the same Intent object, for chaining multiple calls
8235 * into a single statement.
8236 *
8237 * @see #setClass
8238 * @see #setClassName(Context, String)
8239 * @see #setClassName(String, String)
8240 * @see #getComponent
8241 * @see #resolveActivity
8242 */
8243 public Intent setComponent(ComponentName component) {
8244 mComponent = component;
8245 return this;
8246 }
8247
8248 /**
8249 * Convenience for calling {@link #setComponent} with an
8250 * explicit class name.
8251 *
8252 * @param packageContext A Context of the application package implementing
8253 * this class.
8254 * @param className The name of a class inside of the application package
8255 * that will be used as the component for this Intent.
8256 *
8257 * @return Returns the same Intent object, for chaining multiple calls
8258 * into a single statement.
8259 *
8260 * @see #setComponent
8261 * @see #setClass
8262 */
8263 public Intent setClassName(Context packageContext, String className) {
8264 mComponent = new ComponentName(packageContext, className);
8265 return this;
8266 }
8267
8268 /**
8269 * Convenience for calling {@link #setComponent} with an
8270 * explicit application package name and class name.
8271 *
8272 * @param packageName The name of the package implementing the desired
8273 * component.
8274 * @param className The name of a class inside of the application package
8275 * that will be used as the component for this Intent.
8276 *
8277 * @return Returns the same Intent object, for chaining multiple calls
8278 * into a single statement.
8279 *
8280 * @see #setComponent
8281 * @see #setClass
8282 */
8283 public Intent setClassName(String packageName, String className) {
8284 mComponent = new ComponentName(packageName, className);
8285 return this;
8286 }
8287
8288 /**
8289 * Convenience for calling {@link #setComponent(ComponentName)} with the
8290 * name returned by a {@link Class} object.
8291 *
8292 * @param packageContext A Context of the application package implementing
8293 * this class.
8294 * @param cls The class name to set, equivalent to
8295 * <code>setClassName(context, cls.getName())</code>.
8296 *
8297 * @return Returns the same Intent object, for chaining multiple calls
8298 * into a single statement.
8299 *
8300 * @see #setComponent
8301 */
8302 public Intent setClass(Context packageContext, Class<?> cls) {
8303 mComponent = new ComponentName(packageContext, cls);
8304 return this;
8305 }
8306
8307 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008308 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8309 * used as a hint to the receiver for animations and the like. Null means that there
8310 * is no source bounds.
8311 */
8312 public void setSourceBounds(Rect r) {
8313 if (r != null) {
8314 mSourceBounds = new Rect(r);
8315 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008316 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008317 }
8318 }
8319
Tor Norbyed9273d62013-05-30 15:59:53 -07008320 /** @hide */
8321 @IntDef(flag = true,
8322 value = {
8323 FILL_IN_ACTION,
8324 FILL_IN_DATA,
8325 FILL_IN_CATEGORIES,
8326 FILL_IN_COMPONENT,
8327 FILL_IN_PACKAGE,
8328 FILL_IN_SOURCE_BOUNDS,
8329 FILL_IN_SELECTOR,
8330 FILL_IN_CLIP_DATA
8331 })
8332 @Retention(RetentionPolicy.SOURCE)
8333 public @interface FillInFlags {}
8334
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008335 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008336 * Use with {@link #fillIn} to allow the current action value to be
8337 * overwritten, even if it is already set.
8338 */
8339 public static final int FILL_IN_ACTION = 1<<0;
8340
8341 /**
8342 * Use with {@link #fillIn} to allow the current data or type value
8343 * overwritten, even if it is already set.
8344 */
8345 public static final int FILL_IN_DATA = 1<<1;
8346
8347 /**
8348 * Use with {@link #fillIn} to allow the current categories to be
8349 * overwritten, even if they are already set.
8350 */
8351 public static final int FILL_IN_CATEGORIES = 1<<2;
8352
8353 /**
8354 * Use with {@link #fillIn} to allow the current component value to be
8355 * overwritten, even if it is already set.
8356 */
8357 public static final int FILL_IN_COMPONENT = 1<<3;
8358
8359 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008360 * Use with {@link #fillIn} to allow the current package value to be
8361 * overwritten, even if it is already set.
8362 */
8363 public static final int FILL_IN_PACKAGE = 1<<4;
8364
8365 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008366 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008367 * overwritten, even if it is already set.
8368 */
8369 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8370
8371 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008372 * Use with {@link #fillIn} to allow the current selector to be
8373 * overwritten, even if it is already set.
8374 */
8375 public static final int FILL_IN_SELECTOR = 1<<6;
8376
8377 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008378 * Use with {@link #fillIn} to allow the current ClipData to be
8379 * overwritten, even if it is already set.
8380 */
8381 public static final int FILL_IN_CLIP_DATA = 1<<7;
8382
8383 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008384 * Copy the contents of <var>other</var> in to this object, but only
8385 * where fields are not defined by this object. For purposes of a field
8386 * being defined, the following pieces of data in the Intent are
8387 * considered to be separate fields:
8388 *
8389 * <ul>
8390 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008391 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008392 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8393 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008394 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008395 * <li> component, as set by {@link #setComponent(ComponentName)} or
8396 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008397 * <li> source bounds, as set by {@link #setSourceBounds}.
8398 * <li> selector, as set by {@link #setSelector(Intent)}.
8399 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008400 * <li> each top-level name in the associated extras.
8401 * </ul>
8402 *
8403 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008404 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008405 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8406 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8407 * the restriction where the corresponding field will not be replaced if
8408 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008409 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008410 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8411 * is explicitly specified. The selector will only be copied if
8412 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008413 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008414 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8415 * and Intent B with {action="gotit", data-type="some/thing",
8416 * categories="one","two"}.
8417 *
8418 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8419 * containing: {action="gotit", data-type="some/thing",
8420 * categories="bar"}.
8421 *
8422 * @param other Another Intent whose values are to be used to fill in
8423 * the current one.
8424 * @param flags Options to control which fields can be filled in.
8425 *
8426 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008427 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008428 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008429 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008430 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008431 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008432 @FillInFlags
8433 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008434 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008435 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008436 if (other.mAction != null
8437 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008438 mAction = other.mAction;
8439 changes |= FILL_IN_ACTION;
8440 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008441 if ((other.mData != null || other.mType != null)
8442 && ((mData == null && mType == null)
8443 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008444 mData = other.mData;
8445 mType = other.mType;
8446 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008447 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008448 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008449 if (other.mCategories != null
8450 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008451 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008452 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008453 }
8454 changes |= FILL_IN_CATEGORIES;
8455 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008456 if (other.mPackage != null
8457 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008458 // Only do this if mSelector is not set.
8459 if (mSelector == null) {
8460 mPackage = other.mPackage;
8461 changes |= FILL_IN_PACKAGE;
8462 }
8463 }
8464 // Selector is special: it can only be set if explicitly allowed,
8465 // for the same reason as the component name.
8466 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8467 if (mPackage == null) {
8468 mSelector = new Intent(other.mSelector);
8469 mPackage = null;
8470 changes |= FILL_IN_SELECTOR;
8471 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008472 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008473 if (other.mClipData != null
8474 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8475 mClipData = other.mClipData;
8476 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008477 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008478 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008479 // Component is special: it can -only- be set if explicitly allowed,
8480 // since otherwise the sender could force the intent somewhere the
8481 // originator didn't intend.
8482 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008483 mComponent = other.mComponent;
8484 changes |= FILL_IN_COMPONENT;
8485 }
8486 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008487 if (other.mSourceBounds != null
8488 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8489 mSourceBounds = new Rect(other.mSourceBounds);
8490 changes |= FILL_IN_SOURCE_BOUNDS;
8491 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008492 if (mExtras == null) {
8493 if (other.mExtras != null) {
8494 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008495 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008496 }
8497 } else if (other.mExtras != null) {
8498 try {
8499 Bundle newb = new Bundle(other.mExtras);
8500 newb.putAll(mExtras);
8501 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008502 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008503 } catch (RuntimeException e) {
8504 // Modifying the extras can cause us to unparcel the contents
8505 // of the bundle, and if we do this in the system process that
8506 // may fail. We really should handle this (i.e., the Bundle
8507 // impl shouldn't be on top of a plain map), but for now just
8508 // ignore it and keep the original contents. :(
8509 Log.w("Intent", "Failure filling in extras", e);
8510 }
8511 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008512 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8513 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8514 mContentUserHint = other.mContentUserHint;
8515 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008516 return changes;
8517 }
8518
8519 /**
8520 * Wrapper class holding an Intent and implementing comparisons on it for
8521 * the purpose of filtering. The class implements its
8522 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8523 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8524 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8525 * on the wrapped Intent.
8526 */
8527 public static final class FilterComparison {
8528 private final Intent mIntent;
8529 private final int mHashCode;
8530
8531 public FilterComparison(Intent intent) {
8532 mIntent = intent;
8533 mHashCode = intent.filterHashCode();
8534 }
8535
8536 /**
8537 * Return the Intent that this FilterComparison represents.
8538 * @return Returns the Intent held by the FilterComparison. Do
8539 * not modify!
8540 */
8541 public Intent getIntent() {
8542 return mIntent;
8543 }
8544
8545 @Override
8546 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008547 if (obj instanceof FilterComparison) {
8548 Intent other = ((FilterComparison)obj).mIntent;
8549 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008550 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008551 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008552 }
8553
8554 @Override
8555 public int hashCode() {
8556 return mHashCode;
8557 }
8558 }
8559
8560 /**
8561 * Determine if two intents are the same for the purposes of intent
8562 * resolution (filtering). That is, if their action, data, type,
8563 * class, and categories are the same. This does <em>not</em> compare
8564 * any extra data included in the intents.
8565 *
8566 * @param other The other Intent to compare against.
8567 *
8568 * @return Returns true if action, data, type, class, and categories
8569 * are the same.
8570 */
8571 public boolean filterEquals(Intent other) {
8572 if (other == null) {
8573 return false;
8574 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008575 if (!Objects.equals(this.mAction, other.mAction)) return false;
8576 if (!Objects.equals(this.mData, other.mData)) return false;
8577 if (!Objects.equals(this.mType, other.mType)) return false;
8578 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8579 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8580 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008581
8582 return true;
8583 }
8584
8585 /**
8586 * Generate hash code that matches semantics of filterEquals().
8587 *
8588 * @return Returns the hash value of the action, data, type, class, and
8589 * categories.
8590 *
8591 * @see #filterEquals
8592 */
8593 public int filterHashCode() {
8594 int code = 0;
8595 if (mAction != null) {
8596 code += mAction.hashCode();
8597 }
8598 if (mData != null) {
8599 code += mData.hashCode();
8600 }
8601 if (mType != null) {
8602 code += mType.hashCode();
8603 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008604 if (mPackage != null) {
8605 code += mPackage.hashCode();
8606 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008607 if (mComponent != null) {
8608 code += mComponent.hashCode();
8609 }
8610 if (mCategories != null) {
8611 code += mCategories.hashCode();
8612 }
8613 return code;
8614 }
8615
8616 @Override
8617 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008618 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008619
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008620 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008621 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008622 b.append(" }");
8623
8624 return b.toString();
8625 }
8626
8627 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008628 public String toInsecureString() {
8629 StringBuilder b = new StringBuilder(128);
8630
8631 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008632 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008633 b.append(" }");
8634
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008635 return b.toString();
8636 }
Romain Guy4969af72009-06-17 10:53:19 -07008637
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008638 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008639 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008640 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008641
8642 b.append("Intent { ");
8643 toShortString(b, false, true, true, true);
8644 b.append(" }");
8645
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008646 return b.toString();
8647 }
8648
8649 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008650 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8651 StringBuilder b = new StringBuilder(128);
8652 toShortString(b, secure, comp, extras, clip);
8653 return b.toString();
8654 }
8655
8656 /** @hide */
8657 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8658 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008659 boolean first = true;
8660 if (mAction != null) {
8661 b.append("act=").append(mAction);
8662 first = false;
8663 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008664 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008665 if (!first) {
8666 b.append(' ');
8667 }
8668 first = false;
8669 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008670 for (int i=0; i<mCategories.size(); i++) {
8671 if (i > 0) b.append(',');
8672 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008673 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008674 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008675 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008676 if (mData != null) {
8677 if (!first) {
8678 b.append(' ');
8679 }
8680 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008681 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008682 if (secure) {
8683 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008684 } else {
8685 b.append(mData);
8686 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008687 }
8688 if (mType != null) {
8689 if (!first) {
8690 b.append(' ');
8691 }
8692 first = false;
8693 b.append("typ=").append(mType);
8694 }
8695 if (mFlags != 0) {
8696 if (!first) {
8697 b.append(' ');
8698 }
8699 first = false;
8700 b.append("flg=0x").append(Integer.toHexString(mFlags));
8701 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008702 if (mPackage != null) {
8703 if (!first) {
8704 b.append(' ');
8705 }
8706 first = false;
8707 b.append("pkg=").append(mPackage);
8708 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008709 if (comp && mComponent != null) {
8710 if (!first) {
8711 b.append(' ');
8712 }
8713 first = false;
8714 b.append("cmp=").append(mComponent.flattenToShortString());
8715 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008716 if (mSourceBounds != null) {
8717 if (!first) {
8718 b.append(' ');
8719 }
8720 first = false;
8721 b.append("bnds=").append(mSourceBounds.toShortString());
8722 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008723 if (mClipData != null) {
8724 if (!first) {
8725 b.append(' ');
8726 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008727 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008728 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008729 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008730 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008731 if (mClipData.getDescription() != null) {
8732 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8733 } else {
8734 first = true;
8735 }
8736 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008737 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008738 first = false;
8739 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008740 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008741 if (extras && mExtras != null) {
8742 if (!first) {
8743 b.append(' ');
8744 }
8745 first = false;
8746 b.append("(has extras)");
8747 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008748 if (mContentUserHint != UserHandle.USER_CURRENT) {
8749 if (!first) {
8750 b.append(' ');
8751 }
8752 first = false;
8753 b.append("u=").append(mContentUserHint);
8754 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008755 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008756 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008757 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008758 b.append("}");
8759 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008760 }
8761
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008762 /**
8763 * Call {@link #toUri} with 0 flags.
8764 * @deprecated Use {@link #toUri} instead.
8765 */
8766 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008767 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008768 return toUri(0);
8769 }
8770
8771 /**
8772 * Convert this Intent into a String holding a URI representation of it.
8773 * The returned URI string has been properly URI encoded, so it can be
8774 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8775 * Intent's data as the base URI, with an additional fragment describing
8776 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008777 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008778 * <p>You can convert the returned string back to an Intent with
8779 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008780 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008781 * @param flags Additional operating flags. Either 0,
8782 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008783 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008784 * @return Returns a URI encoding URI string describing the entire contents
8785 * of the Intent.
8786 */
8787 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008788 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008789 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8790 if (mPackage == null) {
8791 throw new IllegalArgumentException(
8792 "Intent must include an explicit package name to build an android-app: "
8793 + this);
8794 }
8795 uri.append("android-app://");
8796 uri.append(mPackage);
8797 String scheme = null;
8798 if (mData != null) {
8799 scheme = mData.getScheme();
8800 if (scheme != null) {
8801 uri.append('/');
8802 uri.append(scheme);
8803 String authority = mData.getEncodedAuthority();
8804 if (authority != null) {
8805 uri.append('/');
8806 uri.append(authority);
8807 String path = mData.getEncodedPath();
8808 if (path != null) {
8809 uri.append(path);
8810 }
8811 String queryParams = mData.getEncodedQuery();
8812 if (queryParams != null) {
8813 uri.append('?');
8814 uri.append(queryParams);
8815 }
8816 String fragment = mData.getEncodedFragment();
8817 if (fragment != null) {
8818 uri.append('#');
8819 uri.append(fragment);
8820 }
8821 }
8822 }
8823 }
8824 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8825 mPackage, flags);
8826 return uri.toString();
8827 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008828 String scheme = null;
8829 if (mData != null) {
8830 String data = mData.toString();
8831 if ((flags&URI_INTENT_SCHEME) != 0) {
8832 final int N = data.length();
8833 for (int i=0; i<N; i++) {
8834 char c = data.charAt(i);
8835 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8836 || c == '.' || c == '-') {
8837 continue;
8838 }
8839 if (c == ':' && i > 0) {
8840 // Valid scheme.
8841 scheme = data.substring(0, i);
8842 uri.append("intent:");
8843 data = data.substring(i+1);
8844 break;
8845 }
Tom Taylord4a47292009-12-21 13:59:18 -08008846
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008847 // No scheme.
8848 break;
8849 }
8850 }
8851 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008852
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008853 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8854 uri.append("intent:");
8855 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008856
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008857 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008858
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008859 return uri.toString();
8860 }
8861
8862 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8863 String defPackage, int flags) {
8864 StringBuilder frag = new StringBuilder(128);
8865
8866 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008867 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008868 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008869 // Note that for now we are not going to try to handle the
8870 // data part; not clear how to represent this as a URI, and
8871 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008872 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8873 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008874 }
8875
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008876 if (frag.length() > 0) {
8877 uri.append("#Intent;");
8878 uri.append(frag);
8879 uri.append("end");
8880 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008881 }
8882
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008883 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8884 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008885 if (scheme != null) {
8886 uri.append("scheme=").append(scheme).append(';');
8887 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008888 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008889 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008890 }
8891 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008892 for (int i=0; i<mCategories.size(); i++) {
8893 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008894 }
8895 }
8896 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008897 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008898 }
8899 if (mFlags != 0) {
8900 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8901 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008902 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008903 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8904 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008905 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008906 uri.append("component=").append(Uri.encode(
8907 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008908 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008909 if (mSourceBounds != null) {
8910 uri.append("sourceBounds=")
8911 .append(Uri.encode(mSourceBounds.flattenToString()))
8912 .append(';');
8913 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008914 if (mExtras != null) {
8915 for (String key : mExtras.keySet()) {
8916 final Object value = mExtras.get(key);
8917 char entryType =
8918 value instanceof String ? 'S' :
8919 value instanceof Boolean ? 'B' :
8920 value instanceof Byte ? 'b' :
8921 value instanceof Character ? 'c' :
8922 value instanceof Double ? 'd' :
8923 value instanceof Float ? 'f' :
8924 value instanceof Integer ? 'i' :
8925 value instanceof Long ? 'l' :
8926 value instanceof Short ? 's' :
8927 '\0';
8928
8929 if (entryType != '\0') {
8930 uri.append(entryType);
8931 uri.append('.');
8932 uri.append(Uri.encode(key));
8933 uri.append('=');
8934 uri.append(Uri.encode(value.toString()));
8935 uri.append(';');
8936 }
8937 }
8938 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008939 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008940
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008941 public int describeContents() {
8942 return (mExtras != null) ? mExtras.describeContents() : 0;
8943 }
8944
8945 public void writeToParcel(Parcel out, int flags) {
8946 out.writeString(mAction);
8947 Uri.writeToParcel(out, mData);
8948 out.writeString(mType);
8949 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008950 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008951 ComponentName.writeToParcel(mComponent, out);
8952
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008953 if (mSourceBounds != null) {
8954 out.writeInt(1);
8955 mSourceBounds.writeToParcel(out, flags);
8956 } else {
8957 out.writeInt(0);
8958 }
8959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008960 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008961 final int N = mCategories.size();
8962 out.writeInt(N);
8963 for (int i=0; i<N; i++) {
8964 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008965 }
8966 } else {
8967 out.writeInt(0);
8968 }
8969
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008970 if (mSelector != null) {
8971 out.writeInt(1);
8972 mSelector.writeToParcel(out, flags);
8973 } else {
8974 out.writeInt(0);
8975 }
8976
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008977 if (mClipData != null) {
8978 out.writeInt(1);
8979 mClipData.writeToParcel(out, flags);
8980 } else {
8981 out.writeInt(0);
8982 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008983 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008984 out.writeBundle(mExtras);
8985 }
8986
8987 public static final Parcelable.Creator<Intent> CREATOR
8988 = new Parcelable.Creator<Intent>() {
8989 public Intent createFromParcel(Parcel in) {
8990 return new Intent(in);
8991 }
8992 public Intent[] newArray(int size) {
8993 return new Intent[size];
8994 }
8995 };
8996
Dianne Hackborneb034652009-09-07 00:49:58 -07008997 /** @hide */
8998 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008999 readFromParcel(in);
9000 }
9001
9002 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009003 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009004 mData = Uri.CREATOR.createFromParcel(in);
9005 mType = in.readString();
9006 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07009007 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009008 mComponent = ComponentName.readFromParcel(in);
9009
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08009010 if (in.readInt() != 0) {
9011 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9012 }
9013
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009014 int N = in.readInt();
9015 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009016 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009017 int i;
9018 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009019 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009020 }
9021 } else {
9022 mCategories = null;
9023 }
9024
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009025 if (in.readInt() != 0) {
9026 mSelector = new Intent(in);
9027 }
9028
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009029 if (in.readInt() != 0) {
9030 mClipData = new ClipData(in);
9031 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009032 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009033 mExtras = in.readBundle();
9034 }
9035
9036 /**
9037 * Parses the "intent" element (and its children) from XML and instantiates
9038 * an Intent object. The given XML parser should be located at the tag
9039 * where parsing should start (often named "intent"), from which the
9040 * basic action, data, type, and package and class name will be
9041 * retrieved. The function will then parse in to any child elements,
9042 * looking for <category android:name="xxx"> tags to add categories and
9043 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9044 * to the intent.
9045 *
9046 * @param resources The Resources to use when inflating resources.
9047 * @param parser The XML parser pointing at an "intent" tag.
9048 * @param attrs The AttributeSet interface for retrieving extended
9049 * attribute data at the current <var>parser</var> location.
9050 * @return An Intent object matching the XML data.
9051 * @throws XmlPullParserException If there was an XML parsing error.
9052 * @throws IOException If there was an I/O error.
9053 */
9054 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
9055 throws XmlPullParserException, IOException {
9056 Intent intent = new Intent();
9057
9058 TypedArray sa = resources.obtainAttributes(attrs,
9059 com.android.internal.R.styleable.Intent);
9060
9061 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9062
9063 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9064 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9065 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9066
9067 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9068 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9069 if (packageName != null && className != null) {
9070 intent.setComponent(new ComponentName(packageName, className));
9071 }
9072
9073 sa.recycle();
9074
9075 int outerDepth = parser.getDepth();
9076 int type;
9077 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9078 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9079 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9080 continue;
9081 }
9082
9083 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009084 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009085 sa = resources.obtainAttributes(attrs,
9086 com.android.internal.R.styleable.IntentCategory);
9087 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9088 sa.recycle();
9089
9090 if (cat != null) {
9091 intent.addCategory(cat);
9092 }
9093 XmlUtils.skipCurrentTag(parser);
9094
Craig Mautner21d24a22014-04-23 11:45:37 -07009095 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009096 if (intent.mExtras == null) {
9097 intent.mExtras = new Bundle();
9098 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009099 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009100 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009101
9102 } else {
9103 XmlUtils.skipCurrentTag(parser);
9104 }
9105 }
9106
9107 return intent;
9108 }
Nick Pellyccae4122012-01-09 14:12:58 -08009109
Craig Mautner21d24a22014-04-23 11:45:37 -07009110 /** @hide */
9111 public void saveToXml(XmlSerializer out) throws IOException {
9112 if (mAction != null) {
9113 out.attribute(null, ATTR_ACTION, mAction);
9114 }
9115 if (mData != null) {
9116 out.attribute(null, ATTR_DATA, mData.toString());
9117 }
9118 if (mType != null) {
9119 out.attribute(null, ATTR_TYPE, mType);
9120 }
9121 if (mComponent != null) {
9122 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9123 }
9124 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9125
9126 if (mCategories != null) {
9127 out.startTag(null, TAG_CATEGORIES);
9128 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9129 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9130 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009131 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009132 }
9133 }
9134
9135 /** @hide */
9136 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9137 XmlPullParserException {
9138 Intent intent = new Intent();
9139 final int outerDepth = in.getDepth();
9140
9141 int attrCount = in.getAttributeCount();
9142 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9143 final String attrName = in.getAttributeName(attrNdx);
9144 final String attrValue = in.getAttributeValue(attrNdx);
9145 if (ATTR_ACTION.equals(attrName)) {
9146 intent.setAction(attrValue);
9147 } else if (ATTR_DATA.equals(attrName)) {
9148 intent.setData(Uri.parse(attrValue));
9149 } else if (ATTR_TYPE.equals(attrName)) {
9150 intent.setType(attrValue);
9151 } else if (ATTR_COMPONENT.equals(attrName)) {
9152 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9153 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009154 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009155 } else {
9156 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9157 }
9158 }
9159
9160 int event;
9161 String name;
9162 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9163 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9164 if (event == XmlPullParser.START_TAG) {
9165 name = in.getName();
9166 if (TAG_CATEGORIES.equals(name)) {
9167 attrCount = in.getAttributeCount();
9168 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9169 intent.addCategory(in.getAttributeValue(attrNdx));
9170 }
9171 } else {
9172 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9173 XmlUtils.skipCurrentTag(in);
9174 }
9175 }
9176 }
9177
9178 return intent;
9179 }
9180
Nick Pellyccae4122012-01-09 14:12:58 -08009181 /**
9182 * Normalize a MIME data type.
9183 *
9184 * <p>A normalized MIME type has white-space trimmed,
9185 * content-type parameters removed, and is lower-case.
9186 * This aligns the type with Android best practices for
9187 * intent filtering.
9188 *
9189 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9190 * "text/x-vCard" becomes "text/x-vcard".
9191 *
9192 * <p>All MIME types received from outside Android (such as user input,
9193 * or external sources like Bluetooth, NFC, or the Internet) should
9194 * be normalized before they are used to create an Intent.
9195 *
9196 * @param type MIME data type to normalize
9197 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009198 * @see #setType
9199 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009200 */
9201 public static String normalizeMimeType(String type) {
9202 if (type == null) {
9203 return null;
9204 }
9205
Elliott Hughescb64d432013-08-02 10:00:44 -07009206 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009207
9208 final int semicolonIndex = type.indexOf(';');
9209 if (semicolonIndex != -1) {
9210 type = type.substring(0, semicolonIndex);
9211 }
9212 return type;
9213 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009214
9215 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009216 * Prepare this {@link Intent} to leave an app process.
9217 *
9218 * @hide
9219 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009220 public void prepareToLeaveProcess(Context context) {
9221 final boolean leavingPackage = (mComponent == null)
9222 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9223 prepareToLeaveProcess(leavingPackage);
9224 }
9225
9226 /**
9227 * Prepare this {@link Intent} to leave an app process.
9228 *
9229 * @hide
9230 */
9231 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009232 setAllowFds(false);
9233
9234 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009235 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009236 }
9237 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009238 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009239 }
9240
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009241 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9242 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009243 switch (mAction) {
9244 case ACTION_MEDIA_REMOVED:
9245 case ACTION_MEDIA_UNMOUNTED:
9246 case ACTION_MEDIA_CHECKING:
9247 case ACTION_MEDIA_NOFS:
9248 case ACTION_MEDIA_MOUNTED:
9249 case ACTION_MEDIA_SHARED:
9250 case ACTION_MEDIA_UNSHARED:
9251 case ACTION_MEDIA_BAD_REMOVAL:
9252 case ACTION_MEDIA_UNMOUNTABLE:
9253 case ACTION_MEDIA_EJECT:
9254 case ACTION_MEDIA_SCANNER_STARTED:
9255 case ACTION_MEDIA_SCANNER_FINISHED:
9256 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009257 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9258 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009259 // Ignore legacy actions
9260 break;
9261 default:
9262 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009263 }
9264 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009265
9266 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9267 && leavingPackage) {
9268 switch (mAction) {
9269 case ACTION_PROVIDER_CHANGED:
9270 // Ignore actions that don't need to grant
9271 break;
9272 default:
9273 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9274 }
9275 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009276 }
9277
9278 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009279 * @hide
9280 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009281 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009282 // We just entered destination process, so we should be able to read all
9283 // parcelables inside.
9284 setDefusable(true);
9285
9286 if (mSelector != null) {
9287 mSelector.prepareToEnterProcess();
9288 }
9289 if (mClipData != null) {
9290 mClipData.prepareToEnterProcess();
9291 }
9292
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009293 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009294 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9295 fixUris(mContentUserHint);
9296 mContentUserHint = UserHandle.USER_CURRENT;
9297 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009298 }
9299 }
9300
9301 /**
9302 * @hide
9303 */
9304 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009305 Uri data = getData();
9306 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009307 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009308 }
9309 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009310 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009311 }
9312 String action = getAction();
9313 if (ACTION_SEND.equals(action)) {
9314 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9315 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009316 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009317 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009318 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009319 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9320 if (streams != null) {
9321 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9322 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009323 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009324 }
9325 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9326 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009327 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9328 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9329 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9330 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9331 if (output != null) {
9332 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9333 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009334 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009335 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009336
9337 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009338 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009339 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9340 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009341 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009342 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009343 * @hide
9344 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009345 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009346 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009347 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009348
9349 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009350 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009351
9352 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009353 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009354 // Inspect contained intents to see if we need to migrate extras. We
9355 // don't promote ClipData to the parent, since ChooserActivity will
9356 // already start the picked item as the caller, and we can't combine
9357 // the flags in a safe way.
9358
9359 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009360 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009361 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9362 if (intent != null) {
9363 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009364 }
9365 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009366 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009367 try {
9368 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9369 if (intents != null) {
9370 for (int i = 0; i < intents.length; i++) {
9371 final Intent intent = (Intent) intents[i];
9372 if (intent != null) {
9373 migrated |= intent.migrateExtraStreamToClipData();
9374 }
9375 }
9376 }
9377 } catch (ClassCastException e) {
9378 }
9379 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009380
9381 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009382 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009383 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9384 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9385 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9386 if (stream != null || text != null || htmlText != null) {
9387 final ClipData clipData = new ClipData(
9388 null, new String[] { getType() },
9389 new ClipData.Item(text, htmlText, null, stream));
9390 setClipData(clipData);
9391 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009392 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009393 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009394 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009395 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009396
9397 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009398 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009399 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9400 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9401 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9402 int num = -1;
9403 if (streams != null) {
9404 num = streams.size();
9405 }
9406 if (texts != null) {
9407 if (num >= 0 && num != texts.size()) {
9408 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009409 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009410 }
9411 num = texts.size();
9412 }
9413 if (htmlTexts != null) {
9414 if (num >= 0 && num != htmlTexts.size()) {
9415 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009416 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009417 }
9418 num = htmlTexts.size();
9419 }
9420 if (num > 0) {
9421 final ClipData clipData = new ClipData(
9422 null, new String[] { getType() },
9423 makeClipItem(streams, texts, htmlTexts, 0));
9424
9425 for (int i = 1; i < num; i++) {
9426 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9427 }
9428
9429 setClipData(clipData);
9430 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009431 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009432 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009433 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009434 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009435 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9436 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9437 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9438 final Uri output;
9439 try {
9440 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9441 } catch (ClassCastException e) {
9442 return false;
9443 }
9444 if (output != null) {
9445 setClipData(ClipData.newRawUri("", output));
9446 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9447 return true;
9448 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009449 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009450
9451 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009452 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009453
9454 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9455 ArrayList<String> htmlTexts, int which) {
9456 Uri uri = streams != null ? streams.get(which) : null;
9457 CharSequence text = texts != null ? texts.get(which) : null;
9458 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9459 return new ClipData.Item(text, htmlText, null, uri);
9460 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009461
9462 /** @hide */
9463 public boolean isDocument() {
9464 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9465 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009466}