blob: 3ecf0bbfd90e20ce17e166fda54274a0c1de4dd9 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700118 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700189 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700342 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700361 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * </ul>
573 *
574 * <h3>Standard Extra Data</h3>
575 *
576 * <p>These are the current standard fields that can be used as extra data via
577 * {@link #putExtra}.
578 *
579 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_ALARM_COUNT}
581 * <li> {@link #EXTRA_BCC}
582 * <li> {@link #EXTRA_CC}
583 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
584 * <li> {@link #EXTRA_DATA_REMOVED}
585 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500586 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_DOCK_STATE_CAR}
589 * <li> {@link #EXTRA_DOCK_STATE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
591 * <li> {@link #EXTRA_DONT_KILL_APP}
592 * <li> {@link #EXTRA_EMAIL}
593 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700596 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700598 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
600 * <li> {@link #EXTRA_REPLACING}
601 * <li> {@link #EXTRA_SHORTCUT_ICON}
602 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
603 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_SHORTCUT_NAME}
606 * <li> {@link #EXTRA_SUBJECT}
607 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_TITLE}
610 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * </ul>
612 *
613 * <h3>Flags</h3>
614 *
615 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
617 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800619public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700620 private static final String ATTR_ACTION = "action";
621 private static final String TAG_CATEGORIES = "categories";
622 private static final String ATTR_CATEGORY = "category";
623 private static final String TAG_EXTRA = "extra";
624 private static final String ATTR_TYPE = "type";
625 private static final String ATTR_COMPONENT = "component";
626 private static final String ATTR_DATA = "data";
627 private static final String ATTR_FLAGS = "flags";
628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 // ---------------------------------------------------------------------
630 // ---------------------------------------------------------------------
631 // Standard intent activity actions (see action variable).
632
633 /**
634 * Activity Action: Start as a main entry point, does not expect to
635 * receive data.
636 * <p>Input: nothing
637 * <p>Output: nothing
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Display the data to the user. This is the most common
644 * action performed on data -- it is the generic action you can use on
645 * a piece of data to get the most reasonable thing to occur. For example,
646 * when used on a contacts entry it will view the entry; when used on a
647 * mailto: URI it will bring up a compose window filled with the information
648 * supplied by the URI; when used with a tel: URI it will invoke the
649 * dialer.
650 * <p>Input: {@link #getData} is URI from which to retrieve data.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
658 * performed on a piece of data.
659 */
660 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900663 * Activity Action: Quick view the data. Launches a quick viewer for
664 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900665 * <p>Activities handling this intent action should handle the vast majority of
666 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * <p>Input: {@link #getData} is a mandatory content URI of the item to
668 * preview. {@link #getClipData} contains an optional list of content URIs
669 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
670 * optional index of the URI in the clip data to show first.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900671 * If {@link #EXTRA_QUICK_VIEW_PLAIN} is true, then the quick viewer should show
672 * basic UI without any extra features other than quick viewing the passed items.
673 * Especially, the quick viewer should not let users open the passed files
674 * in other apps, which includes sharing, opening, editing, printing, etc in the
675 * plain mode.
Steve McKayc78bcb82015-07-31 14:35:22 -0700676 * <p>Output: nothing.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +0900677 * @see #EXTRA_QUICK_VIEW_HIDE_DEFAULT_ACTIONS
678 * @see #EXTRA_INDEX
Steve McKayc78bcb82015-07-31 14:35:22 -0700679 */
680 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
681 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
682
683 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700684 * Used to indicate that some piece of data should be attached to some other
685 * place. For example, image data could be attached to a contact. It is up
686 * to the recipient to decide where the data should be attached; the intent
687 * does not specify the ultimate destination.
688 * <p>Input: {@link #getData} is URI of data to be attached.
689 * <p>Output: nothing.
690 */
691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
692 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800693
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700694 /**
695 * Activity Action: Provide explicit editable access to the given data.
696 * <p>Input: {@link #getData} is URI of data to be edited.
697 * <p>Output: nothing.
698 */
699 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
700 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800701
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700702 /**
703 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
704 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
705 * The extras can contain type specific data to pass through to the editing/creating
706 * activity.
707 * <p>Output: The URI of the item that was picked. This must be a content:
708 * URI so that any receiver can access it.
709 */
710 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
711 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800712
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700713 /**
714 * Activity Action: Pick an item from the data, returning what was selected.
715 * <p>Input: {@link #getData} is URI containing a directory of data
716 * (vnd.android.cursor.dir/*) from which to pick an item.
717 * <p>Output: The URI of the item that was picked.
718 */
719 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
720 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700722 /**
723 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800724 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800725 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
726 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700727 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
728 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800729 * (value: ShortcutIconResource).</p>
730 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800731 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700732 * @see #EXTRA_SHORTCUT_INTENT
733 * @see #EXTRA_SHORTCUT_NAME
734 * @see #EXTRA_SHORTCUT_ICON
735 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
736 * @see android.content.Intent.ShortcutIconResource
737 */
738 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
739 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
740
741 /**
742 * The name of the extra used to define the Intent of a shortcut.
743 *
744 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800745 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700746 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800747 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
749 /**
750 * The name of the extra used to define the name of a shortcut.
751 *
752 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800753 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700754 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800755 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700756 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
757 /**
758 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
759 *
760 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800761 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700762 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800763 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700764 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
765 /**
766 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
767 *
768 * @see #ACTION_CREATE_SHORTCUT
769 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800770 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700771 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800772 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700773 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
774 "android.intent.extra.shortcut.ICON_RESOURCE";
775
776 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500777 * An activity that provides a user interface for adjusting application preferences.
778 * Optional but recommended settings for all applications which have settings.
779 */
780 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
781 public static final String ACTION_APPLICATION_PREFERENCES
782 = "android.intent.action.APPLICATION_PREFERENCES";
783
784 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700785 * Activity Action: Launch an activity showing the app information.
786 * For applications which install other applications (such as app stores), it is recommended
787 * to handle this action for providing the app information to the user.
788 *
789 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
790 * to be displayed.
791 * <p>Output: Nothing.
792 */
793 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
794 public static final String ACTION_SHOW_APP_INFO
795 = "android.intent.action.SHOW_APP_INFO";
796
797 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800798 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700799 *
800 * @see Intent#ACTION_CREATE_SHORTCUT
801 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800802 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
803 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700804 */
805 public static class ShortcutIconResource implements Parcelable {
806 /**
807 * The package name of the application containing the icon.
808 */
809 public String packageName;
810
811 /**
812 * The resource name of the icon, including package, name and type.
813 */
814 public String resourceName;
815
816 /**
817 * Creates a new ShortcutIconResource for the specified context and resource
818 * identifier.
819 *
820 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700821 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700822 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700823 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700825 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700826 ShortcutIconResource icon = new ShortcutIconResource();
827 icon.packageName = context.getPackageName();
828 icon.resourceName = context.getResources().getResourceName(resourceId);
829 return icon;
830 }
831
832 /**
833 * Used to read a ShortcutIconResource from a Parcel.
834 */
835 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
836 new Parcelable.Creator<ShortcutIconResource>() {
837
838 public ShortcutIconResource createFromParcel(Parcel source) {
839 ShortcutIconResource icon = new ShortcutIconResource();
840 icon.packageName = source.readString();
841 icon.resourceName = source.readString();
842 return icon;
843 }
844
845 public ShortcutIconResource[] newArray(int size) {
846 return new ShortcutIconResource[size];
847 }
848 };
849
850 /**
851 * No special parcel contents.
852 */
853 public int describeContents() {
854 return 0;
855 }
856
857 public void writeToParcel(Parcel dest, int flags) {
858 dest.writeString(packageName);
859 dest.writeString(resourceName);
860 }
861
862 @Override
863 public String toString() {
864 return resourceName;
865 }
866 }
867
868 /**
869 * Activity Action: Display an activity chooser, allowing the user to pick
870 * what they want to before proceeding. This can be used as an alternative
871 * to the standard activity picker that is displayed by the system when
872 * you try to start an activity with multiple possible matches, with these
873 * differences in behavior:
874 * <ul>
875 * <li>You can specify the title that will appear in the activity chooser.
876 * <li>The user does not have the option to make one of the matching
877 * activities a preferred activity, and all possible activities will
878 * always be shown even if one of them is currently marked as the
879 * preferred activity.
880 * </ul>
881 * <p>
882 * This action should be used when the user will naturally expect to
883 * select an activity in order to proceed. An example if when not to use
884 * it is when the user clicks on a "mailto:" link. They would naturally
885 * expect to go directly to their mail app, so startActivity() should be
886 * called directly: it will
887 * either launch the current preferred app, or put up a dialog allowing the
888 * user to pick an app to use and optionally marking that as preferred.
889 * <p>
890 * In contrast, if the user is selecting a menu item to send a picture
891 * they are viewing to someone else, there are many different things they
892 * may want to do at this point: send it through e-mail, upload it to a
893 * web service, etc. In this case the CHOOSER action should be used, to
894 * always present to the user a list of the things they can do, with a
895 * nice title given by the caller such as "Send this photo with:".
896 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700897 * If you need to grant URI permissions through a chooser, you must specify
898 * the permissions to be granted on the ACTION_CHOOSER Intent
899 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
900 * {@link #setClipData} to specify the URIs to be granted as well as
901 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
902 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
903 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700904 * As a convenience, an Intent of this form can be created with the
905 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700906 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700907 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700908 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
909 * and can optionally have a {@link #EXTRA_TITLE} field containing the
910 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700911 * <p>
912 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700913 */
914 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
915 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
916
917 /**
918 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
919 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700920 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
921 * target intent, also optionally supplying a title. If the target
922 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
923 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
924 * set in the returned chooser intent, with its ClipData set appropriately:
925 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500926 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700927 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700928 * @param target The Intent that the user will be selecting an activity
929 * to perform.
930 * @param title Optional title that will be displayed in the chooser.
931 * @return Return a new Intent object that you can hand to
932 * {@link Context#startActivity(Intent) Context.startActivity()} and
933 * related methods.
934 */
935 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700936 return createChooser(target, title, null);
937 }
938
939 /**
940 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
941 *
942 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
943 * target intent, also optionally supplying a title. If the target
944 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
945 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
946 * set in the returned chooser intent, with its ClipData set appropriately:
947 * either a direct reflection of {@link #getClipData()} if that is non-null,
948 * or a new ClipData built from {@link #getData()}.</p>
949 *
950 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
951 * when the user makes a choice. This can be useful if the calling application wants
952 * to remember the last chosen target and surface it as a more prominent or one-touch
953 * affordance elsewhere in the UI for next time.</p>
954 *
955 * @param target The Intent that the user will be selecting an activity
956 * to perform.
957 * @param title Optional title that will be displayed in the chooser.
958 * @param sender Optional IntentSender to be called when a choice is made.
959 * @return Return a new Intent object that you can hand to
960 * {@link Context#startActivity(Intent) Context.startActivity()} and
961 * related methods.
962 */
963 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700964 Intent intent = new Intent(ACTION_CHOOSER);
965 intent.putExtra(EXTRA_INTENT, target);
966 if (title != null) {
967 intent.putExtra(EXTRA_TITLE, title);
968 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700969
Adam Powell0b3c1122014-10-09 12:50:14 -0700970 if (sender != null) {
971 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
972 }
973
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700974 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700975 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
976 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
977 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700978 if (permFlags != 0) {
979 ClipData targetClipData = target.getClipData();
980 if (targetClipData == null && target.getData() != null) {
981 ClipData.Item item = new ClipData.Item(target.getData());
982 String[] mimeTypes;
983 if (target.getType() != null) {
984 mimeTypes = new String[] { target.getType() };
985 } else {
986 mimeTypes = new String[] { };
987 }
988 targetClipData = new ClipData(null, mimeTypes, item);
989 }
990 if (targetClipData != null) {
991 intent.setClipData(targetClipData);
992 intent.addFlags(permFlags);
993 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700994 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700995
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700996 return intent;
997 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700998
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700999 /**
1000 * Activity Action: Allow the user to select a particular kind of data and
1001 * return it. This is different than {@link #ACTION_PICK} in that here we
1002 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001003 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001004 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001005 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001006 * etc.
1007 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001008 * 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 -07001009 * of data, such as a person contact, you set the MIME type to the kind of
1010 * data you want and launch it with {@link Context#startActivity(Intent)}.
1011 * The system will then launch the best application to select that kind
1012 * of data for you.
1013 * <p>
1014 * You may also be interested in any of a set of types of content the user
1015 * can pick. For example, an e-mail application that wants to allow the
1016 * user to add an attachment to an e-mail message can use this action to
1017 * bring up a list of all of the types of content the user can attach.
1018 * <p>
1019 * In this case, you should wrap the GET_CONTENT intent with a chooser
1020 * (through {@link #createChooser}), which will give the proper interface
1021 * for the user to pick how to send your data and allow you to specify
1022 * a prompt indicating what they are doing. You will usually specify a
1023 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1024 * broad range of content types the user can select from.
1025 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001026 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001027 * only pick from data that can be represented as a stream. This is
1028 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1029 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001030 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001031 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001032 * is locally available on the device. For example, if this extra is set
1033 * to true then an image picker should not show any pictures that are available
1034 * from a remote server but not already on the local device (thus requiring
1035 * they be downloaded when opened).
1036 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001037 * If the caller can handle multiple returned items (the user performing
1038 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1039 * to indicate this.
1040 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001041 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1042 * that no URI is supplied in the intent, as there are no constraints on
1043 * where the returned data originally comes from. You may also include the
1044 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001045 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001046 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1047 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001048 * <p>
1049 * Output: The URI of the item that was picked. This must be a content:
1050 * URI so that any receiver can access it.
1051 */
1052 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1053 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1054 /**
1055 * Activity Action: Dial a number as specified by the data. This shows a
1056 * UI with the number being dialed, allowing the user to explicitly
1057 * initiate the call.
1058 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1059 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1060 * number.
1061 * <p>Output: nothing.
1062 */
1063 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1064 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1065 /**
1066 * Activity Action: Perform a call to someone specified by the data.
1067 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1068 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1069 * number.
1070 * <p>Output: nothing.
1071 *
1072 * <p>Note: there will be restrictions on which applications can initiate a
1073 * call; most applications should use the {@link #ACTION_DIAL}.
1074 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1075 * numbers. Applications can <strong>dial</strong> emergency numbers using
1076 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001077 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001078 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001079 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001080 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001081 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001082 */
1083 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1084 public static final String ACTION_CALL = "android.intent.action.CALL";
1085 /**
1086 * Activity Action: Perform a call to an emergency number specified by the
1087 * data.
1088 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1089 * tel: URI of an explicit phone number.
1090 * <p>Output: nothing.
1091 * @hide
1092 */
1093 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1094 /**
1095 * Activity action: Perform a call to any number (emergency or not)
1096 * specified by the data.
1097 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1098 * tel: URI of an explicit phone number.
1099 * <p>Output: nothing.
1100 * @hide
1101 */
1102 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1103 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001104 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1105 * sending this intent is a no-op.
1106 * <p>Input: No data should be specified. get*Extra may have an optional
1107 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1108 * send the activation result.
1109 * <p>Output: nothing.
1110 * @hide
1111 */
1112 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1113 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1114 "android.intent.action.SIM_ACTIVATION_REQUEST";
1115 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001116 * Activity Action: Send a message to someone specified by the data.
1117 * <p>Input: {@link #getData} is URI describing the target.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1122 /**
1123 * Activity Action: Deliver some data to someone else. Who the data is
1124 * being delivered to is not specified; it is up to the receiver of this
1125 * action to ask the user where the data should be sent.
1126 * <p>
1127 * When launching a SEND intent, you should usually wrap it in a chooser
1128 * (through {@link #createChooser}), which will give the proper interface
1129 * for the user to pick how to send your data and allow you to specify
1130 * a prompt indicating what they are doing.
1131 * <p>
1132 * Input: {@link #getType} is the MIME type of the data being sent.
1133 * get*Extra can have either a {@link #EXTRA_TEXT}
1134 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1135 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1136 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1137 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001138 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1139 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1140 * your text with HTML formatting.
1141 * <p>
1142 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1143 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1144 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1145 * content: URIs and other advanced features of {@link ClipData}. If
1146 * using this approach, you still must supply the same data through the
1147 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1148 * for compatibility with old applications. If you don't set a ClipData,
1149 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001150 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001151 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1152 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1153 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1154 * be openable only as asset typed files using
1155 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1156 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001157 * Optional standard extras, which may be interpreted by some recipients as
1158 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1159 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1160 * <p>
1161 * Output: nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_SEND = "android.intent.action.SEND";
1165 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001166 * Activity Action: Deliver multiple data to someone else.
1167 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001168 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001169 * <p>
1170 * Input: {@link #getType} is the MIME type of the data being sent.
1171 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001172 * #EXTRA_STREAM} field, containing the data to be sent. If using
1173 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1174 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001175 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001176 * Multiple types are supported, and receivers should handle mixed types
1177 * whenever possible. The right way for the receiver to check them is to
1178 * use the content resolver on each URI. The intent sender should try to
1179 * put the most concrete mime type in the intent type, but it can fall
1180 * back to {@literal <type>/*} or {@literal *}/* as needed.
1181 * <p>
1182 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1183 * be image/jpg, but if you are sending image/jpg and image/png, then the
1184 * intent's type should be image/*.
1185 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001186 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1187 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1188 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1189 * content: URIs and other advanced features of {@link ClipData}. If
1190 * using this approach, you still must supply the same data through the
1191 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1192 * for compatibility with old applications. If you don't set a ClipData,
1193 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1194 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001195 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1196 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1197 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1198 * be openable only as asset typed files using
1199 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1200 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001201 * Optional standard extras, which may be interpreted by some recipients as
1202 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1203 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1204 * <p>
1205 * Output: nothing.
1206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001210 * Activity Action: Handle an incoming phone call.
1211 * <p>Input: nothing.
1212 * <p>Output: nothing.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1216 /**
1217 * Activity Action: Insert an empty item into the given container.
1218 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1219 * in which to place the data.
1220 * <p>Output: URI of the new data that was created.
1221 */
1222 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1223 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1224 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001225 * Activity Action: Create a new item in the given container, initializing it
1226 * from the current contents of the clipboard.
1227 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1228 * in which to place the data.
1229 * <p>Output: URI of the new data that was created.
1230 */
1231 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1232 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1233 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001234 * Activity Action: Delete the given data from its container.
1235 * <p>Input: {@link #getData} is URI of data to be deleted.
1236 * <p>Output: nothing.
1237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1240 /**
1241 * Activity Action: Run the data, whatever that means.
1242 * <p>Input: ? (Note: this is currently specific to the test harness.)
1243 * <p>Output: nothing.
1244 */
1245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1246 public static final String ACTION_RUN = "android.intent.action.RUN";
1247 /**
1248 * Activity Action: Perform a data synchronization.
1249 * <p>Input: ?
1250 * <p>Output: ?
1251 */
1252 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1253 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1254 /**
1255 * Activity Action: Pick an activity given an intent, returning the class
1256 * selected.
1257 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1258 * used with {@link PackageManager#queryIntentActivities} to determine the
1259 * set of activities from which to pick.
1260 * <p>Output: Class name of the activity that was selected.
1261 */
1262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1263 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1264 /**
1265 * Activity Action: Perform a search.
1266 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1267 * is the text to search for. If empty, simply
1268 * enter your search results Activity with the search UI activated.
1269 * <p>Output: nothing.
1270 */
1271 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1272 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1273 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001274 * Activity Action: Start the platform-defined tutorial
1275 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1276 * is the text to search for. If empty, simply
1277 * enter your search results Activity with the search UI activated.
1278 * <p>Output: nothing.
1279 */
1280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1281 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1282 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001283 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001284 * <p>
1285 * Input: {@link android.app.SearchManager#QUERY
1286 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1287 * a url starts with http or https, the site will be opened. If it is plain
1288 * text, Google search will be applied.
1289 * <p>
1290 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001291 */
1292 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1293 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001294
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001295 /**
Jim Miller07994402012-05-02 14:22:27 -07001296 * Activity Action: Perform assist action.
1297 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001298 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1299 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001300 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1301 * information.
Jim Miller07994402012-05-02 14:22:27 -07001302 * Output: nothing.
1303 */
1304 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1305 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001306
1307 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001308 * Activity Action: Perform voice assist action.
1309 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001310 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1311 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001312 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001313 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001314 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001315 */
1316 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1317 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1318
1319 /**
Adam Skory7140a252013-09-11 12:04:58 +01001320 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1321 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001322 */
1323 public static final String EXTRA_ASSIST_PACKAGE
1324 = "android.intent.extra.ASSIST_PACKAGE";
1325
1326 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001327 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1328 * application package at the time the assist was invoked.
1329 */
1330 public static final String EXTRA_ASSIST_UID
1331 = "android.intent.extra.ASSIST_UID";
1332
1333 /**
Adam Skory7140a252013-09-11 12:04:58 +01001334 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1335 * information supplied by the current foreground app at the time of the assist request.
1336 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001337 */
1338 public static final String EXTRA_ASSIST_CONTEXT
1339 = "android.intent.extra.ASSIST_CONTEXT";
1340
Jim Miller07994402012-05-02 14:22:27 -07001341 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001342 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1343 * keyboard as the primary input device for assistance.
1344 */
1345 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1346 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1347
1348 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001349 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1350 * that was used to invoke the assist.
1351 */
1352 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1353 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1354
1355 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001356 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001357 * <p>Input: Nothing.
1358 * <p>Output: nothing.
1359 */
1360 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1361 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1362 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001363 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001364 * <p>Input: Nothing.
1365 * <p>Output: Nothing.
1366 */
1367 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1368 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1369
1370 /**
1371 * Activity Action: Show activity for reporting a bug.
1372 * <p>Input: Nothing.
1373 * <p>Output: Nothing.
1374 */
1375 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1376 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1377
1378 /**
1379 * Activity Action: Main entry point for factory tests. Only used when
1380 * the device is booting in factory test node. The implementing package
1381 * must be installed in the system image.
1382 * <p>Input: nothing
1383 * <p>Output: nothing
1384 */
1385 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1386
1387 /**
1388 * Activity Action: The user pressed the "call" button to go to the dialer
1389 * or other appropriate UI for placing a call.
1390 * <p>Input: Nothing.
1391 * <p>Output: Nothing.
1392 */
1393 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1394 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1395
1396 /**
1397 * Activity Action: Start Voice Command.
1398 * <p>Input: Nothing.
1399 * <p>Output: Nothing.
1400 */
1401 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1402 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001403
1404 /**
1405 * Activity Action: Start action associated with long pressing on the
1406 * search key.
1407 * <p>Input: Nothing.
1408 * <p>Output: Nothing.
1409 */
1410 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1411 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001412
Jacek Surazski86b6c532009-05-13 14:38:28 +02001413 /**
1414 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1415 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001416 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001417 * <p>Input: No data is specified. The bug report is passed in using
1418 * an {@link #EXTRA_BUG_REPORT} field.
1419 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001420 *
1421 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001422 */
1423 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1424 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001425
1426 /**
1427 * Activity Action: Show power usage information to the user.
1428 * <p>Input: Nothing.
1429 * <p>Output: Nothing.
1430 */
1431 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1432 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001433
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001434 /**
1435 * Activity Action: Setup wizard to launch after a platform update. This
1436 * activity should have a string meta-data field associated with it,
1437 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1438 * the platform for setup. The activity will be launched only if
1439 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1440 * same value.
1441 * <p>Input: Nothing.
1442 * <p>Output: Nothing.
1443 * @hide
1444 */
1445 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1446 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001447
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001448 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001449 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1450 * <p>Input: Nothing.
1451 * <p>Output: Nothing.
1452 * @hide
1453 */
1454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1455 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1456 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1457
1458 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001459 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1460 * <p>Input: Nothing.
1461 * <p>Output: Nothing.
1462 * @hide
1463 */
1464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1465 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1466 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1467
1468 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001469 * Activity Action: Show settings for managing network data usage of a
1470 * specific application. Applications should define an activity that offers
1471 * options to control data usage.
1472 */
1473 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1474 public static final String ACTION_MANAGE_NETWORK_USAGE =
1475 "android.intent.action.MANAGE_NETWORK_USAGE";
1476
1477 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001478 * Activity Action: Launch application installer.
1479 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001480 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001481 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1482 * you can also use "package:<package-name>" to install an application for the
1483 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001484 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1485 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1486 * <p>
1487 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1488 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001489 * <p>
1490 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1491 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1492 * in order to launch the application installer.
1493 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001494 *
1495 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1496 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1497 * @see #EXTRA_RETURN_RESULT
1498 */
1499 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1500 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1501
1502 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001503 * Activity Action: Launch ephemeral installer.
1504 * <p>
1505 * Input: The data must be a http: URI that the ephemeral application is registered
1506 * to handle.
1507 * <p class="note">
1508 * This is a protected intent that can only be sent by the system.
1509 * </p>
1510 *
1511 * @hide
1512 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001513 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1514 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1515 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1516
1517 /**
1518 * Service Action: Resolve ephemeral application.
1519 * <p>
1520 * The system will have a persistent connection to this service.
1521 * This is a protected intent that can only be sent by the system.
1522 * </p>
1523 *
1524 * @hide
1525 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001526 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1527 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1528 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1529
1530 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001531 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1532 * package. Specifies the installer package name; this package will receive the
1533 * {@link #ACTION_APP_ERROR} intent.
1534 */
1535 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1536 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1537
1538 /**
1539 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1540 * package. Specifies that the application being installed should not be
1541 * treated as coming from an unknown source, but as coming from the app
1542 * invoking the Intent. For this to work you must start the installer with
1543 * startActivityForResult().
1544 */
1545 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1546 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1547
1548 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001549 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1550 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001551 * data field originated from.
1552 */
rich cannings706e8ba2012-08-20 13:20:14 -07001553 public static final String EXTRA_ORIGINATING_URI
1554 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001555
1556 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001557 * This extra can be used with any Intent used to launch an activity, supplying information
1558 * about who is launching that activity. This field contains a {@link android.net.Uri}
1559 * object, typically an http: or https: URI of the web site that the referral came from;
1560 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1561 * a native application that it came from.
1562 *
1563 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1564 * instead of directly retrieving the extra. It is also valid for applications to
1565 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1566 * a string, not a Uri; the field here, if supplied, will always take precedence,
1567 * however.</p>
1568 *
1569 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001570 */
1571 public static final String EXTRA_REFERRER
1572 = "android.intent.extra.REFERRER";
1573
1574 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001575 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1576 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1577 * not be created, in particular when Intent extras are supplied through the
1578 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1579 * schemes.
1580 *
1581 * @see #EXTRA_REFERRER
1582 */
1583 public static final String EXTRA_REFERRER_NAME
1584 = "android.intent.extra.REFERRER_NAME";
1585
1586 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001587 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001588 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001589 * @hide
1590 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001591 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001592 public static final String EXTRA_ORIGINATING_UID
1593 = "android.intent.extra.ORIGINATING_UID";
1594
1595 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001596 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1597 * package. Tells the installer UI to skip the confirmation with the user
1598 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001599 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1600 * will no longer show an interstitial message about updating existing
1601 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001602 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001603 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001604 public static final String EXTRA_ALLOW_REPLACE
1605 = "android.intent.extra.ALLOW_REPLACE";
1606
1607 /**
1608 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1609 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1610 * return to the application the result code of the install/uninstall. The returned result
1611 * code will be {@link android.app.Activity#RESULT_OK} on success or
1612 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1613 */
1614 public static final String EXTRA_RETURN_RESULT
1615 = "android.intent.extra.RETURN_RESULT";
1616
1617 /**
1618 * Package manager install result code. @hide because result codes are not
1619 * yet ready to be exposed.
1620 */
1621 public static final String EXTRA_INSTALL_RESULT
1622 = "android.intent.extra.INSTALL_RESULT";
1623
1624 /**
1625 * Activity Action: Launch application uninstaller.
1626 * <p>
1627 * Input: The data must be a package: URI whose scheme specific part is
1628 * the package name of the current installed package to be uninstalled.
1629 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1630 * <p>
1631 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1632 * succeeded.
1633 */
1634 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1635 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1636
1637 /**
msnider3c191b82017-01-23 14:23:16 -08001638 * Activity Action: Launch application uninstaller.
1639 * <p>
1640 * Input: The data must be a package: URI whose scheme specific part is
1641 * the package name of the current installed package to be uninstalled.
1642 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1643 * <p>
1644 * Output: Nothing.
1645 * </p>
1646 */
1647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1648 public static final String ACTION_CLEAR_PACKAGE = "android.intent.action.CLEAR_PACKAGE";
1649
1650 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001651 * Specify whether the package should be uninstalled for all users.
1652 * @hide because these should not be part of normal application flow.
1653 */
1654 public static final String EXTRA_UNINSTALL_ALL_USERS
1655 = "android.intent.extra.UNINSTALL_ALL_USERS";
1656
1657 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001658 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1659 * describing the last run version of the platform that was setup.
1660 * @hide
1661 */
1662 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1663
Svet Ganov3695b8a2015-03-24 16:30:25 -07001664 /**
1665 * Activity action: Launch UI to manage the permissions of an app.
1666 * <p>
1667 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1668 * will be managed by the launched UI.
1669 * </p>
1670 * <p>
1671 * Output: Nothing.
1672 * </p>
1673 *
1674 * @see #EXTRA_PACKAGE_NAME
1675 *
1676 * @hide
1677 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001678 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001679 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1680 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1681 "android.intent.action.MANAGE_APP_PERMISSIONS";
1682
1683 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001684 * Activity action: Launch UI to manage permissions.
1685 * <p>
1686 * Input: Nothing.
1687 * </p>
1688 * <p>
1689 * Output: Nothing.
1690 * </p>
1691 *
1692 * @hide
1693 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001694 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001695 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1696 public static final String ACTION_MANAGE_PERMISSIONS =
1697 "android.intent.action.MANAGE_PERMISSIONS";
1698
1699 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001700 * Activity action: Launch UI to review permissions for an app.
1701 * The system uses this intent if permission review for apps not
1702 * supporting the new runtime permissions model is enabled. In
1703 * this mode a permission review is required before any of the
1704 * app components can run.
1705 * <p>
1706 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1707 * permissions will be reviewed (mandatory).
1708 * </p>
1709 * <p>
1710 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1711 * be fired after the permission review (optional).
1712 * </p>
1713 * <p>
1714 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1715 * be invoked after the permission review (optional).
1716 * </p>
1717 * <p>
1718 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1719 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1720 * </p>
1721 * <p>
1722 * Output: Nothing.
1723 * </p>
1724 *
1725 * @see #EXTRA_PACKAGE_NAME
1726 * @see #EXTRA_INTENT
1727 * @see #EXTRA_REMOTE_CALLBACK
1728 * @see #EXTRA_RESULT_NEEDED
1729 *
1730 * @hide
1731 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001732 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001733 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1734 public static final String ACTION_REVIEW_PERMISSIONS =
1735 "android.intent.action.REVIEW_PERMISSIONS";
1736
1737 /**
1738 * Intent extra: A callback for reporting remote result as a bundle.
1739 * <p>
1740 * Type: IRemoteCallback
1741 * </p>
1742 *
1743 * @hide
1744 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001745 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001746 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1747
1748 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001749 * Intent extra: An app package name.
1750 * <p>
1751 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001752 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001753 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001754 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001755 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1756
1757 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001758 * Intent extra: An app split name.
1759 * <p>
1760 * Type: String
1761 * </p>
1762 * @hide
1763 */
1764 @SystemApi
1765 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1766
1767 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001768 * Intent extra: An extra for specifying whether a result is needed.
1769 * <p>
1770 * Type: boolean
1771 * </p>
1772 *
1773 * @hide
1774 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001775 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001776 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1777
1778 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001779 * Activity action: Launch UI to manage which apps have a given permission.
1780 * <p>
1781 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1782 * to which will be managed by the launched UI.
1783 * </p>
1784 * <p>
1785 * Output: Nothing.
1786 * </p>
1787 *
1788 * @see #EXTRA_PERMISSION_NAME
1789 *
1790 * @hide
1791 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001792 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001793 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1794 public static final String ACTION_MANAGE_PERMISSION_APPS =
1795 "android.intent.action.MANAGE_PERMISSION_APPS";
1796
1797 /**
1798 * Intent extra: The name of a permission.
1799 * <p>
1800 * Type: String
1801 * </p>
1802 *
1803 * @hide
1804 */
1805 @SystemApi
1806 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1807
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001808 // ---------------------------------------------------------------------
1809 // ---------------------------------------------------------------------
1810 // Standard intent broadcast actions (see action variable).
1811
1812 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001813 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1814 * <p>
1815 * For historical reasons, the name of this broadcast action refers to the power
1816 * state of the screen but it is actually sent in response to changes in the
1817 * overall interactive state of the device.
1818 * </p><p>
1819 * This broadcast is sent when the device becomes non-interactive which may have
1820 * nothing to do with the screen turning off. To determine the
1821 * actual state of the screen, use {@link android.view.Display#getState}.
1822 * </p><p>
1823 * See {@link android.os.PowerManager#isInteractive} for details.
1824 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001825 * You <em>cannot</em> receive this through components declared in
1826 * manifests, only by explicitly registering for it with
1827 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1828 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001829 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001830 * <p class="note">This is a protected intent that can only be sent
1831 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1834 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001835
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001837 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1838 * <p>
1839 * For historical reasons, the name of this broadcast action refers to the power
1840 * state of the screen but it is actually sent in response to changes in the
1841 * overall interactive state of the device.
1842 * </p><p>
1843 * This broadcast is sent when the device becomes interactive which may have
1844 * nothing to do with the screen turning on. To determine the
1845 * actual state of the screen, use {@link android.view.Display#getState}.
1846 * </p><p>
1847 * See {@link android.os.PowerManager#isInteractive} for details.
1848 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001849 * You <em>cannot</em> receive this through components declared in
1850 * manifests, only by explicitly registering for it with
1851 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1852 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001853 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001854 * <p class="note">This is a protected intent that can only be sent
1855 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001856 */
1857 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1858 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001859
1860 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001861 * Broadcast Action: Sent after the system stops dreaming.
1862 *
1863 * <p class="note">This is a protected intent that can only be sent by the system.
1864 * It is only sent to registered receivers.</p>
1865 */
1866 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1867 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1868
1869 /**
1870 * Broadcast Action: Sent after the system starts dreaming.
1871 *
1872 * <p class="note">This is a protected intent that can only be sent by the system.
1873 * It is only sent to registered receivers.</p>
1874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1876 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1877
1878 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001879 * 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 -07001880 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001881 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001882 * <p class="note">This is a protected intent that can only be sent
1883 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001884 */
1885 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001886 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001887
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001888 /**
1889 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001890 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001891 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001892 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1893 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001894 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001895 * <p class="note">This is a protected intent that can only be sent
1896 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1899 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1900 /**
1901 * Broadcast Action: The time was set.
1902 */
1903 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1904 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1905 /**
1906 * Broadcast Action: The date has changed.
1907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1910 /**
1911 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1912 * <ul>
1913 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1914 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001915 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001916 * <p class="note">This is a protected intent that can only be sent
1917 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1921 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001922 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1923 * DNS entries should be tossed.
1924 * @hide
1925 */
1926 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1927 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1928 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001929 * Alarm Changed Action: This is broadcast when the AlarmClock
1930 * application's alarm is set or unset. It is used by the
1931 * AlarmClock application and the StatusBar service.
1932 * @hide
1933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001936
1937 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001938 * Broadcast Action: This is broadcast once, after the user has finished
1939 * booting, but while still in the "locked" state. It can be used to perform
1940 * application-specific initialization, such as installing alarms. You must
1941 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1942 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001943 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001944 * This broadcast is sent immediately at boot by all devices (regardless of
1945 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1946 * higher. Upon receipt of this broadcast, the user is still locked and only
1947 * device-protected storage can be accessed safely. If you want to access
1948 * credential-protected storage, you need to wait for the user to be
1949 * unlocked (typically by entering their lock pattern or PIN for the first
1950 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1951 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1952 * <p>
1953 * To receive this broadcast, your receiver component must be marked as
1954 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001955 * <p class="note">
1956 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001957 *
1958 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001963 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001964 * Broadcast Action: This is broadcast once, after the user has finished
1965 * booting. It can be used to perform application-specific initialization,
1966 * such as installing alarms. You must hold the
1967 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1968 * order to receive this broadcast.
1969 * <p>
1970 * This broadcast is sent at boot by all devices (both with and without
1971 * direct boot support). Upon receipt of this broadcast, the user is
1972 * unlocked and both device-protected and credential-protected storage can
1973 * accessed safely.
1974 * <p>
1975 * If you need to run while the user is still locked (before they've entered
1976 * their lock pattern or PIN for the first time), you can listen for the
1977 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1978 * <p class="note">
1979 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001983
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 /**
1985 * Broadcast Action: This is broadcast when a user action should request a
1986 * temporary system dialog to dismiss. Some examples of temporary system
1987 * dialogs are the notification window-shade and the recent tasks dialog.
1988 */
1989 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1990 /**
1991 * Broadcast Action: Trigger the download and eventual installation
1992 * of a package.
1993 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001994 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001995 * <p class="note">This is a protected intent that can only be sent
1996 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001997 *
1998 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001999 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002000 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2002 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2003 /**
2004 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002005 * device. The data contains the name of the package. Note that the
2006 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002007 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002008 * <ul>
2009 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2010 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2011 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2012 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002013 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002014 * <p class="note">This is a protected intent that can only be sent
2015 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2019 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002020 * Broadcast Action: A new version of an application package has been
2021 * installed, replacing an existing version that was previously installed.
2022 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002023 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002024 * <ul>
2025 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2026 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002027 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002028 * <p class="note">This is a protected intent that can only be sent
2029 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002030 */
2031 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2032 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2033 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002034 * Broadcast Action: A new version of your application has been installed
2035 * over an existing one. This is only sent to the application that was
2036 * replaced. It does not contain any additional data; to receive it, just
2037 * use an intent filter for this action.
2038 *
2039 * <p class="note">This is a protected intent that can only be sent
2040 * by the system.
2041 */
2042 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2043 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2044 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002045 * Broadcast Action: An existing application package has been removed from
2046 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002047 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002048 * <ul>
2049 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2050 * to the package.
2051 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2052 * application -- data and code -- is being removed.
2053 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2054 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2055 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002056 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002057 * <p class="note">This is a protected intent that can only be sent
2058 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2062 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002063 * Broadcast Action: An existing application package has been completely
2064 * removed from the device. The data contains the name of the package.
2065 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2066 * {@link #EXTRA_DATA_REMOVED} is true and
2067 * {@link #EXTRA_REPLACING} is false of that broadcast.
2068 *
2069 * <ul>
2070 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2071 * to the package.
2072 * </ul>
2073 *
2074 * <p class="note">This is a protected intent that can only be sent
2075 * by the system.
2076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_PACKAGE_FULLY_REMOVED
2079 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2080 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002081 * Broadcast Action: An existing application package has been changed (for
2082 * example, a component has been enabled or disabled). The data contains
2083 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002084 * <ul>
2085 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002086 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002087 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002088 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2089 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002090 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002091 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002092 * <p class="note">This is a protected intent that can only be sent
2093 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002094 */
2095 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2096 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2097 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002098 * @hide
2099 * Broadcast Action: Ask system services if there is any reason to
2100 * restart the given package. The data contains the name of the
2101 * package.
2102 * <ul>
2103 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2104 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2105 * </ul>
2106 *
2107 * <p class="note">This is a protected intent that can only be sent
2108 * by the system.
2109 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002110 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002111 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2112 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2113 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002114 * Broadcast Action: The user has restarted a package, and all of its
2115 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002117 * be removed. Note that the restarted package does <em>not</em>
2118 * receive this broadcast.
2119 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002120 * <ul>
2121 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2122 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002123 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002124 * <p class="note">This is a protected intent that can only be sent
2125 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002126 */
2127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2128 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2129 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002130 * Broadcast Action: The user has cleared the data of a package. This should
2131 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002132 * its persistent data is erased and this broadcast sent.
2133 * Note that the cleared package does <em>not</em>
2134 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002135 * <ul>
2136 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2137 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002138 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002139 * <p class="note">This is a protected intent that can only be sent
2140 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002141 */
2142 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2143 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2144 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002145 * Broadcast Action: Packages have been suspended.
2146 * <p>Includes the following extras:
2147 * <ul>
2148 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2149 * </ul>
2150 *
2151 * <p class="note">This is a protected intent that can only be sent
2152 * by the system. It is only sent to registered receivers.
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2156 /**
2157 * Broadcast Action: Packages have been unsuspended.
2158 * <p>Includes the following extras:
2159 * <ul>
2160 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2161 * </ul>
2162 *
2163 * <p class="note">This is a protected intent that can only be sent
2164 * by the system. It is only sent to registered receivers.
2165 */
2166 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2167 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2168 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002169 * Broadcast Action: A user ID has been removed from the system. The user
2170 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002171 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002172 * <p class="note">This is a protected intent that can only be sent
2173 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002174 */
2175 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2176 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002177
2178 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002179 * Broadcast Action: Sent to the installer package of an application when
2180 * that application is first launched (that is the first time it is moved
2181 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002182 *
2183 * <p class="note">This is a protected intent that can only be sent
2184 * by the system.
2185 */
2186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2187 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2188
2189 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002190 * Broadcast Action: Sent to the system package verifier when a package
2191 * needs to be verified. The data contains the package URI.
2192 * <p class="note">
2193 * This is a protected intent that can only be sent by the system.
2194 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002195 */
2196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2197 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2198
2199 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002200 * Broadcast Action: Sent to the system package verifier when a package is
2201 * verified. The data contains the package URI.
2202 * <p class="note">
2203 * This is a protected intent that can only be sent by the system.
2204 */
2205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2207
2208 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002209 * Broadcast Action: Sent to the system intent filter verifier when an
2210 * intent filter needs to be verified. The data contains the filter data
2211 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002212 * <p class="note">
2213 * This is a protected intent that can only be sent by the system.
2214 * </p>
2215 *
2216 * @hide
2217 */
2218 @SystemApi
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2220 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2221
2222 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002223 * Broadcast Action: Resources for a set of packages (which were
2224 * previously unavailable) are currently
2225 * available since the media on which they exist is available.
2226 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2227 * list of packages whose availability changed.
2228 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2229 * list of uids of packages whose availability changed.
2230 * Note that the
2231 * packages in this list do <em>not</em> receive this broadcast.
2232 * The specified set of packages are now available on the system.
2233 * <p>Includes the following extras:
2234 * <ul>
2235 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2236 * whose resources(were previously unavailable) are currently available.
2237 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2238 * packages whose resources(were previously unavailable)
2239 * are currently available.
2240 * </ul>
2241 *
2242 * <p class="note">This is a protected intent that can only be sent
2243 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002244 */
2245 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002246 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2247 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002248
2249 /**
2250 * Broadcast Action: Resources for a set of packages are currently
2251 * unavailable since the media on which they exist is unavailable.
2252 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2253 * list of packages whose availability changed.
2254 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2255 * list of uids of packages whose availability changed.
2256 * The specified set of packages can no longer be
2257 * launched and are practically unavailable on the system.
2258 * <p>Inclues the following extras:
2259 * <ul>
2260 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2261 * whose resources are no longer available.
2262 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2263 * whose resources are no longer available.
2264 * </ul>
2265 *
2266 * <p class="note">This is a protected intent that can only be sent
2267 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002268 */
2269 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002270 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002271 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002272
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002273 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002274 * Broadcast Action: preferred activities have changed *explicitly*.
2275 *
2276 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2277 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2278 * be sent.
2279 *
2280 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2281 *
2282 * @hide
2283 */
2284 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2285 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2286 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2287
2288
2289 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002291 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002292 * This should <em>only</em> be used to determine when the wallpaper
2293 * has changed to show the new wallpaper to the user. You should certainly
2294 * never, in response to this, change the wallpaper or other attributes of
2295 * it such as the suggested size. That would be crazy, right? You'd cause
2296 * all kinds of loops, especially if other apps are doing similar things,
2297 * right? Of course. So please don't do this.
2298 *
2299 * @deprecated Modern applications should use
2300 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2301 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2302 * shown behind their UI, rather than watching for this broadcast and
2303 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002305 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002306 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2307 /**
2308 * Broadcast Action: The current device {@link android.content.res.Configuration}
2309 * (orientation, locale, etc) has changed. When such a change happens, the
2310 * UIs (view hierarchy) will need to be rebuilt based on this new
2311 * information; for the most part, applications don't need to worry about
2312 * this, because the system will take care of stopping and restarting the
2313 * application to make sure it sees the new changes. Some system code that
2314 * can not be restarted will need to watch for this action and handle it
2315 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002316 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002317 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002318 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002319 * in manifests, only by explicitly registering for it with
2320 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2321 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002322 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002323 * <p class="note">This is a protected intent that can only be sent
2324 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002325 *
2326 * @see android.content.res.Configuration
2327 */
2328 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2329 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2330 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002331 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002332 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002333 * <p class="note">This is a protected intent that can only be sent
2334 * by the system.
2335 */
2336 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2337 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2338 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002339 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2340 * charging state, level, and other information about the battery.
2341 * See {@link android.os.BatteryManager} for documentation on the
2342 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002343 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002344 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002345 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002346 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002347 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002348 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2349 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2350 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2351 * broadcasts that are sent and can be received through manifest
2352 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002353 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002354 * <p class="note">This is a protected intent that can only be sent
2355 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002356 */
2357 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2358 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2359 /**
2360 * Broadcast Action: Indicates low battery condition on the device.
2361 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002362 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002363 * <p class="note">This is a protected intent that can only be sent
2364 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002365 */
2366 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2367 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2368 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002369 * Broadcast Action: Indicates the battery is now okay after being low.
2370 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2371 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002372 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002373 * <p class="note">This is a protected intent that can only be sent
2374 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2377 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2378 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002379 * Broadcast Action: External power has been connected to the device.
2380 * This is intended for applications that wish to register specifically to this notification.
2381 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2382 * stay active to receive this notification. This action can be used to implement actions
2383 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002384 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002385 * <p class="note">This is a protected intent that can only be sent
2386 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002387 */
2388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002389 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002390 /**
2391 * Broadcast Action: External power has been removed from the device.
2392 * This is intended for applications that wish to register specifically to this notification.
2393 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2394 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002395 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002396 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002397 * <p class="note">This is a protected intent that can only be sent
2398 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002399 */
2400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002401 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002402 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002403 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002404 * Broadcast Action: Device is shutting down.
2405 * This is broadcast when the device is being shut down (completely turned
2406 * off, not sleeping). Once the broadcast is complete, the final shutdown
2407 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002408 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002409 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002410 * <p class="note">This is a protected intent that can only be sent
2411 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002412 * <p>May include the following extras:
2413 * <ul>
2414 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2415 * shutdown is only for userspace processes. If not set, assumed to be false.
2416 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002417 */
2418 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002419 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002420 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002421 * Activity Action: Start this activity to request system shutdown.
2422 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002423 * to request confirmation from the user before shutting down. The optional boolean
2424 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2425 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002426 *
2427 * <p class="note">This is a protected intent that can only be sent
2428 * by the system.
2429 *
2430 * {@hide}
2431 */
2432 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2433 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002434 * Broadcast Action: A sticky broadcast that indicates low memory
2435 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002436 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002437 * <p class="note">This is a protected intent that can only be sent
2438 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002439 */
2440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2441 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2442 /**
2443 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002444 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002445 * <p class="note">This is a protected intent that can only be sent
2446 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002447 */
2448 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2449 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2450 /**
Jake Hambybb371632010-08-23 18:16:48 -07002451 * Broadcast Action: A sticky broadcast that indicates a memory full
2452 * condition on the device. This is intended for activities that want
2453 * to be able to fill the data partition completely, leaving only
2454 * enough free space to prevent system-wide SQLite failures.
2455 *
2456 * <p class="note">This is a protected intent that can only be sent
2457 * by the system.
2458 *
2459 * {@hide}
2460 */
2461 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2462 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2463 /**
2464 * Broadcast Action: Indicates memory full condition on the device
2465 * no longer exists.
2466 *
2467 * <p class="note">This is a protected intent that can only be sent
2468 * by the system.
2469 *
2470 * {@hide}
2471 */
2472 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2473 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2474 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002475 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2476 * and package management should be started.
2477 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2478 * notification.
2479 */
2480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2481 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2482 /**
2483 * Broadcast Action: The device has entered USB Mass Storage mode.
2484 * This is used mainly for the USB Settings panel.
2485 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2486 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002487 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002488 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002489 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002490 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2491
2492 /**
2493 * Broadcast Action: The device has exited USB Mass Storage mode.
2494 * This is used mainly for the USB Settings panel.
2495 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2496 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002497 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002498 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002499 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002500 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2501
2502 /**
2503 * Broadcast Action: External media has been removed.
2504 * The path to the mount point for the removed media is contained in the Intent.mData field.
2505 */
2506 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2507 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2508
2509 /**
2510 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002511 * 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 -07002512 */
2513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2514 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2515
2516 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002517 * Broadcast Action: External media is present, and being disk-checked
2518 * 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 -08002519 */
2520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2521 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2522
2523 /**
2524 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2525 * 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 -08002526 */
2527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2528 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2529
2530 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002531 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002532 * 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 -07002533 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2534 * media was mounted read only.
2535 */
2536 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2537 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2538
2539 /**
2540 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002541 * 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 -07002542 */
2543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2544 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2545
2546 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002547 * Broadcast Action: External media is no longer being shared via USB mass storage.
2548 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2549 *
2550 * @hide
2551 */
2552 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2553
2554 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002555 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2556 * The path to the mount point for the removed media is contained in the Intent.mData field.
2557 */
2558 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2559 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2560
2561 /**
2562 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002563 * 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 -07002564 */
2565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2566 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2567
2568 /**
2569 * Broadcast Action: User has expressed the desire to remove the external storage media.
2570 * Applications should close all files they have open within the mount point when they receive this intent.
2571 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2572 */
2573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2574 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2575
2576 /**
2577 * Broadcast Action: The media scanner has started scanning a directory.
2578 * The path to the directory being scanned is contained in the Intent.mData field.
2579 */
2580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2581 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2582
2583 /**
2584 * Broadcast Action: The media scanner has finished scanning a directory.
2585 * The path to the scanned directory is contained in the Intent.mData field.
2586 */
2587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2588 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2589
2590 /**
2591 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2592 * The path to the file is contained in the Intent.mData field.
2593 */
2594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2595 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2596
2597 /**
2598 * Broadcast Action: The "Media Button" was pressed. Includes a single
2599 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2600 * caused the broadcast.
2601 */
2602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2603 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2604
2605 /**
2606 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2607 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2608 * caused the broadcast.
2609 */
2610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2611 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2612
2613 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2614 // location; they are not general-purpose actions.
2615
2616 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002617 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002618 */
2619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2620 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2621 "android.intent.action.GTALK_CONNECTED";
2622
2623 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002624 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002625 */
2626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2627 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2628 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002629
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002630 /**
2631 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002632 */
2633 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2634 public static final String ACTION_INPUT_METHOD_CHANGED =
2635 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002636
2637 /**
2638 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2639 * more radios have been turned off or on. The intent will have the following extra value:</p>
2640 * <ul>
2641 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2642 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2643 * turned off</li>
2644 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002645 *
Peng Xua35b5532016-01-20 00:05:45 -08002646 * <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 -07002647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2649 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2650
2651 /**
2652 * Broadcast Action: Some content providers have parts of their namespace
2653 * where they publish new events or items that the user may be especially
2654 * interested in. For these things, they may broadcast this action when the
2655 * set of interesting items change.
2656 *
2657 * For example, GmailProvider sends this notification when the set of unread
2658 * mail in the inbox changes.
2659 *
2660 * <p>The data of the intent identifies which part of which provider
2661 * changed. When queried through the content resolver, the data URI will
2662 * return the data set in question.
2663 *
2664 * <p>The intent will have the following extra values:
2665 * <ul>
2666 * <li><em>count</em> - The number of items in the data set. This is the
2667 * same as the number of items in the cursor returned by querying the
2668 * data URI. </li>
2669 * </ul>
2670 *
2671 * This intent will be sent at boot (if the count is non-zero) and when the
2672 * data set changes. It is possible for the data set to change without the
2673 * count changing (for example, if a new unread message arrives in the same
2674 * sync operation in which a message is archived). The phone should still
2675 * ring/vibrate/etc as normal in this case.
2676 */
2677 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2678 public static final String ACTION_PROVIDER_CHANGED =
2679 "android.intent.action.PROVIDER_CHANGED";
2680
2681 /**
2682 * Broadcast Action: Wired Headset plugged in or unplugged.
2683 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002684 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2685 * and documentation.
2686 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002687 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002688 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002689 */
2690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002691 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002692
2693 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002694 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2695 * <ul>
2696 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2697 * </ul>
2698 *
2699 * <p class="note">This is a protected intent that can only be sent
2700 * by the system.
2701 *
2702 * @hide
2703 */
2704 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2705 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2706 = "android.intent.action.ADVANCED_SETTINGS";
2707
2708 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002709 * Broadcast Action: Sent after application restrictions are changed.
2710 *
2711 * <p class="note">This is a protected intent that can only be sent
2712 * by the system.</p>
2713 */
2714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2715 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2716 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2717
2718 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002719 * Broadcast Action: An outgoing call is about to be placed.
2720 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002721 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002722 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002723 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 * the phone number originally intended to be dialed.</li>
2725 * </ul>
2726 * <p>Once the broadcast is finished, the resultData is used as the actual
2727 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002728 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002729 * outgoing call in turn: for example, a parental control application
2730 * might verify that the user is authorized to place the call at that
2731 * time, then a number-rewriting application might add an area code if
2732 * one was not specified.</p>
2733 * <p>For consistency, any receiver whose purpose is to prohibit phone
2734 * calls should have a priority of 0, to ensure it will see the final
2735 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002736 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002737 * should have a positive priority.
2738 * Negative priorities are reserved for the system for this broadcast;
2739 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002740 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2741 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002742 * <p>Emergency calls cannot be intercepted using this mechanism, and
2743 * other calls cannot be modified to call emergency numbers using this
2744 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002745 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2746 * call to use their own service instead. Those apps should first prevent
2747 * the call from being placed by setting resultData to <code>null</code>
2748 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002749 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2751 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002752 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002753 * <p class="note">This is a protected intent that can only be sent
2754 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002755 */
2756 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2757 public static final String ACTION_NEW_OUTGOING_CALL =
2758 "android.intent.action.NEW_OUTGOING_CALL";
2759
2760 /**
2761 * Broadcast Action: Have the device reboot. This is only for use by
2762 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002763 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002764 * <p class="note">This is a protected intent that can only be sent
2765 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002766 */
2767 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2768 public static final String ACTION_REBOOT =
2769 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002770
Wei Huang97ecc9c2009-05-11 17:44:20 -07002771 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002772 * Broadcast Action: A sticky broadcast for changes in the physical
2773 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002774 *
2775 * <p>The intent will have the following extra values:
2776 * <ul>
2777 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002778 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002779 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002780 * <p>This is intended for monitoring the current physical dock state.
2781 * See {@link android.app.UiModeManager} for the normal API dealing with
2782 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002783 */
2784 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2785 public static final String ACTION_DOCK_EVENT =
2786 "android.intent.action.DOCK_EVENT";
2787
2788 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002789 * Broadcast Action: A broadcast when idle maintenance can be started.
2790 * This means that the user is not interacting with the device and is
2791 * not expected to do so soon. Typical use of the idle maintenance is
2792 * to perform somehow expensive tasks that can be postponed at a moment
2793 * when they will not degrade user experience.
2794 * <p>
2795 * <p class="note">In order to keep the device responsive in case of an
2796 * unexpected user interaction, implementations of a maintenance task
2797 * should be interruptible. In such a scenario a broadcast with action
2798 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2799 * should not do the maintenance work in
2800 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2801 * maintenance service by {@link Context#startService(Intent)}. Also
2802 * you should hold a wake lock while your maintenance service is running
2803 * to prevent the device going to sleep.
2804 * </p>
2805 * <p>
2806 * <p class="note">This is a protected intent that can only be sent by
2807 * the system.
2808 * </p>
2809 *
2810 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002811 *
2812 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002813 */
2814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2815 public static final String ACTION_IDLE_MAINTENANCE_START =
2816 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2817
2818 /**
2819 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2820 * This means that the user was not interacting with the device as a result
2821 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2822 * was sent and now the user started interacting with the device. Typical
2823 * use of the idle maintenance is to perform somehow expensive tasks that
2824 * can be postponed at a moment when they will not degrade user experience.
2825 * <p>
2826 * <p class="note">In order to keep the device responsive in case of an
2827 * unexpected user interaction, implementations of a maintenance task
2828 * should be interruptible. Hence, on receiving a broadcast with this
2829 * action, the maintenance task should be interrupted as soon as possible.
2830 * In other words, you should not do the maintenance work in
2831 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2832 * maintenance service that was started on receiving of
2833 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2834 * lock you acquired when your maintenance service started.
2835 * </p>
2836 * <p class="note">This is a protected intent that can only be sent
2837 * by the system.
2838 *
2839 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002840 *
2841 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002842 */
2843 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2844 public static final String ACTION_IDLE_MAINTENANCE_END =
2845 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2846
2847 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002848 * Broadcast Action: a remote intent is to be broadcasted.
2849 *
2850 * A remote intent is used for remote RPC between devices. The remote intent
2851 * is serialized and sent from one device to another device. The receiving
2852 * device parses the remote intent and broadcasts it. Note that anyone can
2853 * broadcast a remote intent. However, if the intent receiver of the remote intent
2854 * does not trust intent broadcasts from arbitrary intent senders, it should require
2855 * the sender to hold certain permissions so only trusted sender's broadcast will be
2856 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002857 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002858 */
2859 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002860 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002861
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002862 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002863 * Broadcast Action: This is broadcast once when the user is booting after a
2864 * system update. It can be used to perform cleanup or upgrades after a
2865 * system update.
2866 * <p>
2867 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2868 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2869 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2870 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002871 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002872 * @hide
2873 */
2874 public static final String ACTION_PRE_BOOT_COMPLETED =
2875 "android.intent.action.PRE_BOOT_COMPLETED";
2876
Amith Yamasani13593602012-03-22 16:16:17 -07002877 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002878 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002879 * on restricted users. The broadcast intent contains an extra
2880 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2881 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2882 * String[] depending on the restriction type.<p/>
2883 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002884 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2885 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2886 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002887 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2888 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002889 * @see RestrictionEntry
2890 */
2891 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2892 "android.intent.action.GET_RESTRICTION_ENTRIES";
2893
2894 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002895 * Sent the first time a user is starting, to allow system apps to
2896 * perform one time initialization. (This will not be seen by third
2897 * party applications because a newly initialized user does not have any
2898 * third party applications installed for it.) This is sent early in
2899 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002900 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2901 * broadcast, since it is part of a visible user interaction; be as quick
2902 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002903 */
2904 public static final String ACTION_USER_INITIALIZE =
2905 "android.intent.action.USER_INITIALIZE";
2906
2907 /**
2908 * Sent when a user switch is happening, causing the process's user to be
2909 * brought to the foreground. This is only sent to receivers registered
2910 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2911 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002912 * foreground. This is sent as a foreground
2913 * broadcast, since it is part of a visible user interaction; be as quick
2914 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002915 */
2916 public static final String ACTION_USER_FOREGROUND =
2917 "android.intent.action.USER_FOREGROUND";
2918
2919 /**
2920 * Sent when a user switch is happening, causing the process's user to be
2921 * sent to the background. This is only sent to receivers registered
2922 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2923 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002924 * background. This is sent as a foreground
2925 * broadcast, since it is part of a visible user interaction; be as quick
2926 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002927 */
2928 public static final String ACTION_USER_BACKGROUND =
2929 "android.intent.action.USER_BACKGROUND";
2930
2931 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002932 * Broadcast sent to the system when a user is added. Carries an extra
2933 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2934 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002935 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002936 * @hide
2937 */
2938 public static final String ACTION_USER_ADDED =
2939 "android.intent.action.USER_ADDED";
2940
2941 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002942 * Broadcast sent by the system when a user is started. Carries an extra
2943 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002944 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002945 * that has been started. This is sent as a foreground
2946 * broadcast, since it is part of a visible user interaction; be as quick
2947 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002948 * @hide
2949 */
2950 public static final String ACTION_USER_STARTED =
2951 "android.intent.action.USER_STARTED";
2952
2953 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002954 * Broadcast sent when a user is in the process of starting. Carries an extra
2955 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2956 * sent to registered receivers, not manifest receivers. It is sent to all
2957 * users (including the one that is being started). You must hold
2958 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2959 * this broadcast. This is sent as a background broadcast, since
2960 * its result is not part of the primary UX flow; to safely keep track of
2961 * started/stopped state of a user you can use this in conjunction with
2962 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2963 * other user state broadcasts since those are foreground broadcasts so can
2964 * execute in a different order.
2965 * @hide
2966 */
2967 public static final String ACTION_USER_STARTING =
2968 "android.intent.action.USER_STARTING";
2969
2970 /**
2971 * Broadcast sent when a user is going to be stopped. Carries an extra
2972 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2973 * sent to registered receivers, not manifest receivers. It is sent to all
2974 * users (including the one that is being stopped). You must hold
2975 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2976 * this broadcast. The user will not stop until all receivers have
2977 * handled the broadcast. This is sent as a background broadcast, since
2978 * its result is not part of the primary UX flow; to safely keep track of
2979 * started/stopped state of a user you can use this in conjunction with
2980 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2981 * other user state broadcasts since those are foreground broadcasts so can
2982 * execute in a different order.
2983 * @hide
2984 */
2985 public static final String ACTION_USER_STOPPING =
2986 "android.intent.action.USER_STOPPING";
2987
2988 /**
2989 * Broadcast sent to the system when a user is stopped. Carries an extra
2990 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2991 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2992 * specific package. This is only sent to registered receivers, not manifest
2993 * receivers. It is sent to all running users <em>except</em> the one that
2994 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002995 * @hide
2996 */
2997 public static final String ACTION_USER_STOPPED =
2998 "android.intent.action.USER_STOPPED";
2999
3000 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003001 * 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 -07003002 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003003 * one that has been removed. The user will not be completely removed until all receivers have
3004 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003005 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003006 * @hide
3007 */
3008 public static final String ACTION_USER_REMOVED =
3009 "android.intent.action.USER_REMOVED";
3010
3011 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003012 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003013 * the userHandle of the user to become the current one. This is only sent to
3014 * registered receivers, not manifest receivers. It is sent to all running users.
3015 * You must hold
3016 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003017 * @hide
3018 */
3019 public static final String ACTION_USER_SWITCHED =
3020 "android.intent.action.USER_SWITCHED";
3021
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003022 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003023 * Broadcast Action: Sent when the credential-encrypted private storage has
3024 * become unlocked for the target user. This is only sent to registered
3025 * receivers, not manifest receivers.
3026 */
3027 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3028 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3029
3030 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003031 * Broadcast sent to the system when a user's information changes. Carries an extra
3032 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003033 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003034 * @hide
3035 */
3036 public static final String ACTION_USER_INFO_CHANGED =
3037 "android.intent.action.USER_INFO_CHANGED";
3038
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003039 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003040 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3041 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003042 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3043 * that need to display merged content across both primary and managed profiles need to
3044 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003045 * not manifest receivers.
3046 */
3047 public static final String ACTION_MANAGED_PROFILE_ADDED =
3048 "android.intent.action.MANAGED_PROFILE_ADDED";
3049
3050 /**
3051 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003052 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3053 * Only applications (for example Launchers) that need to display merged content across both
3054 * primary and managed profiles need to worry about this broadcast. This is only sent to
3055 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003056 */
3057 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3058 "android.intent.action.MANAGED_PROFILE_REMOVED";
3059
3060 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003061 * Broadcast sent to the primary user when the credential-encrypted private storage for
3062 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3063 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3064 * Launchers) that need to display merged content across both primary and managed profiles
3065 * need to worry about this broadcast. This is only sent to registered receivers,
3066 * not manifest receivers.
3067 */
3068 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3069 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3070
3071 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003072 * Broadcast sent to the primary user when an associated managed profile has become available.
3073 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003074 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3075 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3076 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003077 */
Rubin Xue95057a2016-04-01 16:49:25 +01003078 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3079 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3080
3081 /**
3082 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3083 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3084 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3085 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3086 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3087 */
3088 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3089 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003090
3091 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003092 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3093 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3094 * the device was locked or unlocked.
3095 *
3096 * This is only sent to registered receivers.
3097 *
3098 * @hide
3099 */
3100 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3101 "android.intent.action.DEVICE_LOCKED_CHANGED";
3102
3103 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003104 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3105 */
3106 public static final String ACTION_QUICK_CLOCK =
3107 "android.intent.action.QUICK_CLOCK";
3108
Michael Wright0087a142013-02-05 16:29:39 -08003109 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003110 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003111 * @hide
3112 */
3113 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3114 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3115
Justin Kohd378ad72013-04-01 12:18:26 -07003116 /**
3117 * Broadcast Action: A global button was pressed. Includes a single
3118 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3119 * caused the broadcast.
3120 * @hide
3121 */
3122 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3123
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003124 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003125 * Broadcast Action: Sent when media resource is granted.
3126 * <p>
3127 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3128 * granted.
3129 * </p>
3130 * <p class="note">
3131 * This is a protected intent that can only be sent by the system.
3132 * </p>
3133 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003134 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003135 * </p>
3136 *
3137 * @hide
3138 */
3139 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3140 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3141
3142 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003143 * Broadcast Action: An overlay package has been installed. The data
3144 * contains the name of the added overlay package.
3145 * @hide
3146 */
3147 public static final String ACTION_OVERLAY_ADDED = "android.intent.action.OVERLAY_ADDED";
3148
3149 /**
3150 * Broadcast Action: An overlay package has changed. The data contains the
3151 * name of the overlay package which has changed. This is broadcast on all
3152 * changes to the OverlayInfo returned by {@link
3153 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3154 * most common change is a state change that will change whether the
3155 * overlay is enabled or not.
3156 * @hide
3157 */
3158 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3159
3160 /**
3161 * Broadcast Action: An overlay package has been removed. The data contains
3162 * the name of the overlay package which has been removed.
3163 * @hide
3164 */
3165 public static final String ACTION_OVERLAY_REMOVED = "android.intent.action.OVERLAY_REMOVED";
3166
3167 /**
3168 * Broadcast Action: The order of a package's list of overlay packages has
3169 * changed. The data contains the package name of the overlay package that
3170 * had its position in the list adjusted.
3171 * @hide
3172 */
3173 public static final String
3174 ACTION_OVERLAY_PRIORITY_CHANGED = "android.intent.action.OVERLAY_PRIORITY_CHANGED";
3175
3176 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003177 * Activity Action: Allow the user to select and return one or more existing
3178 * documents. When invoked, the system will display the various
3179 * {@link DocumentsProvider} instances installed on the device, letting the
3180 * user interactively navigate through them. These documents include local
3181 * media, such as photos and video, and documents provided by installed
3182 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003183 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003184 * Each document is represented as a {@code content://} URI backed by a
3185 * {@link DocumentsProvider}, which can be opened as a stream with
3186 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3187 * {@link android.provider.DocumentsContract.Document} metadata.
3188 * <p>
3189 * All selected documents are returned to the calling application with
3190 * persistable read and write permission grants. If you want to maintain
3191 * access to the documents across device reboots, you need to explicitly
3192 * take the persistable permissions using
3193 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3194 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003195 * Callers must indicate the acceptable document MIME types through
3196 * {@link #setType(String)}. For example, to select photos, use
3197 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3198 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3199 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003200 * <p>
3201 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003202 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3203 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003204 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003205 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3206 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003207 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003208 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003209 * Callers can set a document URI through
3210 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3211 * location of documents navigator. System will do its best to launch the
3212 * navigator in the specified document if it's a folder, or the folder that
3213 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003214 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003215 * Output: The URI of the item that was picked, returned in
3216 * {@link #getData()}. This must be a {@code content://} URI so that any
3217 * receiver can access it. If multiple documents were selected, they are
3218 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003219 *
3220 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003221 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003222 * @see #ACTION_CREATE_DOCUMENT
3223 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003224 */
3225 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3226 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3227
3228 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003229 * Activity Action: Allow the user to create a new document. When invoked,
3230 * the system will display the various {@link DocumentsProvider} instances
3231 * installed on the device, letting the user navigate through them. The
3232 * returned document may be a newly created document with no content, or it
3233 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003234 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003235 * Each document is represented as a {@code content://} URI backed by a
3236 * {@link DocumentsProvider}, which can be opened as a stream with
3237 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3238 * {@link android.provider.DocumentsContract.Document} metadata.
3239 * <p>
3240 * Callers must indicate the concrete MIME type of the document being
3241 * created by setting {@link #setType(String)}. This MIME type cannot be
3242 * changed after the document is created.
3243 * <p>
3244 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3245 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003246 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003247 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3248 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003249 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003250 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003251 * Callers can set a document URI through
3252 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3253 * location of documents navigator. System will do its best to launch the
3254 * navigator in the specified document if it's a folder, or the folder that
3255 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003256 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003257 * Output: The URI of the item that was created. This must be a
3258 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003259 *
3260 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003261 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003262 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003263 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003264 */
3265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3266 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3267
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003268 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003269 * Activity Action: Allow the user to pick a directory subtree. When
3270 * invoked, the system will display the various {@link DocumentsProvider}
3271 * instances installed on the device, letting the user navigate through
3272 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003273 * <p>
3274 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003275 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3276 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3277 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003278 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003279 * Callers can set a document URI through
3280 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3281 * location of documents navigator. System will do its best to launch the
3282 * navigator in the specified document if it's a folder, or the folder that
3283 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003284 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003285 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003286 *
3287 * @see DocumentsContract
3288 */
3289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003290 public static final String
3291 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003292
Felipe Lemec7b1f892016-01-15 15:02:31 -08003293 /**
Peng Xua35b5532016-01-20 00:05:45 -08003294 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3295 * exisiting sensor being disconnected.
3296 *
3297 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3298 *
3299 * {@hide}
3300 */
3301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3302 public static final String
3303 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3304
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003305 /**
3306 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3307 *
3308 * {@hide}
3309 */
3310 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003311 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3312
Christopher Tate6597e342015-02-17 12:15:25 -08003313 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003314 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3315 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3316 *
3317 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3318 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003319 * @hide
3320 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003321 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003322 public static final String EXTRA_FORCE_MASTER_CLEAR =
3323 "android.intent.extra.FORCE_MASTER_CLEAR";
3324
3325 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003326 * A broadcast action to trigger a factory reset.
3327 *
3328 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3329 *
3330 * <p>Not for use by third-party applications.
3331 *
3332 * @see #EXTRA_FORCE_MASTER_CLEAR
3333 *
3334 * {@hide}
3335 */
3336 @SystemApi
3337 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3338 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3339
3340 /**
3341 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3342 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3343 *
3344 * <p>Not for use by third-party applications.
3345 *
3346 * @hide
3347 */
3348 @SystemApi
3349 public static final String EXTRA_FORCE_FACTORY_RESET =
3350 "android.intent.extra.FORCE_FACTORY_RESET";
3351
3352 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003353 * Broadcast action: report that a settings element is being restored from backup. The intent
3354 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3355 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3356 * is the value of that settings entry prior to the restore operation. All of these values are
3357 * represented as strings.
3358 *
3359 * <p>This broadcast is sent only for settings provider entries known to require special handling
3360 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3361 * the provider's backup agent implementation.
3362 *
3363 * @see #EXTRA_SETTING_NAME
3364 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3365 * @see #EXTRA_SETTING_NEW_VALUE
3366 * {@hide}
3367 */
3368 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3369
3370 /** {@hide} */
3371 public static final String EXTRA_SETTING_NAME = "setting_name";
3372 /** {@hide} */
3373 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3374 /** {@hide} */
3375 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3376
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003377 /**
3378 * Activity Action: Process a piece of text.
3379 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3380 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3381 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3382 */
3383 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3384 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3385 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003386 * The name of the extra used to define the text to be processed, as a
3387 * CharSequence. Note that this may be a styled CharSequence, so you must use
3388 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003389 */
3390 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3391 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003392 * 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 +00003393 */
3394 public static final String EXTRA_PROCESS_TEXT_READONLY =
3395 "android.intent.extra.PROCESS_TEXT_READONLY";
3396
Bryce Leebc58f592015-09-25 16:43:01 -07003397 /**
3398 * Broadcast action: reports when a new thermal event has been reached. When the device
3399 * is reaching its maximum temperatue, the thermal level reported
3400 * {@hide}
3401 */
3402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3403 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3404
3405 /** {@hide} */
3406 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3407
3408 /**
3409 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003410 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003411 * {@hide}
3412 */
3413 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3414
3415 /**
3416 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003417 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003418 * {@hide}
3419 */
3420 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3421
3422 /**
3423 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003424 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003425 * {@hide}
3426 */
3427 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3428
3429
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003430 // ---------------------------------------------------------------------
3431 // ---------------------------------------------------------------------
3432 // Standard intent categories (see addCategory()).
3433
3434 /**
3435 * Set if the activity should be an option for the default action
3436 * (center press) to perform on a piece of data. Setting this will
3437 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003438 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003439 * Intent when initiating an action -- it is for use in intent filters
3440 * specified in packages.
3441 */
3442 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3443 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3444 /**
3445 * Activities that can be safely invoked from a browser must support this
3446 * category. For example, if the user is viewing a web page or an e-mail
3447 * and clicks on a link in the text, the Intent generated execute that
3448 * link will require the BROWSABLE category, so that only activities
3449 * supporting this category will be considered as possible actions. By
3450 * supporting this category, you are promising that there is nothing
3451 * damaging (without user intervention) that can happen by invoking any
3452 * matching Intent.
3453 */
3454 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3455 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3456 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003457 * Categories for activities that can participate in voice interaction.
3458 * An activity that supports this category must be prepared to run with
3459 * no UI shown at all (though in some case it may have a UI shown), and
3460 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3461 */
3462 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3463 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3464 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003465 * Set if the activity should be considered as an alternative action to
3466 * the data the user is currently viewing. See also
3467 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3468 * applies to the selection in a list of items.
3469 *
3470 * <p>Supporting this category means that you would like your activity to be
3471 * displayed in the set of alternative things the user can do, usually as
3472 * part of the current activity's options menu. You will usually want to
3473 * include a specific label in the &lt;intent-filter&gt; of this action
3474 * describing to the user what it does.
3475 *
3476 * <p>The action of IntentFilter with this category is important in that it
3477 * describes the specific action the target will perform. This generally
3478 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3479 * a specific name such as "com.android.camera.action.CROP. Only one
3480 * alternative of any particular action will be shown to the user, so using
3481 * a specific action like this makes sure that your alternative will be
3482 * displayed while also allowing other applications to provide their own
3483 * overrides of that particular action.
3484 */
3485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3486 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3487 /**
3488 * Set if the activity should be considered as an alternative selection
3489 * action to the data the user has currently selected. This is like
3490 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3491 * of items from which the user can select, giving them alternatives to the
3492 * default action that will be performed on it.
3493 */
3494 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3495 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3496 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003497 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003498 */
3499 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3500 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3501 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003502 * Should be displayed in the top-level launcher.
3503 */
3504 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3505 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3506 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003507 * Indicates an activity optimized for Leanback mode, and that should
3508 * be displayed in the Leanback launcher.
3509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3512 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003513 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3514 * @hide
3515 */
3516 @SystemApi
3517 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3518 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003519 * Provides information about the package it is in; typically used if
3520 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3521 * a front-door to the user without having to be shown in the all apps list.
3522 */
3523 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3524 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3525 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003526 * This is the home activity, that is the first activity that is displayed
3527 * when the device boots.
3528 */
3529 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3530 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3531 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003532 * This is the home activity that is displayed when the device is finished setting up and ready
3533 * for use.
3534 * @hide
3535 */
3536 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3537 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3538 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003539 * This is the setup wizard activity, that is the first activity that is displayed
3540 * when the user sets up the device for the first time.
3541 * @hide
3542 */
3543 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3544 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3545 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003546 * This activity is a preference panel.
3547 */
3548 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3549 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3550 /**
3551 * This activity is a development preference panel.
3552 */
3553 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3554 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3555 /**
3556 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003557 */
3558 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3559 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3560 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003561 * This activity allows the user to browse and download new applications.
3562 */
3563 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3564 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3565 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003566 * This activity may be exercised by the monkey or other automated test tools.
3567 */
3568 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3569 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3570 /**
3571 * To be used as a test (not part of the normal user experience).
3572 */
3573 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3574 /**
3575 * To be used as a unit test (run through the Test Harness).
3576 */
3577 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3578 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003579 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003580 * experience).
3581 */
3582 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003583
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003584 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003585 * Used to indicate that an intent only wants URIs that can be opened with
3586 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3587 * must support at least the columns defined in {@link OpenableColumns} when
3588 * queried.
3589 *
3590 * @see #ACTION_GET_CONTENT
3591 * @see #ACTION_OPEN_DOCUMENT
3592 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003593 */
3594 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3595 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3596
3597 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003598 * Used to indicate that an intent filter can accept files which are not necessarily
3599 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3600 * at least streamable via
3601 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3602 * using one of the stream types exposed via
3603 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3604 *
3605 * @see #ACTION_SEND
3606 * @see #ACTION_SEND_MULTIPLE
3607 */
3608 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3609 public static final String CATEGORY_TYPED_OPENABLE =
3610 "android.intent.category.TYPED_OPENABLE";
3611
3612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 * To be used as code under test for framework instrumentation tests.
3614 */
3615 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3616 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003617 /**
3618 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003619 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3620 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003621 */
3622 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3623 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3624 /**
3625 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003626 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3627 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003628 */
3629 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3630 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003631 /**
3632 * An activity to run when device is inserted into a analog (low end) dock.
3633 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3634 * information, see {@link android.app.UiModeManager}.
3635 */
3636 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3637 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3638
3639 /**
3640 * An activity to run when device is inserted into a digital (high end) dock.
3641 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3642 * information, see {@link android.app.UiModeManager}.
3643 */
3644 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3645 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003646
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003647 /**
3648 * Used to indicate that the activity can be used in a car environment.
3649 */
3650 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3651 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003653 // ---------------------------------------------------------------------
3654 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003655 // Application launch intent categories (see addCategory()).
3656
3657 /**
3658 * Used with {@link #ACTION_MAIN} to launch the browser application.
3659 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003660 * <p>NOTE: This should not be used as the primary key of an Intent,
3661 * since it will not result in the app launching with the correct
3662 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003663 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003664 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003665 */
3666 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3667 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3668
3669 /**
3670 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3671 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003672 * <p>NOTE: This should not be used as the primary key of an Intent,
3673 * since it will not result in the app launching with the correct
3674 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003675 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003676 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003677 */
3678 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3679 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3680
3681 /**
3682 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3683 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003684 * <p>NOTE: This should not be used as the primary key of an Intent,
3685 * since it will not result in the app launching with the correct
3686 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003687 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003688 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003689 */
3690 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3691 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3692
3693 /**
3694 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3695 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003696 * <p>NOTE: This should not be used as the primary key of an Intent,
3697 * since it will not result in the app launching with the correct
3698 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003699 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003700 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003701 */
3702 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3703 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3704
3705 /**
3706 * Used with {@link #ACTION_MAIN} to launch the email application.
3707 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003708 * <p>NOTE: This should not be used as the primary key of an Intent,
3709 * since it will not result in the app launching with the correct
3710 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003711 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003712 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003713 */
3714 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3715 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3716
3717 /**
3718 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3719 * The activity should be able to view and manipulate image and video files
3720 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003721 * <p>NOTE: This should not be used as the primary key of an Intent,
3722 * since it will not result in the app launching with the correct
3723 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003724 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003725 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003726 */
3727 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3728 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3729
3730 /**
3731 * Used with {@link #ACTION_MAIN} to launch the maps application.
3732 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003733 * <p>NOTE: This should not be used as the primary key of an Intent,
3734 * since it will not result in the app launching with the correct
3735 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003736 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003737 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003738 */
3739 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3740 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3741
3742 /**
3743 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3744 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003745 * <p>NOTE: This should not be used as the primary key of an Intent,
3746 * since it will not result in the app launching with the correct
3747 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003748 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003749 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003750 */
3751 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3752 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3753
3754 /**
3755 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003756 * The activity should be able to play, browse, or manipulate music files
3757 * stored on the device.
3758 * <p>NOTE: This should not be used as the primary key of an Intent,
3759 * since it will not result in the app launching with the correct
3760 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003761 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003762 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003763 */
3764 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3765 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3766
3767 // ---------------------------------------------------------------------
3768 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003769 // Standard extra data keys.
3770
3771 /**
3772 * The initial data to place in a newly created record. Use with
3773 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3774 * fields as would be given to the underlying ContentProvider.insert()
3775 * call.
3776 */
3777 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3778
3779 /**
3780 * A constant CharSequence that is associated with the Intent, used with
3781 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3782 * this may be a styled CharSequence, so you must use
3783 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3784 * retrieve it.
3785 */
3786 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3787
3788 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003789 * A constant String that is associated with the Intent, used with
3790 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3791 * as HTML formatted text. Note that you <em>must</em> also supply
3792 * {@link #EXTRA_TEXT}.
3793 */
3794 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3795
3796 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003797 * A content: URI holding a stream of data associated with the Intent,
3798 * used with {@link #ACTION_SEND} to supply the data being sent.
3799 */
3800 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3801
3802 /**
3803 * A String[] holding e-mail addresses that should be delivered to.
3804 */
3805 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3806
3807 /**
3808 * A String[] holding e-mail addresses that should be carbon copied.
3809 */
3810 public static final String EXTRA_CC = "android.intent.extra.CC";
3811
3812 /**
3813 * A String[] holding e-mail addresses that should be blind carbon copied.
3814 */
3815 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3816
3817 /**
3818 * A constant string holding the desired subject line of a message.
3819 */
3820 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3821
3822 /**
3823 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003824 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 */
3826 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3827
3828 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003829 * An int representing the user id to be used.
3830 *
3831 * @hide
3832 */
3833 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3834
3835 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003836 * An int representing the task id to be retrieved. This is used when a launch from recents is
3837 * intercepted by another action such as credentials confirmation to remember which task should
3838 * be resumed when complete.
3839 *
3840 * @hide
3841 */
3842 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3843
3844 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003845 * An Intent[] describing additional, alternate choices you would like shown with
3846 * {@link #ACTION_CHOOSER}.
3847 *
3848 * <p>An app may be capable of providing several different payload types to complete a
3849 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3850 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3851 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3852 * photo data or a hosted link where the photos can be viewed.</p>
3853 *
3854 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3855 * first/primary/preferred intent in the set. Additional intents specified in
3856 * this extra are ordered; by default intents that appear earlier in the array will be
3857 * preferred over intents that appear later in the array as matches for the same
3858 * target component. To alter this preference, a calling app may also supply
3859 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3860 */
3861 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3862
3863 /**
Adam Powell52c39212016-04-07 15:14:18 -07003864 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3865 * and omitted from a list of components presented to the user.
3866 *
3867 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3868 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3869 * from your own package or other apps from your organization if the idea of sending to those
3870 * targets would be redundant with other app functionality. Filtered components will not
3871 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3872 */
3873 public static final String EXTRA_EXCLUDE_COMPONENTS
3874 = "android.intent.extra.EXCLUDE_COMPONENTS";
3875
3876 /**
3877 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3878 * describing additional high-priority deep-link targets for the chooser to present to the user.
3879 *
3880 * <p>Targets provided in this way will be presented inline with all other targets provided
3881 * by services from other apps. They will be prioritized before other service targets, but
3882 * after those targets provided by sources that the user has manually pinned to the front.</p>
3883 *
3884 * @see #ACTION_CHOOSER
3885 */
3886 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3887
3888 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003889 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3890 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3891 *
3892 * <p>An app preparing an action for another app to complete may wish to allow the user to
3893 * disambiguate between several options for completing the action based on the chosen target
3894 * or otherwise refine the action before it is invoked.
3895 * </p>
3896 *
3897 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3898 * <ul>
3899 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3900 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3901 * chosen target beyond the first</li>
3902 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3903 * should fill in and send once the disambiguation is complete</li>
3904 * </ul>
3905 */
3906 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3907 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3908
3909 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08003910 * An {@code ArrayList} of {@code String} annotations describing content for
3911 * {@link #ACTION_CHOOSER}.
3912 *
3913 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
3914 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
3915 *
3916 * <p>Annotations should describe the major components or topics of the content. It is up to
3917 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
3918 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
3919 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
3920 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
3921 * use the following annotations when applicable:</p>
3922 * <ul>
3923 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
3924 * health & beauty, and office supplies.</li>
3925 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
3926 * happy, and sad.</li>
3927 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
3928 * face, finger, standing, and walking.</li>
3929 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
3930 * child, and baby.</li>
3931 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
3932 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
3933 * <li>"party": represents that the topic of the content is mainly about parties.</li>
3934 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
3935 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
3936 * flowers.</li>
3937 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
3938 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
3939 * sunglasses, jewelry, handbags and clothing.</li>
3940 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
3941 * paper, and silk.</li>
3942 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
3943 * cars, and boats.</li>
3944 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
3945 * posters.</li>
3946 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
3947 * and designs of houses.</li>
3948 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
3949 * Christmas and Thanksgiving.</li>
3950 * </ul>
3951 */
3952 public static final String EXTRA_CONTENT_ANNOTATIONS
3953 = "android.intent.extra.CONTENT_ANNOTATIONS";
3954
3955 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003956 * A {@link ResultReceiver} used to return data back to the sender.
3957 *
3958 * <p>Used to complete an app-specific
3959 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3960 *
3961 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3962 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3963 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3964 * when the user selects a target component from the chooser. It is up to the recipient
3965 * to send a result to this ResultReceiver to signal that disambiguation is complete
3966 * and that the chooser should invoke the user's choice.</p>
3967 *
3968 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3969 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3970 * to match and fill in the final Intent or ChooserTarget before starting it.
3971 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3972 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3973 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3974 *
3975 * <p>The result code passed to the ResultReceiver should be
3976 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3977 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3978 * the chooser should finish without starting a target.</p>
3979 */
3980 public static final String EXTRA_RESULT_RECEIVER
3981 = "android.intent.extra.RESULT_RECEIVER";
3982
3983 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003984 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003985 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003986 */
3987 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3988
3989 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003990 * A Parcelable[] of {@link Intent} or
3991 * {@link android.content.pm.LabeledIntent} objects as set with
3992 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3993 * a the front of the list of choices, when shown to the user with a
3994 * {@link #ACTION_CHOOSER}.
3995 */
3996 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3997
3998 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003999 * A {@link IntentSender} to start after ephemeral installation success.
4000 * @hide
4001 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004002 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4003
4004 /**
4005 * A {@link IntentSender} to start after ephemeral installation failure.
4006 * @hide
4007 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004008 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4009
4010 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004011 * The host name that triggered an ephemeral resolution.
4012 * @hide
4013 */
4014 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4015
4016 /**
4017 * An opaque token to track ephemeral resolution.
4018 * @hide
4019 */
4020 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4021
4022 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004023 * The version code of the app to install components from.
4024 * @hide
4025 */
4026 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4027
4028 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004029 * A Bundle forming a mapping of potential target package names to different extras Bundles
4030 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4031 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4032 * be currently installed on the device.
4033 *
4034 * <p>An application may choose to provide alternate extras for the case where a user
4035 * selects an activity from a predetermined set of target packages. If the activity
4036 * the user selects from the chooser belongs to a package with its package name as
4037 * a key in this bundle, the corresponding extras for that package will be merged with
4038 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4039 * extra has the same key as an extra already present in the intent it will overwrite
4040 * the extra from the intent.</p>
4041 *
4042 * <p><em>Examples:</em>
4043 * <ul>
4044 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4045 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4046 * parameters for that target.</li>
4047 * <li>An application may offer additional metadata for known targets of a given intent
4048 * to pass along information only relevant to that target such as account or content
4049 * identifiers already known to that application.</li>
4050 * </ul></p>
4051 */
4052 public static final String EXTRA_REPLACEMENT_EXTRAS =
4053 "android.intent.extra.REPLACEMENT_EXTRAS";
4054
4055 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004056 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4057 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4058 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4059 * {@link ComponentName} of the chosen component.
4060 *
4061 * <p>In some situations this callback may never come, for example if the user abandons
4062 * the chooser, switches to another task or any number of other reasons. Apps should not
4063 * be written assuming that this callback will always occur.</p>
4064 */
4065 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4066 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4067
4068 /**
4069 * The {@link ComponentName} chosen by the user to complete an action.
4070 *
4071 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4072 */
4073 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4074
4075 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004076 * A {@link android.view.KeyEvent} object containing the event that
4077 * triggered the creation of the Intent it is in.
4078 */
4079 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4080
4081 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004082 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4083 * before shutting down.
4084 *
4085 * {@hide}
4086 */
4087 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4088
4089 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004090 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4091 * requested by the user.
4092 *
4093 * {@hide}
4094 */
4095 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4096 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4097
4098 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004099 * 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 -07004100 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4101 * of restarting the application.
4102 */
4103 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4104
4105 /**
4106 * A String holding the phone number originally entered in
4107 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4108 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4109 */
4110 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004111
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004112 /**
4113 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4114 * intents to supply the uid the package had been assigned. Also an optional
4115 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4116 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4117 * purpose.
4118 */
4119 public static final String EXTRA_UID = "android.intent.extra.UID";
4120
4121 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004122 * @hide String array of package names.
4123 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004124 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004125 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4126
4127 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004128 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4129 * intents to indicate whether this represents a full uninstall (removing
4130 * both the code and its data) or a partial uninstall (leaving its data,
4131 * implying that this is an update).
4132 */
4133 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004134
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004135 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004136 * @hide
4137 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4138 * intents to indicate that at this point the package has been removed for
4139 * all users on the device.
4140 */
4141 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4142 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4143
4144 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004145 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4146 * intents to indicate that this is a replacement of the package, so this
4147 * broadcast will immediately be followed by an add broadcast for a
4148 * different version of the same package.
4149 */
4150 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004151
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004152 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004153 * Used as an int extra field in {@link android.app.AlarmManager} intents
4154 * to tell the application being invoked how many pending alarms are being
4155 * delievered with the intent. For one-shot alarms this will always be 1.
4156 * For recurring alarms, this might be greater than 1 if the device was
4157 * asleep or powered off at the time an earlier alarm would have been
4158 * delivered.
4159 */
4160 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004161
Jacek Surazski86b6c532009-05-13 14:38:28 +02004162 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004163 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4164 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004165 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4166 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004167 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4168 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4169 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004170 */
4171 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4172
4173 /**
4174 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4175 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004176 */
4177 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4178
4179 /**
4180 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4181 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004182 */
4183 public static final int EXTRA_DOCK_STATE_DESK = 1;
4184
4185 /**
4186 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4187 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004188 */
4189 public static final int EXTRA_DOCK_STATE_CAR = 2;
4190
4191 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004192 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4193 * to represent that the phone is in a analog (low end) dock.
4194 */
4195 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4196
4197 /**
4198 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4199 * to represent that the phone is in a digital (high end) dock.
4200 */
4201 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4202
4203 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004204 * Boolean that can be supplied as meta-data with a dock activity, to
4205 * indicate that the dock should take over the home key when it is active.
4206 */
4207 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004208
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004209 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004210 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4211 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004212 */
4213 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4214
4215 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004216 * Used in the extra field in the remote intent. It's astring token passed with the
4217 * remote intent.
4218 */
4219 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4220 "android.intent.extra.remote_intent_token";
4221
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004222 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004223 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004224 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004225 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004226 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004227 "android.intent.extra.changed_component_name";
4228
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004229 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004230 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004231 * and contains a string array of all of the components that have changed. If
4232 * the state of the overall package has changed, then it will contain an entry
4233 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004234 */
4235 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4236 "android.intent.extra.changed_component_name_list";
4237
4238 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004239 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004240 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004241 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4242 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4243 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004244 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004245 */
4246 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4247 "android.intent.extra.changed_package_list";
4248
4249 /**
4250 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004251 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4252 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004253 * and contains an integer array of uids of all of the components
4254 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004255 */
4256 public static final String EXTRA_CHANGED_UID_LIST =
4257 "android.intent.extra.changed_uid_list";
4258
4259 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004260 * @hide
4261 * Magic extra system code can use when binding, to give a label for
4262 * who it is that has bound to a service. This is an integer giving
4263 * a framework string resource that can be displayed to the user.
4264 */
4265 public static final String EXTRA_CLIENT_LABEL =
4266 "android.intent.extra.client_label";
4267
4268 /**
4269 * @hide
4270 * Magic extra system code can use when binding, to give a PendingIntent object
4271 * that can be launched for the user to disable the system's use of this
4272 * service.
4273 */
4274 public static final String EXTRA_CLIENT_INTENT =
4275 "android.intent.extra.client_intent";
4276
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004277 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004278 * Extra used to indicate that an intent should only return data that is on
4279 * the local device. This is a boolean extra; the default is false. If true,
4280 * an implementation should only allow the user to select data that is
4281 * already on the device, not requiring it be downloaded from a remote
4282 * service when opened.
4283 *
4284 * @see #ACTION_GET_CONTENT
4285 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004286 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004287 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004288 */
4289 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004290 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004291
Amith Yamasani13593602012-03-22 16:16:17 -07004292 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004293 * Extra used to indicate that an intent can allow the user to select and
4294 * return multiple items. This is a boolean extra; the default is false. If
4295 * true, an implementation is allowed to present the user with a UI where
4296 * they can pick multiple items that are all returned to the caller. When
4297 * this happens, they should be returned as the {@link #getClipData()} part
4298 * of the result Intent.
4299 *
4300 * @see #ACTION_GET_CONTENT
4301 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004302 */
4303 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004304 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004305
4306 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004307 * The integer userHandle carried with broadcast intents related to addition, removal and
4308 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4309 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4310 *
Amith Yamasani13593602012-03-22 16:16:17 -07004311 * @hide
4312 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004313 public static final String EXTRA_USER_HANDLE =
4314 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004315
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004316 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004317 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4318 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4319 */
4320 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004321 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004322
4323 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004324 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004325 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4326 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004327 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004328 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4329
4330 /**
4331 * Extra sent in the intent to the BroadcastReceiver that handles
4332 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4333 * the restrictions as key/value pairs.
4334 */
4335 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4336 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004337
Amith Yamasani86118ba2013-03-28 14:33:16 -07004338 /**
4339 * Extra used in the response from a BroadcastReceiver that handles
4340 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4341 */
4342 public static final String EXTRA_RESTRICTIONS_INTENT =
4343 "android.intent.extra.restrictions_intent";
4344
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004345 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004346 * Extra used to communicate a set of acceptable MIME types. The type of the
4347 * extra is {@code String[]}. Values may be a combination of concrete MIME
4348 * types (such as "image/png") and/or partial MIME types (such as
4349 * "audio/*").
4350 *
4351 * @see #ACTION_GET_CONTENT
4352 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004353 */
4354 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4355
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004356 /**
4357 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4358 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004359 * When this is true, hardware devices can use this information to determine that
4360 * they shouldn't do a complete shutdown of their device since this is not a
4361 * complete shutdown down to the kernel, but only user space restarting.
4362 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004363 */
4364 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4365 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4366
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004367 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004368 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4369 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4370 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4371 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004372 *
4373 * @hide for internal use only.
4374 */
4375 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4376 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004377 /** @hide */
4378 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4379 /** @hide */
4380 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4381 /** @hide */
4382 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004383
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004384 /** {@hide} */
4385 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4386
Rubin Xue8490f12015-06-25 12:17:48 +01004387 /** {@hide} */
4388 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4389
Santos Cordon15a13782015-03-31 18:32:31 -07004390 /**
4391 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4392 * activation request.
4393 * TODO: Add information about the structure and response data used with the pending intent.
4394 * @hide
4395 */
4396 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4397 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4398
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004399 /**
4400 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004401 *
4402 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004403 * @see ACTION_QUICK_VIEW
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004404 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004405 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4406
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004407 /**
Tomasz Mikolajewski867addf2017-02-01 14:16:39 +09004408 * Shows a plain quick viewer UI which doesn't provide any extra features other than
4409 * quick viewing the items.
4410 *
4411 * <p>Especially, the quick viewer should not let users open the quick viewed files
4412 * in other apps, which includes sharing, opening, editing, printing, etc.
4413 *
4414 * <p>This feature is optional, and may not be handled by all quick viewers.
4415 *
4416 * <p>The value is boolean. By default false.
4417 * @see ACTION_QUICK_VIEW
4418 */
4419 public static final String EXTRA_QUICK_VIEW_PLAIN =
4420 "android.intent.extra.QUICK_VIEW_PLAIN";
4421
4422 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004423 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004424 * When a profile goes into quiet mode, all apps in the profile are killed and the
4425 * profile user is stopped. Widgets originating from the profile are masked, and app
4426 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004427 */
4428 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004429
4430 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004431 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004432 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004433 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4434 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004435 *
4436 * @hide
4437 */
4438 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4439 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4440
4441 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004442 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4443 * whether to show the chooser or not when there is only one application available
4444 * to choose from.
4445 *
4446 * @hide
4447 */
4448 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4449 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4450
4451 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004452 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004453 * to represent that a video codec is allowed to use.
4454 *
4455 * @hide
4456 */
4457 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4458
4459 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004460 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004461 * to represent that a audio codec is allowed to use.
4462 *
4463 * @hide
4464 */
4465 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4466
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004467 // ---------------------------------------------------------------------
4468 // ---------------------------------------------------------------------
4469 // Intent flags (see mFlags variable).
4470
Tor Norbyed9273d62013-05-30 15:59:53 -07004471 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004472 @IntDef(flag = true, value = {
4473 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4474 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004475 @Retention(RetentionPolicy.SOURCE)
4476 public @interface GrantUriMode {}
4477
Jeff Sharkey846318a2014-04-04 12:12:41 -07004478 /** @hide */
4479 @IntDef(flag = true, value = {
4480 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4481 @Retention(RetentionPolicy.SOURCE)
4482 public @interface AccessUriMode {}
4483
4484 /**
4485 * Test if given mode flags specify an access mode, which must be at least
4486 * read and/or write.
4487 *
4488 * @hide
4489 */
4490 public static boolean isAccessUriMode(int modeFlags) {
4491 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4492 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4493 }
4494
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004495 /**
4496 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004497 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004498 * specified in its ClipData. When applying to an Intent's ClipData,
4499 * all URIs as well as recursive traversals through data or other ClipData
4500 * in Intent items will be granted; only the grant flags of the top-level
4501 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004502 */
4503 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4504 /**
4505 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004506 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004507 * specified in its ClipData. When applying to an Intent's ClipData,
4508 * all URIs as well as recursive traversals through data or other ClipData
4509 * in Intent items will be granted; only the grant flags of the top-level
4510 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004511 */
4512 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4513 /**
4514 * Can be set by the caller to indicate that this Intent is coming from
4515 * a background operation, not from direct user interaction.
4516 */
4517 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4518 /**
4519 * A flag you can enable for debugging: when set, log messages will be
4520 * printed during the resolution of this intent to show you what has
4521 * been found to create the final resolved list.
4522 */
4523 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004524 /**
4525 * If set, this intent will not match any components in packages that
4526 * are currently stopped. If this is not set, then the default behavior
4527 * is to include such applications in the result.
4528 */
4529 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4530 /**
4531 * If set, this intent will always match any components in packages that
4532 * are currently stopped. This is the default behavior when
4533 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4534 * flags are set, this one wins (it allows overriding of exclude for
4535 * places where the framework may automatically set the exclude flag).
4536 */
4537 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004538
4539 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004540 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004541 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004542 * persisted across device reboots until explicitly revoked with
4543 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4544 * grant for possible persisting; the receiving application must call
4545 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4546 * actually persist.
4547 *
4548 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4549 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4550 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004551 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004552 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004553 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004554
4555 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004556 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4557 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4558 * applies to any URI that is a prefix match against the original granted
4559 * URI. (Without this flag, the URI must match exactly for access to be
4560 * granted.) Another URI is considered a prefix match only when scheme,
4561 * authority, and all path segments defined by the prefix are an exact
4562 * match.
4563 */
4564 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4565
4566 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004567 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004568 * homework and verified that they correctly handle packages and components
4569 * that come and go over time. In particular:
4570 * <ul>
4571 * <li>Apps installed on external storage, which will appear to be
4572 * uninstalled while the the device is ejected.
4573 * <li>Apps with encryption unaware components, which will appear to not
4574 * exist while the device is locked.
4575 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004576 *
4577 * @hide
4578 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004579 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004580
4581 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004582 * Internal flag used to indicate ephemeral applications should not be
4583 * considered when resolving the intent.
4584 *
4585 * @hide
4586 */
4587 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4588
4589 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004590 * If set, the new activity is not kept in the history stack. As soon as
4591 * the user navigates away from it, the activity is finished. This may also
4592 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4593 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004594 *
4595 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4596 * is never invoked when the current activity starts a new activity which
4597 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004598 */
4599 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4600 /**
4601 * If set, the activity will not be launched if it is already running
4602 * at the top of the history stack.
4603 */
4604 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4605 /**
4606 * If set, this activity will become the start of a new task on this
4607 * history stack. A task (from the activity that started it to the
4608 * next task activity) defines an atomic group of activities that the
4609 * user can move to. Tasks can be moved to the foreground and background;
4610 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004611 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004612 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4613 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004614 *
4615 * <p>This flag is generally used by activities that want
4616 * to present a "launcher" style behavior: they give the user a list of
4617 * separate things that can be done, which otherwise run completely
4618 * independently of the activity launching them.
4619 *
4620 * <p>When using this flag, if a task is already running for the activity
4621 * you are now starting, then a new activity will not be started; instead,
4622 * the current task will simply be brought to the front of the screen with
4623 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4624 * to disable this behavior.
4625 *
4626 * <p>This flag can not be used when the caller is requesting a result from
4627 * the activity being launched.
4628 */
4629 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4630 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004631 * This flag is used to create a new task and launch an activity into it.
4632 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4633 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4634 * search through existing tasks for ones matching this Intent. Only if no such
4635 * task is found would a new task be created. When paired with
4636 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4637 * the search for a matching task and unconditionally start a new task.
4638 *
4639 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4640 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004641 * top-level application launcher.</strong> Used in conjunction with
4642 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4643 * behavior of bringing an existing task to the foreground. When set,
4644 * a new task is <em>always</em> started to host the Activity for the
4645 * Intent, regardless of whether there is already an existing task running
4646 * the same thing.
4647 *
4648 * <p><strong>Because the default system does not include graphical task management,
4649 * you should not use this flag unless you provide some way for a user to
4650 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004651 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004652 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4653 * creating new document tasks.
4654 *
4655 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004656 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657 *
Scott Main7aee61f2011-02-08 11:25:01 -08004658 * <p>See
4659 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4660 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004661 *
4662 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4663 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004664 */
4665 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4666 /**
4667 * If set, and the activity being launched is already running in the
4668 * current task, then instead of launching a new instance of that activity,
4669 * all of the other activities on top of it will be closed and this Intent
4670 * will be delivered to the (now on top) old activity as a new Intent.
4671 *
4672 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4673 * If D calls startActivity() with an Intent that resolves to the component
4674 * of activity B, then C and D will be finished and B receive the given
4675 * Intent, resulting in the stack now being: A, B.
4676 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004677 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004678 * either receive the new intent you are starting here in its
4679 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004680 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004681 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4682 * the same intent, then it will be finished and re-created; for all other
4683 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4684 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004685 *
4686 * <p>This launch mode can also be used to good effect in conjunction with
4687 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4688 * of a task, it will bring any currently running instance of that task
4689 * to the foreground, and then clear it to its root state. This is
4690 * especially useful, for example, when launching an activity from the
4691 * notification manager.
4692 *
Scott Main7aee61f2011-02-08 11:25:01 -08004693 * <p>See
4694 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4695 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004696 */
4697 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4698 /**
4699 * If set and this intent is being used to launch a new activity from an
4700 * existing one, then the reply target of the existing activity will be
4701 * transfered to the new activity. This way the new activity can call
4702 * {@link android.app.Activity#setResult} and have that result sent back to
4703 * the reply target of the original activity.
4704 */
4705 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4706 /**
4707 * If set and this intent is being used to launch a new activity from an
4708 * existing one, the current activity will not be counted as the top
4709 * activity for deciding whether the new intent should be delivered to
4710 * the top instead of starting a new one. The previous activity will
4711 * be used as the top, with the assumption being that the current activity
4712 * will finish itself immediately.
4713 */
4714 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4715 /**
4716 * If set, the new activity is not kept in the list of recently launched
4717 * activities.
4718 */
4719 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4720 /**
4721 * This flag is not normally set by application code, but set for you by
4722 * the system as described in the
4723 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4724 * launchMode} documentation for the singleTask mode.
4725 */
4726 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4727 /**
4728 * If set, and this activity is either being started in a new task or
4729 * bringing to the top an existing task, then it will be launched as
4730 * the front door of the task. This will result in the application of
4731 * any affinities needed to have that task in the proper state (either
4732 * moving activities to or from it), or simply resetting that task to
4733 * its initial state if needed.
4734 */
4735 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4736 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004737 * This flag is not normally set by application code, but set for you by
4738 * the system if this activity is being launched from history
4739 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004740 */
4741 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004742 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004743 * @deprecated As of API 21 this performs identically to
4744 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004745 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004746 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004747 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004748 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004749 * This flag is used to open a document into a new task rooted at the activity launched
4750 * by this Intent. Through the use of this flag, or its equivalent attribute,
4751 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004752 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004753 *
Craig Mautner026596b2014-05-21 15:35:44 -07004754 * <p>The use of the activity attribute form of this,
4755 * {@link android.R.attr#documentLaunchMode}, is
4756 * preferred over the Intent flag described here. The attribute form allows the
4757 * Activity to specify multiple document behavior for all launchers of the Activity
4758 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004759 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004760 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4761 * it is kept after the activity is finished is different than the use of
4762 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4763 * this flag is being used to create a new recents entry, then by default that entry
4764 * will be removed once the activity is finished. You can modify this behavior with
4765 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4766 *
Craig Mautner026596b2014-05-21 15:35:44 -07004767 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4768 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4769 * equivalent of the Activity manifest specifying {@link
4770 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4771 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4772 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004773 *
Craig Mautner026596b2014-05-21 15:35:44 -07004774 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004775 *
Craig Mautner026596b2014-05-21 15:35:44 -07004776 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004777 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4778 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004779 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004780 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004781 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004782 * callback from occurring on the current frontmost activity before it is
4783 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004784 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004785 * <p>Typically, an activity can rely on that callback to indicate that an
4786 * explicit user action has caused their activity to be moved out of the
4787 * foreground. The callback marks an appropriate point in the activity's
4788 * lifecycle for it to dismiss any notifications that it intends to display
4789 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004790 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004791 * <p>If an activity is ever started via any non-user-driven events such as
4792 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4793 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004794 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004795 */
4796 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004797 /**
4798 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4799 * this flag will cause the launched activity to be brought to the front of its
4800 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004801 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004802 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4803 * If D calls startActivity() with an Intent that resolves to the component
4804 * of activity B, then B will be brought to the front of the history stack,
4805 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004806 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004807 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004808 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004809 */
4810 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004811 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004812 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4813 * this flag will prevent the system from applying an activity transition
4814 * animation to go to the next activity state. This doesn't mean an
4815 * animation will never run -- if another activity change happens that doesn't
4816 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004817 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004818 * when you are going to do a series of activity operations but the
4819 * animation seen by the user shouldn't be driven by the first activity
4820 * change but rather a later one.
4821 */
4822 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4823 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004824 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4825 * this flag will cause any existing task that would be associated with the
4826 * activity to be cleared before the activity is started. That is, the activity
4827 * becomes the new root of an otherwise empty task, and any old activities
4828 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4829 */
4830 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4831 /**
4832 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4833 * this flag will cause a newly launching task to be placed on top of the current
4834 * home activity task (if there is one). That is, pressing back from the task
4835 * will always return the user to home even if that was not the last activity they
4836 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4837 */
4838 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4839 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004840 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4841 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004842 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004843 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004844 * this flag. When set and the task's activity is finished, the recents
4845 * entry will remain in the interface for the user to re-launch it, like a
4846 * recents entry for a top-level application.
4847 * <p>
4848 * The receiving activity can override this request with
4849 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4850 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004851 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004852 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004853 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004854
4855 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004856 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4857 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004858 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4859 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004860 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004861 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004862
4863 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004864 * If set, when sending a broadcast only registered receivers will be
4865 * called -- no BroadcastReceiver components will be launched.
4866 */
4867 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004868 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004869 * If set, when sending a broadcast the new broadcast will replace
4870 * any existing pending broadcast that matches it. Matching is defined
4871 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4872 * true for the intents of the two broadcasts. When a match is found,
4873 * the new broadcast (and receivers associated with it) will replace the
4874 * existing one in the pending broadcast list, remaining at the same
4875 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004876 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004877 * <p>This flag is most typically used with sticky broadcasts, which
4878 * only care about delivering the most recent values of the broadcast
4879 * to their receivers.
4880 */
4881 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4882 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004883 * If set, when sending a broadcast the recipient is allowed to run at
4884 * foreground priority, with a shorter timeout interval. During normal
4885 * broadcasts the receivers are not automatically hoisted out of the
4886 * background priority class.
4887 */
4888 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4889 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004890 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4891 * They can still propagate results through to later receivers, but they can not prevent
4892 * later receivers from seeing the broadcast.
4893 */
4894 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4895 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004896 * If set, when sending a broadcast <i>before boot has completed</i> only
4897 * registered receivers will be called -- no BroadcastReceiver components
4898 * will be launched. Sticky intent state will be recorded properly even
4899 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4900 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004901 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004902 * <p>This flag is only for use by system sevices as a convenience to
4903 * avoid having to implement a more complex mechanism around detection
4904 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004905 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004906 * @hide
4907 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004908 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004909 /**
4910 * Set when this broadcast is for a boot upgrade, a special mode that
4911 * allows the broadcast to be sent before the system is ready and launches
4912 * the app process with no providers running in it.
4913 * @hide
4914 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004915 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004916 /**
4917 * If set, the broadcast will always go to manifest receivers in background (cached
4918 * or not running) apps, regardless of whether that would be done by default. By
4919 * default they will only receive broadcasts if the broadcast has specified an
4920 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08004921 *
4922 * NOTE: dumpstate uses this flag numerically, so when its value is changed
4923 * the broadcast code there must also be changed to match.
4924 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004925 * @hide
4926 */
4927 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4928 /**
4929 * If set, the broadcast will never go to manifest receivers in background (cached
4930 * or not running) apps, regardless of whether that would be done by default. By
4931 * default they will receive broadcasts if the broadcast has specified an
4932 * explicit component or package name.
4933 * @hide
4934 */
4935 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07004936 /**
4937 * If set, this broadcast is being sent from the shell.
4938 * @hide
4939 */
4940 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004941
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004942 /**
4943 * @hide Flags that can't be changed with PendingIntent.
4944 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004945 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4946 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4947 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004948
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004949 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004950 // ---------------------------------------------------------------------
4951 // toUri() and parseUri() options.
4952
4953 /**
4954 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4955 * always has the "intent:" scheme. This syntax can be used when you want
4956 * to later disambiguate between URIs that are intended to describe an
4957 * Intent vs. all others that should be treated as raw URIs. When used
4958 * with {@link #parseUri}, any other scheme will result in a generic
4959 * VIEW action for that raw URI.
4960 */
4961 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004962
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004963 /**
4964 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4965 * always has the "android-app:" scheme. This is a variation of
4966 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4967 * http/https URI being delivered to a specific package name. The format
4968 * is:
4969 *
4970 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004971 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004972 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004973 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4974 * you must also include a scheme; including a path also requires both a host and a scheme.
4975 * The final #Intent; fragment can be used without a scheme, host, or path.
4976 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004977 * used with intents that have a {@link #setSelector}, since the base intent
4978 * will always have an explicit package name.</p>
4979 *
4980 * <p>Some examples of how this scheme maps to Intent objects:</p>
4981 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4982 * <colgroup align="left" />
4983 * <colgroup align="left" />
4984 * <thead>
4985 * <tr><th>URI</th> <th>Intent</th></tr>
4986 * </thead>
4987 *
4988 * <tbody>
4989 * <tr><td><code>android-app://com.example.app</code></td>
4990 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4991 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4992 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4993 * </table></td>
4994 * </tr>
4995 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4996 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4997 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4998 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4999 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5000 * </table></td>
5001 * </tr>
5002 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
5003 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5004 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
5005 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5006 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5007 * </table></td>
5008 * </tr>
5009 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5010 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5011 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5012 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5013 * </table></td>
5014 * </tr>
5015 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5016 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5017 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5018 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5019 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5020 * </table></td>
5021 * </tr>
5022 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;<br />i.some_int=100;S.some_str=hello;end</code></td>
5023 * <td><table border="" style="margin:0" >
5024 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5025 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5026 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5027 * </table></td>
5028 * </tr>
5029 * </tbody>
5030 * </table>
5031 */
5032 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5033
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005034 /**
5035 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5036 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5037 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5038 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5039 * generated Intent can not cause unexpected data access to happen.
5040 *
5041 * <p>If you do not trust the source of the URI being parsed, you should still do further
5042 * processing to protect yourself from it. In particular, when using it to start an
5043 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5044 * that can handle it.</p>
5045 */
5046 public static final int URI_ALLOW_UNSAFE = 1<<2;
5047
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005048 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005049
5050 private String mAction;
5051 private Uri mData;
5052 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005053 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005054 private ComponentName mComponent;
5055 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005056 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005057 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005058 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005059 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005060 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005061 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005062
5063 // ---------------------------------------------------------------------
5064
5065 /**
5066 * Create an empty intent.
5067 */
5068 public Intent() {
5069 }
5070
5071 /**
5072 * Copy constructor.
5073 */
5074 public Intent(Intent o) {
5075 this.mAction = o.mAction;
5076 this.mData = o.mData;
5077 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005078 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005079 this.mComponent = o.mComponent;
5080 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005081 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005082 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005083 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005084 }
5085 if (o.mExtras != null) {
5086 this.mExtras = new Bundle(o.mExtras);
5087 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005088 if (o.mSourceBounds != null) {
5089 this.mSourceBounds = new Rect(o.mSourceBounds);
5090 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005091 if (o.mSelector != null) {
5092 this.mSelector = new Intent(o.mSelector);
5093 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005094 if (o.mClipData != null) {
5095 this.mClipData = new ClipData(o.mClipData);
5096 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005097 }
5098
5099 @Override
5100 public Object clone() {
5101 return new Intent(this);
5102 }
5103
5104 private Intent(Intent o, boolean all) {
5105 this.mAction = o.mAction;
5106 this.mData = o.mData;
5107 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005108 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005109 this.mComponent = o.mComponent;
5110 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005111 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 }
5113 }
5114
5115 /**
5116 * Make a clone of only the parts of the Intent that are relevant for
5117 * filter matching: the action, data, type, component, and categories.
5118 */
5119 public Intent cloneFilter() {
5120 return new Intent(this, false);
5121 }
5122
5123 /**
5124 * Create an intent with a given action. All other fields (data, type,
5125 * class) are null. Note that the action <em>must</em> be in a
5126 * namespace because Intents are used globally in the system -- for
5127 * example the system VIEW action is android.intent.action.VIEW; an
5128 * application's custom action would be something like
5129 * com.google.app.myapp.CUSTOM_ACTION.
5130 *
5131 * @param action The Intent action, such as ACTION_VIEW.
5132 */
5133 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005134 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005135 }
5136
5137 /**
5138 * Create an intent with a given action and for a given data url. Note
5139 * that the action <em>must</em> be in a namespace because Intents are
5140 * used globally in the system -- for example the system VIEW action is
5141 * android.intent.action.VIEW; an application's custom action would be
5142 * something like com.google.app.myapp.CUSTOM_ACTION.
5143 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005144 * <p><em>Note: scheme and host name matching in the Android framework is
5145 * case-sensitive, unlike the formal RFC. As a result,
5146 * you should always ensure that you write your Uri with these elements
5147 * using lower case letters, and normalize any Uris you receive from
5148 * outside of Android to ensure the scheme and host is lower case.</em></p>
5149 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005150 * @param action The Intent action, such as ACTION_VIEW.
5151 * @param uri The Intent data URI.
5152 */
5153 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005154 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005155 mData = uri;
5156 }
5157
5158 /**
5159 * Create an intent for a specific component. All other fields (action, data,
5160 * type, class) are null, though they can be modified later with explicit
5161 * calls. This provides a convenient way to create an intent that is
5162 * intended to execute a hard-coded class name, rather than relying on the
5163 * system to find an appropriate class for you; see {@link #setComponent}
5164 * for more information on the repercussions of this.
5165 *
5166 * @param packageContext A Context of the application package implementing
5167 * this class.
5168 * @param cls The component class that is to be used for the intent.
5169 *
5170 * @see #setClass
5171 * @see #setComponent
5172 * @see #Intent(String, android.net.Uri , Context, Class)
5173 */
5174 public Intent(Context packageContext, Class<?> cls) {
5175 mComponent = new ComponentName(packageContext, cls);
5176 }
5177
5178 /**
5179 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005180 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005181 * construct the Intent and then calling {@link #setClass} to set its
5182 * class.
5183 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005184 * <p><em>Note: scheme and host name matching in the Android framework is
5185 * case-sensitive, unlike the formal RFC. As a result,
5186 * you should always ensure that you write your Uri with these elements
5187 * using lower case letters, and normalize any Uris you receive from
5188 * outside of Android to ensure the scheme and host is lower case.</em></p>
5189 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005190 * @param action The Intent action, such as ACTION_VIEW.
5191 * @param uri The Intent data URI.
5192 * @param packageContext A Context of the application package implementing
5193 * this class.
5194 * @param cls The component class that is to be used for the intent.
5195 *
5196 * @see #Intent(String, android.net.Uri)
5197 * @see #Intent(Context, Class)
5198 * @see #setClass
5199 * @see #setComponent
5200 */
5201 public Intent(String action, Uri uri,
5202 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005203 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005204 mData = uri;
5205 mComponent = new ComponentName(packageContext, cls);
5206 }
5207
5208 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005209 * Create an intent to launch the main (root) activity of a task. This
5210 * is the Intent that is started when the application's is launched from
5211 * Home. For anything else that wants to launch an application in the
5212 * same way, it is important that they use an Intent structured the same
5213 * way, and can use this function to ensure this is the case.
5214 *
5215 * <p>The returned Intent has the given Activity component as its explicit
5216 * component, {@link #ACTION_MAIN} as its action, and includes the
5217 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5218 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5219 * to do that through {@link #addFlags(int)} on the returned Intent.
5220 *
5221 * @param mainActivity The main activity component that this Intent will
5222 * launch.
5223 * @return Returns a newly created Intent that can be used to launch the
5224 * activity as a main application entry.
5225 *
5226 * @see #setClass
5227 * @see #setComponent
5228 */
5229 public static Intent makeMainActivity(ComponentName mainActivity) {
5230 Intent intent = new Intent(ACTION_MAIN);
5231 intent.setComponent(mainActivity);
5232 intent.addCategory(CATEGORY_LAUNCHER);
5233 return intent;
5234 }
5235
5236 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005237 * Make an Intent for the main activity of an application, without
5238 * specifying a specific activity to run but giving a selector to find
5239 * the activity. This results in a final Intent that is structured
5240 * the same as when the application is launched from
5241 * Home. For anything else that wants to launch an application in the
5242 * same way, it is important that they use an Intent structured the same
5243 * way, and can use this function to ensure this is the case.
5244 *
5245 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5246 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5247 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5248 * to do that through {@link #addFlags(int)} on the returned Intent.
5249 *
5250 * @param selectorAction The action name of the Intent's selector.
5251 * @param selectorCategory The name of a category to add to the Intent's
5252 * selector.
5253 * @return Returns a newly created Intent that can be used to launch the
5254 * activity as a main application entry.
5255 *
5256 * @see #setSelector(Intent)
5257 */
5258 public static Intent makeMainSelectorActivity(String selectorAction,
5259 String selectorCategory) {
5260 Intent intent = new Intent(ACTION_MAIN);
5261 intent.addCategory(CATEGORY_LAUNCHER);
5262 Intent selector = new Intent();
5263 selector.setAction(selectorAction);
5264 selector.addCategory(selectorCategory);
5265 intent.setSelector(selector);
5266 return intent;
5267 }
5268
5269 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005270 * Make an Intent that can be used to re-launch an application's task
5271 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5272 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5273 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5274 *
5275 * @param mainActivity The activity component that is the root of the
5276 * task; this is the activity that has been published in the application's
5277 * manifest as the main launcher icon.
5278 *
5279 * @return Returns a newly created Intent that can be used to relaunch the
5280 * activity's task in its root state.
5281 */
5282 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5283 Intent intent = makeMainActivity(mainActivity);
5284 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5285 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5286 return intent;
5287 }
5288
5289 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005290 * Call {@link #parseUri} with 0 flags.
5291 * @deprecated Use {@link #parseUri} instead.
5292 */
5293 @Deprecated
5294 public static Intent getIntent(String uri) throws URISyntaxException {
5295 return parseUri(uri, 0);
5296 }
Tom Taylord4a47292009-12-21 13:59:18 -08005297
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005298 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005299 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005300 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005301 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005302 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005303 *
5304 * <p>The URI given here must not be relative -- that is, it must include
5305 * the scheme and full path.
5306 *
5307 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005308 * @param flags Additional processing flags. Either 0,
5309 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005310 *
5311 * @return Intent The newly created Intent object.
5312 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005313 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5314 * it bad (as parsed by the Uri class) or the Intent data within the
5315 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005316 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005317 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005318 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005319 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005320 int i = 0;
5321 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005322 final boolean androidApp = uri.startsWith("android-app:");
5323
5324 // Validate intent scheme if requested.
5325 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5326 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005327 Intent intent = new Intent(ACTION_VIEW);
5328 try {
5329 intent.setData(Uri.parse(uri));
5330 } catch (IllegalArgumentException e) {
5331 throw new URISyntaxException(uri, e.getMessage());
5332 }
5333 return intent;
5334 }
5335 }
Tom Taylord4a47292009-12-21 13:59:18 -08005336
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005337 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005338 // simple case
5339 if (i == -1) {
5340 if (!androidApp) {
5341 return new Intent(ACTION_VIEW, Uri.parse(uri));
5342 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005343
5344 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005345 } else if (!uri.startsWith("#Intent;", i)) {
5346 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005347 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005348 } else {
5349 i = -1;
5350 }
5351 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005352
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005353 // new format
5354 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005355 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005356 boolean explicitAction = false;
5357 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005358
5359 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005360 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005361 String data;
5362 if (i >= 0) {
5363 data = uri.substring(0, i);
5364 i += 8; // length of "#Intent;"
5365 } else {
5366 data = uri;
5367 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005368
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005369 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005370 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005371 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005372 if (eq < 0) eq = i-1;
5373 int semi = uri.indexOf(';', i);
5374 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005375
5376 // action
5377 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005378 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005379 if (!inSelector) {
5380 explicitAction = true;
5381 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005382 }
5383
5384 // categories
5385 else if (uri.startsWith("category=", i)) {
5386 intent.addCategory(value);
5387 }
5388
5389 // type
5390 else if (uri.startsWith("type=", i)) {
5391 intent.mType = value;
5392 }
5393
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005394 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 else if (uri.startsWith("launchFlags=", i)) {
5396 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005397 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5398 intent.mFlags &= ~IMMUTABLE_FLAGS;
5399 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005400 }
5401
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005402 // package
5403 else if (uri.startsWith("package=", i)) {
5404 intent.mPackage = value;
5405 }
5406
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005407 // component
5408 else if (uri.startsWith("component=", i)) {
5409 intent.mComponent = ComponentName.unflattenFromString(value);
5410 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005411
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005412 // scheme
5413 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005414 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005415 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005416 } else {
5417 scheme = value;
5418 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005419 }
5420
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005421 // source bounds
5422 else if (uri.startsWith("sourceBounds=", i)) {
5423 intent.mSourceBounds = Rect.unflattenFromString(value);
5424 }
5425
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005426 // selector
5427 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5428 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005429 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005430 }
5431
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005432 // extra
5433 else {
5434 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005435 // create Bundle if it doesn't already exist
5436 if (intent.mExtras == null) intent.mExtras = new Bundle();
5437 Bundle b = intent.mExtras;
5438 // add EXTRA
5439 if (uri.startsWith("S.", i)) b.putString(key, value);
5440 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5441 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5442 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5443 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5444 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5445 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5446 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5447 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5448 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5449 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005450
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005451 // move to the next item
5452 i = semi + 1;
5453 }
5454
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005455 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005456 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005457 if (baseIntent.mPackage == null) {
5458 baseIntent.setSelector(intent);
5459 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005460 intent = baseIntent;
5461 }
5462
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005463 if (data != null) {
5464 if (data.startsWith("intent:")) {
5465 data = data.substring(7);
5466 if (scheme != null) {
5467 data = scheme + ':' + data;
5468 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005469 } else if (data.startsWith("android-app:")) {
5470 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5471 // Correctly formed android-app, first part is package name.
5472 int end = data.indexOf('/', 14);
5473 if (end < 0) {
5474 // All we have is a package name.
5475 intent.mPackage = data.substring(14);
5476 if (!explicitAction) {
5477 intent.setAction(ACTION_MAIN);
5478 }
5479 data = "";
5480 } else {
5481 // Target the Intent at the given package name always.
5482 String authority = null;
5483 intent.mPackage = data.substring(14, end);
5484 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005485 if ((end+1) < data.length()) {
5486 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5487 // Found a scheme, remember it.
5488 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005489 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005490 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5491 // Found a authority, remember it.
5492 authority = data.substring(end+1, newEnd);
5493 end = newEnd;
5494 }
5495 } else {
5496 // All we have is a scheme.
5497 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005498 }
5499 }
5500 if (scheme == null) {
5501 // If there was no scheme, then this just targets the package.
5502 if (!explicitAction) {
5503 intent.setAction(ACTION_MAIN);
5504 }
5505 data = "";
5506 } else if (authority == null) {
5507 data = scheme + ":";
5508 } else {
5509 data = scheme + "://" + authority + data.substring(end);
5510 }
5511 }
5512 } else {
5513 data = "";
5514 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005515 }
Tom Taylord4a47292009-12-21 13:59:18 -08005516
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005517 if (data.length() > 0) {
5518 try {
5519 intent.mData = Uri.parse(data);
5520 } catch (IllegalArgumentException e) {
5521 throw new URISyntaxException(uri, e.getMessage());
5522 }
5523 }
5524 }
Tom Taylord4a47292009-12-21 13:59:18 -08005525
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005526 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005527
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005528 } catch (IndexOutOfBoundsException e) {
5529 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5530 }
5531 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005532
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005533 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005534 return getIntentOld(uri, 0);
5535 }
5536
5537 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005538 Intent intent;
5539
5540 int i = uri.lastIndexOf('#');
5541 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005542 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005543 final int intentFragmentStart = i;
5544 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005545
5546 i++;
5547
5548 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005549 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005550 i += 7;
5551 int j = uri.indexOf(')', i);
5552 action = uri.substring(i, j);
5553 i = j + 1;
5554 }
5555
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005556 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005557
5558 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005559 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005560 i += 11;
5561 int j = uri.indexOf(')', i);
5562 while (i < j) {
5563 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005564 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005565 if (i < sep) {
5566 intent.addCategory(uri.substring(i, sep));
5567 }
5568 i = sep + 1;
5569 }
5570 i = j + 1;
5571 }
5572
5573 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005574 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005575 i += 5;
5576 int j = uri.indexOf(')', i);
5577 intent.mType = uri.substring(i, j);
5578 i = j + 1;
5579 }
5580
5581 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005582 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005583 i += 12;
5584 int j = uri.indexOf(')', i);
5585 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005586 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5587 intent.mFlags &= ~IMMUTABLE_FLAGS;
5588 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005589 i = j + 1;
5590 }
5591
5592 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005593 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005594 i += 10;
5595 int j = uri.indexOf(')', i);
5596 int sep = uri.indexOf('!', i);
5597 if (sep >= 0 && sep < j) {
5598 String pkg = uri.substring(i, sep);
5599 String cls = uri.substring(sep + 1, j);
5600 intent.mComponent = new ComponentName(pkg, cls);
5601 }
5602 i = j + 1;
5603 }
5604
5605 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005606 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005607 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005608
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005609 final int closeParen = uri.indexOf(')', i);
5610 if (closeParen == -1) throw new URISyntaxException(uri,
5611 "EXTRA missing trailing ')'", i);
5612
5613 while (i < closeParen) {
5614 // fetch the key value
5615 int j = uri.indexOf('=', i);
5616 if (j <= i + 1 || i >= closeParen) {
5617 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5618 }
5619 char type = uri.charAt(i);
5620 i++;
5621 String key = uri.substring(i, j);
5622 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005624 // get type-value
5625 j = uri.indexOf('!', i);
5626 if (j == -1 || j >= closeParen) j = closeParen;
5627 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5628 String value = uri.substring(i, j);
5629 i = j;
5630
5631 // create Bundle if it doesn't already exist
5632 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005634 // add item to bundle
5635 try {
5636 switch (type) {
5637 case 'S':
5638 intent.mExtras.putString(key, Uri.decode(value));
5639 break;
5640 case 'B':
5641 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5642 break;
5643 case 'b':
5644 intent.mExtras.putByte(key, Byte.parseByte(value));
5645 break;
5646 case 'c':
5647 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5648 break;
5649 case 'd':
5650 intent.mExtras.putDouble(key, Double.parseDouble(value));
5651 break;
5652 case 'f':
5653 intent.mExtras.putFloat(key, Float.parseFloat(value));
5654 break;
5655 case 'i':
5656 intent.mExtras.putInt(key, Integer.parseInt(value));
5657 break;
5658 case 'l':
5659 intent.mExtras.putLong(key, Long.parseLong(value));
5660 break;
5661 case 's':
5662 intent.mExtras.putShort(key, Short.parseShort(value));
5663 break;
5664 default:
5665 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5666 }
5667 } catch (NumberFormatException e) {
5668 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5669 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005671 char ch = uri.charAt(i);
5672 if (ch == ')') break;
5673 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5674 i++;
5675 }
5676 }
5677
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005678 if (isIntentFragment) {
5679 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5680 } else {
5681 intent.mData = Uri.parse(uri);
5682 }
Tom Taylord4a47292009-12-21 13:59:18 -08005683
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005684 if (intent.mAction == null) {
5685 // By default, if no action is specified, then use VIEW.
5686 intent.mAction = ACTION_VIEW;
5687 }
5688
5689 } else {
5690 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5691 }
5692
5693 return intent;
5694 }
5695
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005696 /** @hide */
5697 public interface CommandOptionHandler {
5698 boolean handleOption(String opt, ShellCommand cmd);
5699 }
5700
5701 /** @hide */
5702 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5703 throws URISyntaxException {
5704 Intent intent = new Intent();
5705 Intent baseIntent = intent;
5706 boolean hasIntentInfo = false;
5707
5708 Uri data = null;
5709 String type = null;
5710
5711 String opt;
5712 while ((opt=cmd.getNextOption()) != null) {
5713 switch (opt) {
5714 case "-a":
5715 intent.setAction(cmd.getNextArgRequired());
5716 if (intent == baseIntent) {
5717 hasIntentInfo = true;
5718 }
5719 break;
5720 case "-d":
5721 data = Uri.parse(cmd.getNextArgRequired());
5722 if (intent == baseIntent) {
5723 hasIntentInfo = true;
5724 }
5725 break;
5726 case "-t":
5727 type = cmd.getNextArgRequired();
5728 if (intent == baseIntent) {
5729 hasIntentInfo = true;
5730 }
5731 break;
5732 case "-c":
5733 intent.addCategory(cmd.getNextArgRequired());
5734 if (intent == baseIntent) {
5735 hasIntentInfo = true;
5736 }
5737 break;
5738 case "-e":
5739 case "--es": {
5740 String key = cmd.getNextArgRequired();
5741 String value = cmd.getNextArgRequired();
5742 intent.putExtra(key, value);
5743 }
5744 break;
5745 case "--esn": {
5746 String key = cmd.getNextArgRequired();
5747 intent.putExtra(key, (String) null);
5748 }
5749 break;
5750 case "--ei": {
5751 String key = cmd.getNextArgRequired();
5752 String value = cmd.getNextArgRequired();
5753 intent.putExtra(key, Integer.decode(value));
5754 }
5755 break;
5756 case "--eu": {
5757 String key = cmd.getNextArgRequired();
5758 String value = cmd.getNextArgRequired();
5759 intent.putExtra(key, Uri.parse(value));
5760 }
5761 break;
5762 case "--ecn": {
5763 String key = cmd.getNextArgRequired();
5764 String value = cmd.getNextArgRequired();
5765 ComponentName cn = ComponentName.unflattenFromString(value);
5766 if (cn == null)
5767 throw new IllegalArgumentException("Bad component name: " + value);
5768 intent.putExtra(key, cn);
5769 }
5770 break;
5771 case "--eia": {
5772 String key = cmd.getNextArgRequired();
5773 String value = cmd.getNextArgRequired();
5774 String[] strings = value.split(",");
5775 int[] list = new int[strings.length];
5776 for (int i = 0; i < strings.length; i++) {
5777 list[i] = Integer.decode(strings[i]);
5778 }
5779 intent.putExtra(key, list);
5780 }
5781 break;
5782 case "--eial": {
5783 String key = cmd.getNextArgRequired();
5784 String value = cmd.getNextArgRequired();
5785 String[] strings = value.split(",");
5786 ArrayList<Integer> list = new ArrayList<>(strings.length);
5787 for (int i = 0; i < strings.length; i++) {
5788 list.add(Integer.decode(strings[i]));
5789 }
5790 intent.putExtra(key, list);
5791 }
5792 break;
5793 case "--el": {
5794 String key = cmd.getNextArgRequired();
5795 String value = cmd.getNextArgRequired();
5796 intent.putExtra(key, Long.valueOf(value));
5797 }
5798 break;
5799 case "--ela": {
5800 String key = cmd.getNextArgRequired();
5801 String value = cmd.getNextArgRequired();
5802 String[] strings = value.split(",");
5803 long[] list = new long[strings.length];
5804 for (int i = 0; i < strings.length; i++) {
5805 list[i] = Long.valueOf(strings[i]);
5806 }
5807 intent.putExtra(key, list);
5808 hasIntentInfo = true;
5809 }
5810 break;
5811 case "--elal": {
5812 String key = cmd.getNextArgRequired();
5813 String value = cmd.getNextArgRequired();
5814 String[] strings = value.split(",");
5815 ArrayList<Long> list = new ArrayList<>(strings.length);
5816 for (int i = 0; i < strings.length; i++) {
5817 list.add(Long.valueOf(strings[i]));
5818 }
5819 intent.putExtra(key, list);
5820 hasIntentInfo = true;
5821 }
5822 break;
5823 case "--ef": {
5824 String key = cmd.getNextArgRequired();
5825 String value = cmd.getNextArgRequired();
5826 intent.putExtra(key, Float.valueOf(value));
5827 hasIntentInfo = true;
5828 }
5829 break;
5830 case "--efa": {
5831 String key = cmd.getNextArgRequired();
5832 String value = cmd.getNextArgRequired();
5833 String[] strings = value.split(",");
5834 float[] list = new float[strings.length];
5835 for (int i = 0; i < strings.length; i++) {
5836 list[i] = Float.valueOf(strings[i]);
5837 }
5838 intent.putExtra(key, list);
5839 hasIntentInfo = true;
5840 }
5841 break;
5842 case "--efal": {
5843 String key = cmd.getNextArgRequired();
5844 String value = cmd.getNextArgRequired();
5845 String[] strings = value.split(",");
5846 ArrayList<Float> list = new ArrayList<>(strings.length);
5847 for (int i = 0; i < strings.length; i++) {
5848 list.add(Float.valueOf(strings[i]));
5849 }
5850 intent.putExtra(key, list);
5851 hasIntentInfo = true;
5852 }
5853 break;
5854 case "--esa": {
5855 String key = cmd.getNextArgRequired();
5856 String value = cmd.getNextArgRequired();
5857 // Split on commas unless they are preceeded by an escape.
5858 // The escape character must be escaped for the string and
5859 // again for the regex, thus four escape characters become one.
5860 String[] strings = value.split("(?<!\\\\),");
5861 intent.putExtra(key, strings);
5862 hasIntentInfo = true;
5863 }
5864 break;
5865 case "--esal": {
5866 String key = cmd.getNextArgRequired();
5867 String value = cmd.getNextArgRequired();
5868 // Split on commas unless they are preceeded by an escape.
5869 // The escape character must be escaped for the string and
5870 // again for the regex, thus four escape characters become one.
5871 String[] strings = value.split("(?<!\\\\),");
5872 ArrayList<String> list = new ArrayList<>(strings.length);
5873 for (int i = 0; i < strings.length; i++) {
5874 list.add(strings[i]);
5875 }
5876 intent.putExtra(key, list);
5877 hasIntentInfo = true;
5878 }
5879 break;
5880 case "--ez": {
5881 String key = cmd.getNextArgRequired();
5882 String value = cmd.getNextArgRequired().toLowerCase();
5883 // Boolean.valueOf() results in false for anything that is not "true", which is
5884 // error-prone in shell commands
5885 boolean arg;
5886 if ("true".equals(value) || "t".equals(value)) {
5887 arg = true;
5888 } else if ("false".equals(value) || "f".equals(value)) {
5889 arg = false;
5890 } else {
5891 try {
5892 arg = Integer.decode(value) != 0;
5893 } catch (NumberFormatException ex) {
5894 throw new IllegalArgumentException("Invalid boolean value: " + value);
5895 }
5896 }
5897
5898 intent.putExtra(key, arg);
5899 }
5900 break;
5901 case "-n": {
5902 String str = cmd.getNextArgRequired();
5903 ComponentName cn = ComponentName.unflattenFromString(str);
5904 if (cn == null)
5905 throw new IllegalArgumentException("Bad component name: " + str);
5906 intent.setComponent(cn);
5907 if (intent == baseIntent) {
5908 hasIntentInfo = true;
5909 }
5910 }
5911 break;
5912 case "-p": {
5913 String str = cmd.getNextArgRequired();
5914 intent.setPackage(str);
5915 if (intent == baseIntent) {
5916 hasIntentInfo = true;
5917 }
5918 }
5919 break;
5920 case "-f":
5921 String str = cmd.getNextArgRequired();
5922 intent.setFlags(Integer.decode(str).intValue());
5923 break;
5924 case "--grant-read-uri-permission":
5925 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5926 break;
5927 case "--grant-write-uri-permission":
5928 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5929 break;
5930 case "--grant-persistable-uri-permission":
5931 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5932 break;
5933 case "--grant-prefix-uri-permission":
5934 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5935 break;
5936 case "--exclude-stopped-packages":
5937 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5938 break;
5939 case "--include-stopped-packages":
5940 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5941 break;
5942 case "--debug-log-resolution":
5943 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5944 break;
5945 case "--activity-brought-to-front":
5946 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5947 break;
5948 case "--activity-clear-top":
5949 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5950 break;
5951 case "--activity-clear-when-task-reset":
5952 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5953 break;
5954 case "--activity-exclude-from-recents":
5955 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5956 break;
5957 case "--activity-launched-from-history":
5958 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5959 break;
5960 case "--activity-multiple-task":
5961 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5962 break;
5963 case "--activity-no-animation":
5964 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5965 break;
5966 case "--activity-no-history":
5967 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5968 break;
5969 case "--activity-no-user-action":
5970 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5971 break;
5972 case "--activity-previous-is-top":
5973 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5974 break;
5975 case "--activity-reorder-to-front":
5976 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5977 break;
5978 case "--activity-reset-task-if-needed":
5979 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5980 break;
5981 case "--activity-single-top":
5982 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5983 break;
5984 case "--activity-clear-task":
5985 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5986 break;
5987 case "--activity-task-on-home":
5988 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5989 break;
5990 case "--receiver-registered-only":
5991 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5992 break;
5993 case "--receiver-replace-pending":
5994 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5995 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005996 case "--receiver-foreground":
5997 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5998 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005999 case "--selector":
6000 intent.setDataAndType(data, type);
6001 intent = new Intent();
6002 break;
6003 default:
6004 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
6005 // Okay, caller handled this option.
6006 } else {
6007 throw new IllegalArgumentException("Unknown option: " + opt);
6008 }
6009 break;
6010 }
6011 }
6012 intent.setDataAndType(data, type);
6013
6014 final boolean hasSelector = intent != baseIntent;
6015 if (hasSelector) {
6016 // A selector was specified; fix up.
6017 baseIntent.setSelector(intent);
6018 intent = baseIntent;
6019 }
6020
6021 String arg = cmd.getNextArg();
6022 baseIntent = null;
6023 if (arg == null) {
6024 if (hasSelector) {
6025 // If a selector has been specified, and no arguments
6026 // have been supplied for the main Intent, then we can
6027 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6028 // need to have a component name specified yet, the
6029 // selector will take care of that.
6030 baseIntent = new Intent(Intent.ACTION_MAIN);
6031 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6032 }
6033 } else if (arg.indexOf(':') >= 0) {
6034 // The argument is a URI. Fully parse it, and use that result
6035 // to fill in any data not specified so far.
6036 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6037 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6038 } else if (arg.indexOf('/') >= 0) {
6039 // The argument is a component name. Build an Intent to launch
6040 // it.
6041 baseIntent = new Intent(Intent.ACTION_MAIN);
6042 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6043 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6044 } else {
6045 // Assume the argument is a package name.
6046 baseIntent = new Intent(Intent.ACTION_MAIN);
6047 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6048 baseIntent.setPackage(arg);
6049 }
6050 if (baseIntent != null) {
6051 Bundle extras = intent.getExtras();
6052 intent.replaceExtras((Bundle)null);
6053 Bundle uriExtras = baseIntent.getExtras();
6054 baseIntent.replaceExtras((Bundle)null);
6055 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6056 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6057 for (String c : cats) {
6058 baseIntent.removeCategory(c);
6059 }
6060 }
6061 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6062 if (extras == null) {
6063 extras = uriExtras;
6064 } else if (uriExtras != null) {
6065 uriExtras.putAll(extras);
6066 extras = uriExtras;
6067 }
6068 intent.replaceExtras(extras);
6069 hasIntentInfo = true;
6070 }
6071
6072 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6073 return intent;
6074 }
6075
6076 /** @hide */
6077 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6078 final String[] lines = new String[] {
6079 "<INTENT> specifications include these flags and arguments:",
6080 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6081 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6082 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6083 " [--esn <EXTRA_KEY> ...]",
6084 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6085 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6086 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6087 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6088 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6089 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6090 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6091 " (mutiple extras passed as Integer[])",
6092 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6093 " (mutiple extras passed as List<Integer>)",
6094 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6095 " (mutiple extras passed as Long[])",
6096 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6097 " (mutiple extras passed as List<Long>)",
6098 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6099 " (mutiple extras passed as Float[])",
6100 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6101 " (mutiple extras passed as List<Float>)",
6102 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6103 " (mutiple extras passed as String[]; to embed a comma into a string,",
6104 " escape it using \"\\,\")",
6105 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6106 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6107 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006108 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006109 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6110 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6111 " [--debug-log-resolution] [--exclude-stopped-packages]",
6112 " [--include-stopped-packages]",
6113 " [--activity-brought-to-front] [--activity-clear-top]",
6114 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6115 " [--activity-launched-from-history] [--activity-multiple-task]",
6116 " [--activity-no-animation] [--activity-no-history]",
6117 " [--activity-no-user-action] [--activity-previous-is-top]",
6118 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6119 " [--activity-single-top] [--activity-clear-task]",
6120 " [--activity-task-on-home]",
6121 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006122 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006123 " [--selector]",
6124 " [<URI> | <PACKAGE> | <COMPONENT>]"
6125 };
6126 for (String line : lines) {
6127 pw.print(prefix);
6128 pw.println(line);
6129 }
6130 }
6131
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006132 /**
6133 * Retrieve the general action to be performed, such as
6134 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6135 * the information in the intent should be interpreted -- most importantly,
6136 * what to do with the data returned by {@link #getData}.
6137 *
6138 * @return The action of this intent or null if none is specified.
6139 *
6140 * @see #setAction
6141 */
6142 public String getAction() {
6143 return mAction;
6144 }
6145
6146 /**
6147 * Retrieve data this intent is operating on. This URI specifies the name
6148 * of the data; often it uses the content: scheme, specifying data in a
6149 * content provider. Other schemes may be handled by specific activities,
6150 * such as http: by the web browser.
6151 *
6152 * @return The URI of the data this intent is targeting or null.
6153 *
6154 * @see #getScheme
6155 * @see #setData
6156 */
6157 public Uri getData() {
6158 return mData;
6159 }
6160
6161 /**
6162 * The same as {@link #getData()}, but returns the URI as an encoded
6163 * String.
6164 */
6165 public String getDataString() {
6166 return mData != null ? mData.toString() : null;
6167 }
6168
6169 /**
6170 * Return the scheme portion of the intent's data. If the data is null or
6171 * does not include a scheme, null is returned. Otherwise, the scheme
6172 * prefix without the final ':' is returned, i.e. "http".
6173 *
6174 * <p>This is the same as calling getData().getScheme() (and checking for
6175 * null data).
6176 *
6177 * @return The scheme of this intent.
6178 *
6179 * @see #getData
6180 */
6181 public String getScheme() {
6182 return mData != null ? mData.getScheme() : null;
6183 }
6184
6185 /**
6186 * Retrieve any explicit MIME type included in the intent. This is usually
6187 * null, as the type is determined by the intent data.
6188 *
6189 * @return If a type was manually set, it is returned; else null is
6190 * returned.
6191 *
6192 * @see #resolveType(ContentResolver)
6193 * @see #setType
6194 */
6195 public String getType() {
6196 return mType;
6197 }
6198
6199 /**
6200 * Return the MIME data type of this intent. If the type field is
6201 * explicitly set, that is simply returned. Otherwise, if the data is set,
6202 * the type of that data is returned. If neither fields are set, a null is
6203 * returned.
6204 *
6205 * @return The MIME type of this intent.
6206 *
6207 * @see #getType
6208 * @see #resolveType(ContentResolver)
6209 */
6210 public String resolveType(Context context) {
6211 return resolveType(context.getContentResolver());
6212 }
6213
6214 /**
6215 * Return the MIME data type of this intent. If the type field is
6216 * explicitly set, that is simply returned. Otherwise, if the data is set,
6217 * the type of that data is returned. If neither fields are set, a null is
6218 * returned.
6219 *
6220 * @param resolver A ContentResolver that can be used to determine the MIME
6221 * type of the intent's data.
6222 *
6223 * @return The MIME type of this intent.
6224 *
6225 * @see #getType
6226 * @see #resolveType(Context)
6227 */
6228 public String resolveType(ContentResolver resolver) {
6229 if (mType != null) {
6230 return mType;
6231 }
6232 if (mData != null) {
6233 if ("content".equals(mData.getScheme())) {
6234 return resolver.getType(mData);
6235 }
6236 }
6237 return null;
6238 }
6239
6240 /**
6241 * Return the MIME data type of this intent, only if it will be needed for
6242 * intent resolution. This is not generally useful for application code;
6243 * it is used by the frameworks for communicating with back-end system
6244 * services.
6245 *
6246 * @param resolver A ContentResolver that can be used to determine the MIME
6247 * type of the intent's data.
6248 *
6249 * @return The MIME type of this intent, or null if it is unknown or not
6250 * needed.
6251 */
6252 public String resolveTypeIfNeeded(ContentResolver resolver) {
6253 if (mComponent != null) {
6254 return mType;
6255 }
6256 return resolveType(resolver);
6257 }
6258
6259 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006260 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006261 *
6262 * @param category The category to check.
6263 *
6264 * @return boolean True if the intent contains the category, else false.
6265 *
6266 * @see #getCategories
6267 * @see #addCategory
6268 */
6269 public boolean hasCategory(String category) {
6270 return mCategories != null && mCategories.contains(category);
6271 }
6272
6273 /**
6274 * Return the set of all categories in the intent. If there are no categories,
6275 * returns NULL.
6276 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006277 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006278 *
6279 * @see #hasCategory
6280 * @see #addCategory
6281 */
6282 public Set<String> getCategories() {
6283 return mCategories;
6284 }
6285
6286 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006287 * Return the specific selector associated with this Intent. If there is
6288 * none, returns null. See {@link #setSelector} for more information.
6289 *
6290 * @see #setSelector
6291 */
6292 public Intent getSelector() {
6293 return mSelector;
6294 }
6295
6296 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006297 * Return the {@link ClipData} associated with this Intent. If there is
6298 * none, returns null. See {@link #setClipData} for more information.
6299 *
John Spurlock125d1332013-11-25 11:58:37 -05006300 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006301 */
6302 public ClipData getClipData() {
6303 return mClipData;
6304 }
6305
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006306 /** @hide */
6307 public int getContentUserHint() {
6308 return mContentUserHint;
6309 }
6310
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006311 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006312 * Sets the ClassLoader that will be used when unmarshalling
6313 * any Parcelable values from the extras of this Intent.
6314 *
6315 * @param loader a ClassLoader, or null to use the default loader
6316 * at the time of unmarshalling.
6317 */
6318 public void setExtrasClassLoader(ClassLoader loader) {
6319 if (mExtras != null) {
6320 mExtras.setClassLoader(loader);
6321 }
6322 }
6323
6324 /**
6325 * Returns true if an extra value is associated with the given name.
6326 * @param name the extra's name
6327 * @return true if the given extra is present.
6328 */
6329 public boolean hasExtra(String name) {
6330 return mExtras != null && mExtras.containsKey(name);
6331 }
6332
6333 /**
6334 * Returns true if the Intent's extras contain a parcelled file descriptor.
6335 * @return true if the Intent contains a parcelled file descriptor.
6336 */
6337 public boolean hasFileDescriptors() {
6338 return mExtras != null && mExtras.hasFileDescriptors();
6339 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006340
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006341 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006342 public void setAllowFds(boolean allowFds) {
6343 if (mExtras != null) {
6344 mExtras.setAllowFds(allowFds);
6345 }
6346 }
6347
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006348 /** {@hide} */
6349 public void setDefusable(boolean defusable) {
6350 if (mExtras != null) {
6351 mExtras.setDefusable(defusable);
6352 }
6353 }
6354
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006355 /**
6356 * Retrieve extended data from the intent.
6357 *
6358 * @param name The name of the desired item.
6359 *
6360 * @return the value of an item that previously added with putExtra()
6361 * or null if none was found.
6362 *
6363 * @deprecated
6364 * @hide
6365 */
6366 @Deprecated
6367 public Object getExtra(String name) {
6368 return getExtra(name, null);
6369 }
6370
6371 /**
6372 * Retrieve extended data from the intent.
6373 *
6374 * @param name The name of the desired item.
6375 * @param defaultValue the value to be returned if no value of the desired
6376 * type is stored with the given name.
6377 *
6378 * @return the value of an item that previously added with putExtra()
6379 * or the default value if none was found.
6380 *
6381 * @see #putExtra(String, boolean)
6382 */
6383 public boolean getBooleanExtra(String name, boolean defaultValue) {
6384 return mExtras == null ? defaultValue :
6385 mExtras.getBoolean(name, defaultValue);
6386 }
6387
6388 /**
6389 * Retrieve extended data from the intent.
6390 *
6391 * @param name The name of the desired item.
6392 * @param defaultValue the value to be returned if no value of the desired
6393 * type is stored with the given name.
6394 *
6395 * @return the value of an item that previously added with putExtra()
6396 * or the default value if none was found.
6397 *
6398 * @see #putExtra(String, byte)
6399 */
6400 public byte getByteExtra(String name, byte defaultValue) {
6401 return mExtras == null ? defaultValue :
6402 mExtras.getByte(name, defaultValue);
6403 }
6404
6405 /**
6406 * Retrieve extended data from the intent.
6407 *
6408 * @param name The name of the desired item.
6409 * @param defaultValue the value to be returned if no value of the desired
6410 * type is stored with the given name.
6411 *
6412 * @return the value of an item that previously added with putExtra()
6413 * or the default value if none was found.
6414 *
6415 * @see #putExtra(String, short)
6416 */
6417 public short getShortExtra(String name, short defaultValue) {
6418 return mExtras == null ? defaultValue :
6419 mExtras.getShort(name, defaultValue);
6420 }
6421
6422 /**
6423 * Retrieve extended data from the intent.
6424 *
6425 * @param name The name of the desired item.
6426 * @param defaultValue the value to be returned if no value of the desired
6427 * type is stored with the given name.
6428 *
6429 * @return the value of an item that previously added with putExtra()
6430 * or the default value if none was found.
6431 *
6432 * @see #putExtra(String, char)
6433 */
6434 public char getCharExtra(String name, char defaultValue) {
6435 return mExtras == null ? defaultValue :
6436 mExtras.getChar(name, defaultValue);
6437 }
6438
6439 /**
6440 * Retrieve extended data from the intent.
6441 *
6442 * @param name The name of the desired item.
6443 * @param defaultValue the value to be returned if no value of the desired
6444 * type is stored with the given name.
6445 *
6446 * @return the value of an item that previously added with putExtra()
6447 * or the default value if none was found.
6448 *
6449 * @see #putExtra(String, int)
6450 */
6451 public int getIntExtra(String name, int defaultValue) {
6452 return mExtras == null ? defaultValue :
6453 mExtras.getInt(name, defaultValue);
6454 }
6455
6456 /**
6457 * Retrieve extended data from the intent.
6458 *
6459 * @param name The name of the desired item.
6460 * @param defaultValue the value to be returned if no value of the desired
6461 * type is stored with the given name.
6462 *
6463 * @return the value of an item that previously added with putExtra()
6464 * or the default value if none was found.
6465 *
6466 * @see #putExtra(String, long)
6467 */
6468 public long getLongExtra(String name, long defaultValue) {
6469 return mExtras == null ? defaultValue :
6470 mExtras.getLong(name, defaultValue);
6471 }
6472
6473 /**
6474 * Retrieve extended data from the intent.
6475 *
6476 * @param name The name of the desired item.
6477 * @param defaultValue the value to be returned if no value of the desired
6478 * type is stored with the given name.
6479 *
6480 * @return the value of an item that previously added with putExtra(),
6481 * or the default value if no such item is present
6482 *
6483 * @see #putExtra(String, float)
6484 */
6485 public float getFloatExtra(String name, float defaultValue) {
6486 return mExtras == null ? defaultValue :
6487 mExtras.getFloat(name, defaultValue);
6488 }
6489
6490 /**
6491 * Retrieve extended data from the intent.
6492 *
6493 * @param name The name of the desired item.
6494 * @param defaultValue the value to be returned if no value of the desired
6495 * type is stored with the given name.
6496 *
6497 * @return the value of an item that previously added with putExtra()
6498 * or the default value if none was found.
6499 *
6500 * @see #putExtra(String, double)
6501 */
6502 public double getDoubleExtra(String name, double defaultValue) {
6503 return mExtras == null ? defaultValue :
6504 mExtras.getDouble(name, defaultValue);
6505 }
6506
6507 /**
6508 * Retrieve extended data from the intent.
6509 *
6510 * @param name The name of the desired item.
6511 *
6512 * @return the value of an item that previously added with putExtra()
6513 * or null if no String value was found.
6514 *
6515 * @see #putExtra(String, String)
6516 */
6517 public String getStringExtra(String name) {
6518 return mExtras == null ? null : mExtras.getString(name);
6519 }
6520
6521 /**
6522 * Retrieve extended data from the intent.
6523 *
6524 * @param name The name of the desired item.
6525 *
6526 * @return the value of an item that previously added with putExtra()
6527 * or null if no CharSequence value was found.
6528 *
6529 * @see #putExtra(String, CharSequence)
6530 */
6531 public CharSequence getCharSequenceExtra(String name) {
6532 return mExtras == null ? null : mExtras.getCharSequence(name);
6533 }
6534
6535 /**
6536 * Retrieve extended data from the intent.
6537 *
6538 * @param name The name of the desired item.
6539 *
6540 * @return the value of an item that previously added with putExtra()
6541 * or null if no Parcelable value was found.
6542 *
6543 * @see #putExtra(String, Parcelable)
6544 */
6545 public <T extends Parcelable> T getParcelableExtra(String name) {
6546 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6547 }
6548
6549 /**
6550 * Retrieve extended data from the intent.
6551 *
6552 * @param name The name of the desired item.
6553 *
6554 * @return the value of an item that previously added with putExtra()
6555 * or null if no Parcelable[] value was found.
6556 *
6557 * @see #putExtra(String, Parcelable[])
6558 */
6559 public Parcelable[] getParcelableArrayExtra(String name) {
6560 return mExtras == null ? null : mExtras.getParcelableArray(name);
6561 }
6562
6563 /**
6564 * Retrieve extended data from the intent.
6565 *
6566 * @param name The name of the desired item.
6567 *
6568 * @return the value of an item that previously added with putExtra()
6569 * or null if no ArrayList<Parcelable> value was found.
6570 *
6571 * @see #putParcelableArrayListExtra(String, ArrayList)
6572 */
6573 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6574 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6575 }
6576
6577 /**
6578 * Retrieve extended data from the intent.
6579 *
6580 * @param name The name of the desired item.
6581 *
6582 * @return the value of an item that previously added with putExtra()
6583 * or null if no Serializable value was found.
6584 *
6585 * @see #putExtra(String, Serializable)
6586 */
6587 public Serializable getSerializableExtra(String name) {
6588 return mExtras == null ? null : mExtras.getSerializable(name);
6589 }
6590
6591 /**
6592 * Retrieve extended data from the intent.
6593 *
6594 * @param name The name of the desired item.
6595 *
6596 * @return the value of an item that previously added with putExtra()
6597 * or null if no ArrayList<Integer> value was found.
6598 *
6599 * @see #putIntegerArrayListExtra(String, ArrayList)
6600 */
6601 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6602 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6603 }
6604
6605 /**
6606 * Retrieve extended data from the intent.
6607 *
6608 * @param name The name of the desired item.
6609 *
6610 * @return the value of an item that previously added with putExtra()
6611 * or null if no ArrayList<String> value was found.
6612 *
6613 * @see #putStringArrayListExtra(String, ArrayList)
6614 */
6615 public ArrayList<String> getStringArrayListExtra(String name) {
6616 return mExtras == null ? null : mExtras.getStringArrayList(name);
6617 }
6618
6619 /**
6620 * Retrieve extended data from the intent.
6621 *
6622 * @param name The name of the desired item.
6623 *
6624 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006625 * or null if no ArrayList<CharSequence> value was found.
6626 *
6627 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6628 */
6629 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6630 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6631 }
6632
6633 /**
6634 * Retrieve extended data from the intent.
6635 *
6636 * @param name The name of the desired item.
6637 *
6638 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006639 * or null if no boolean array value was found.
6640 *
6641 * @see #putExtra(String, boolean[])
6642 */
6643 public boolean[] getBooleanArrayExtra(String name) {
6644 return mExtras == null ? null : mExtras.getBooleanArray(name);
6645 }
6646
6647 /**
6648 * Retrieve extended data from the intent.
6649 *
6650 * @param name The name of the desired item.
6651 *
6652 * @return the value of an item that previously added with putExtra()
6653 * or null if no byte array value was found.
6654 *
6655 * @see #putExtra(String, byte[])
6656 */
6657 public byte[] getByteArrayExtra(String name) {
6658 return mExtras == null ? null : mExtras.getByteArray(name);
6659 }
6660
6661 /**
6662 * Retrieve extended data from the intent.
6663 *
6664 * @param name The name of the desired item.
6665 *
6666 * @return the value of an item that previously added with putExtra()
6667 * or null if no short array value was found.
6668 *
6669 * @see #putExtra(String, short[])
6670 */
6671 public short[] getShortArrayExtra(String name) {
6672 return mExtras == null ? null : mExtras.getShortArray(name);
6673 }
6674
6675 /**
6676 * Retrieve extended data from the intent.
6677 *
6678 * @param name The name of the desired item.
6679 *
6680 * @return the value of an item that previously added with putExtra()
6681 * or null if no char array value was found.
6682 *
6683 * @see #putExtra(String, char[])
6684 */
6685 public char[] getCharArrayExtra(String name) {
6686 return mExtras == null ? null : mExtras.getCharArray(name);
6687 }
6688
6689 /**
6690 * Retrieve extended data from the intent.
6691 *
6692 * @param name The name of the desired item.
6693 *
6694 * @return the value of an item that previously added with putExtra()
6695 * or null if no int array value was found.
6696 *
6697 * @see #putExtra(String, int[])
6698 */
6699 public int[] getIntArrayExtra(String name) {
6700 return mExtras == null ? null : mExtras.getIntArray(name);
6701 }
6702
6703 /**
6704 * Retrieve extended data from the intent.
6705 *
6706 * @param name The name of the desired item.
6707 *
6708 * @return the value of an item that previously added with putExtra()
6709 * or null if no long array value was found.
6710 *
6711 * @see #putExtra(String, long[])
6712 */
6713 public long[] getLongArrayExtra(String name) {
6714 return mExtras == null ? null : mExtras.getLongArray(name);
6715 }
6716
6717 /**
6718 * Retrieve extended data from the intent.
6719 *
6720 * @param name The name of the desired item.
6721 *
6722 * @return the value of an item that previously added with putExtra()
6723 * or null if no float array value was found.
6724 *
6725 * @see #putExtra(String, float[])
6726 */
6727 public float[] getFloatArrayExtra(String name) {
6728 return mExtras == null ? null : mExtras.getFloatArray(name);
6729 }
6730
6731 /**
6732 * Retrieve extended data from the intent.
6733 *
6734 * @param name The name of the desired item.
6735 *
6736 * @return the value of an item that previously added with putExtra()
6737 * or null if no double array value was found.
6738 *
6739 * @see #putExtra(String, double[])
6740 */
6741 public double[] getDoubleArrayExtra(String name) {
6742 return mExtras == null ? null : mExtras.getDoubleArray(name);
6743 }
6744
6745 /**
6746 * Retrieve extended data from the intent.
6747 *
6748 * @param name The name of the desired item.
6749 *
6750 * @return the value of an item that previously added with putExtra()
6751 * or null if no String array value was found.
6752 *
6753 * @see #putExtra(String, String[])
6754 */
6755 public String[] getStringArrayExtra(String name) {
6756 return mExtras == null ? null : mExtras.getStringArray(name);
6757 }
6758
6759 /**
6760 * Retrieve extended data from the intent.
6761 *
6762 * @param name The name of the desired item.
6763 *
6764 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006765 * or null if no CharSequence array value was found.
6766 *
6767 * @see #putExtra(String, CharSequence[])
6768 */
6769 public CharSequence[] getCharSequenceArrayExtra(String name) {
6770 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6771 }
6772
6773 /**
6774 * Retrieve extended data from the intent.
6775 *
6776 * @param name The name of the desired item.
6777 *
6778 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006779 * or null if no Bundle value was found.
6780 *
6781 * @see #putExtra(String, Bundle)
6782 */
6783 public Bundle getBundleExtra(String name) {
6784 return mExtras == null ? null : mExtras.getBundle(name);
6785 }
6786
6787 /**
6788 * Retrieve extended data from the intent.
6789 *
6790 * @param name The name of the desired item.
6791 *
6792 * @return the value of an item that previously added with putExtra()
6793 * or null if no IBinder value was found.
6794 *
6795 * @see #putExtra(String, IBinder)
6796 *
6797 * @deprecated
6798 * @hide
6799 */
6800 @Deprecated
6801 public IBinder getIBinderExtra(String name) {
6802 return mExtras == null ? null : mExtras.getIBinder(name);
6803 }
6804
6805 /**
6806 * Retrieve extended data from the intent.
6807 *
6808 * @param name The name of the desired item.
6809 * @param defaultValue The default value to return in case no item is
6810 * associated with the key 'name'
6811 *
6812 * @return the value of an item that previously added with putExtra()
6813 * or defaultValue if none was found.
6814 *
6815 * @see #putExtra
6816 *
6817 * @deprecated
6818 * @hide
6819 */
6820 @Deprecated
6821 public Object getExtra(String name, Object defaultValue) {
6822 Object result = defaultValue;
6823 if (mExtras != null) {
6824 Object result2 = mExtras.get(name);
6825 if (result2 != null) {
6826 result = result2;
6827 }
6828 }
6829
6830 return result;
6831 }
6832
6833 /**
6834 * Retrieves a map of extended data from the intent.
6835 *
6836 * @return the map of all extras previously added with putExtra(),
6837 * or null if none have been added.
6838 */
6839 public Bundle getExtras() {
6840 return (mExtras != null)
6841 ? new Bundle(mExtras)
6842 : null;
6843 }
6844
6845 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006846 * Filter extras to only basic types.
6847 * @hide
6848 */
6849 public void removeUnsafeExtras() {
6850 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006851 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006852 }
6853 }
6854
6855 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006856 * Retrieve any special flags associated with this intent. You will
6857 * normally just set them with {@link #setFlags} and let the system
6858 * take the appropriate action with them.
6859 *
6860 * @return int The currently set flags.
6861 *
6862 * @see #setFlags
6863 */
6864 public int getFlags() {
6865 return mFlags;
6866 }
6867
Dianne Hackborne7f97212011-02-24 14:40:20 -08006868 /** @hide */
6869 public boolean isExcludingStopped() {
6870 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6871 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6872 }
6873
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006875 * Retrieve the application package name this Intent is limited to. When
6876 * resolving an Intent, if non-null this limits the resolution to only
6877 * components in the given application package.
6878 *
6879 * @return The name of the application package for the Intent.
6880 *
6881 * @see #resolveActivity
6882 * @see #setPackage
6883 */
6884 public String getPackage() {
6885 return mPackage;
6886 }
6887
6888 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889 * Retrieve the concrete component associated with the intent. When receiving
6890 * an intent, this is the component that was found to best handle it (that is,
6891 * yourself) and will always be non-null; in all other cases it will be
6892 * null unless explicitly set.
6893 *
6894 * @return The name of the application component to handle the intent.
6895 *
6896 * @see #resolveActivity
6897 * @see #setComponent
6898 */
6899 public ComponentName getComponent() {
6900 return mComponent;
6901 }
6902
6903 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006904 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6905 * used as a hint to the receiver for animations and the like. Null means that there
6906 * is no source bounds.
6907 */
6908 public Rect getSourceBounds() {
6909 return mSourceBounds;
6910 }
6911
6912 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006913 * Return the Activity component that should be used to handle this intent.
6914 * The appropriate component is determined based on the information in the
6915 * intent, evaluated as follows:
6916 *
6917 * <p>If {@link #getComponent} returns an explicit class, that is returned
6918 * without any further consideration.
6919 *
6920 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6921 * category to be considered.
6922 *
6923 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6924 * action.
6925 *
6926 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6927 * this type.
6928 *
6929 * <p>If {@link #addCategory} has added any categories, the activity must
6930 * handle ALL of the categories specified.
6931 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006932 * <p>If {@link #getPackage} is non-NULL, only activity components in
6933 * that application package will be considered.
6934 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006935 * <p>If there are no activities that satisfy all of these conditions, a
6936 * null string is returned.
6937 *
6938 * <p>If multiple activities are found to satisfy the intent, the one with
6939 * the highest priority will be used. If there are multiple activities
6940 * with the same priority, the system will either pick the best activity
6941 * based on user preference, or resolve to a system class that will allow
6942 * the user to pick an activity and forward from there.
6943 *
6944 * <p>This method is implemented simply by calling
6945 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6946 * true.</p>
6947 * <p> This API is called for you as part of starting an activity from an
6948 * intent. You do not normally need to call it yourself.</p>
6949 *
6950 * @param pm The package manager with which to resolve the Intent.
6951 *
6952 * @return Name of the component implementing an activity that can
6953 * display the intent.
6954 *
6955 * @see #setComponent
6956 * @see #getComponent
6957 * @see #resolveActivityInfo
6958 */
6959 public ComponentName resolveActivity(PackageManager pm) {
6960 if (mComponent != null) {
6961 return mComponent;
6962 }
6963
6964 ResolveInfo info = pm.resolveActivity(
6965 this, PackageManager.MATCH_DEFAULT_ONLY);
6966 if (info != null) {
6967 return new ComponentName(
6968 info.activityInfo.applicationInfo.packageName,
6969 info.activityInfo.name);
6970 }
6971
6972 return null;
6973 }
6974
6975 /**
6976 * Resolve the Intent into an {@link ActivityInfo}
6977 * describing the activity that should execute the intent. Resolution
6978 * follows the same rules as described for {@link #resolveActivity}, but
6979 * you get back the completely information about the resolved activity
6980 * instead of just its class name.
6981 *
6982 * @param pm The package manager with which to resolve the Intent.
6983 * @param flags Addition information to retrieve as per
6984 * {@link PackageManager#getActivityInfo(ComponentName, int)
6985 * PackageManager.getActivityInfo()}.
6986 *
6987 * @return PackageManager.ActivityInfo
6988 *
6989 * @see #resolveActivity
6990 */
6991 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6992 ActivityInfo ai = null;
6993 if (mComponent != null) {
6994 try {
6995 ai = pm.getActivityInfo(mComponent, flags);
6996 } catch (PackageManager.NameNotFoundException e) {
6997 // ignore
6998 }
6999 } else {
7000 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07007001 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007002 if (info != null) {
7003 ai = info.activityInfo;
7004 }
7005 }
7006
7007 return ai;
7008 }
7009
7010 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07007011 * Special function for use by the system to resolve service
7012 * intents to system apps. Throws an exception if there are
7013 * multiple potential matches to the Intent. Returns null if
7014 * there are no matches.
7015 * @hide
7016 */
7017 public ComponentName resolveSystemService(PackageManager pm, int flags) {
7018 if (mComponent != null) {
7019 return mComponent;
7020 }
7021
7022 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7023 if (results == null) {
7024 return null;
7025 }
7026 ComponentName comp = null;
7027 for (int i=0; i<results.size(); i++) {
7028 ResolveInfo ri = results.get(i);
7029 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7030 continue;
7031 }
7032 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7033 ri.serviceInfo.name);
7034 if (comp != null) {
7035 throw new IllegalStateException("Multiple system services handle " + this
7036 + ": " + comp + ", " + foundComp);
7037 }
7038 comp = foundComp;
7039 }
7040 return comp;
7041 }
7042
7043 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007044 * Set the general action to be performed.
7045 *
7046 * @param action An action name, such as ACTION_VIEW. Application-specific
7047 * actions should be prefixed with the vendor's package name.
7048 *
7049 * @return Returns the same Intent object, for chaining multiple calls
7050 * into a single statement.
7051 *
7052 * @see #getAction
7053 */
7054 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007055 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007056 return this;
7057 }
7058
7059 /**
7060 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007061 * clears any type that was previously set by {@link #setType} or
7062 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007063 *
Nick Pellyccae4122012-01-09 14:12:58 -08007064 * <p><em>Note: scheme matching in the Android framework is
7065 * case-sensitive, unlike the formal RFC. As a result,
7066 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007067 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007068 * {@link #setDataAndNormalize}
7069 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007070 *
Nick Pellyccae4122012-01-09 14:12:58 -08007071 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007072 *
7073 * @return Returns the same Intent object, for chaining multiple calls
7074 * into a single statement.
7075 *
7076 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007077 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007078 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007079 */
7080 public Intent setData(Uri data) {
7081 mData = data;
7082 mType = null;
7083 return this;
7084 }
7085
7086 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007087 * Normalize and set the data this intent is operating on.
7088 *
7089 * <p>This method automatically clears any type that was
7090 * previously set (for example, by {@link #setType}).
7091 *
7092 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007093 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007094 * so really this is just a convenience method for
7095 * <pre>
7096 * setData(data.normalize())
7097 * </pre>
7098 *
7099 * @param data The Uri of the data this intent is now targeting.
7100 *
7101 * @return Returns the same Intent object, for chaining multiple calls
7102 * into a single statement.
7103 *
7104 * @see #getData
7105 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007106 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007107 */
7108 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007109 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007110 }
7111
7112 /**
7113 * Set an explicit MIME data type.
7114 *
7115 * <p>This is used to create intents that only specify a type and not data,
7116 * for example to indicate the type of data to return.
7117 *
7118 * <p>This method automatically clears any data that was
7119 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007120 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007121 * <p><em>Note: MIME type matching in the Android framework is
7122 * case-sensitive, unlike formal RFC MIME types. As a result,
7123 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007124 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7125 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007126 *
7127 * @param type The MIME type of the data being handled by this intent.
7128 *
7129 * @return Returns the same Intent object, for chaining multiple calls
7130 * into a single statement.
7131 *
7132 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007133 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007134 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007135 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007136 */
7137 public Intent setType(String type) {
7138 mData = null;
7139 mType = type;
7140 return this;
7141 }
7142
7143 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007144 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007145 *
Nick Pellyccae4122012-01-09 14:12:58 -08007146 * <p>This is used to create intents that only specify a type and not data,
7147 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007148 *
Nick Pellyccae4122012-01-09 14:12:58 -08007149 * <p>This method automatically clears any data that was
7150 * previously set (for example by {@link #setData}).
7151 *
7152 * <p>The MIME type is normalized using
7153 * {@link #normalizeMimeType} before it is set,
7154 * so really this is just a convenience method for
7155 * <pre>
7156 * setType(Intent.normalizeMimeType(type))
7157 * </pre>
7158 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007159 * @param type The MIME type of the data being handled by this intent.
7160 *
7161 * @return Returns the same Intent object, for chaining multiple calls
7162 * into a single statement.
7163 *
Nick Pellyccae4122012-01-09 14:12:58 -08007164 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007165 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007166 * @see #normalizeMimeType
7167 */
7168 public Intent setTypeAndNormalize(String type) {
7169 return setType(normalizeMimeType(type));
7170 }
7171
7172 /**
7173 * (Usually optional) Set the data for the intent along with an explicit
7174 * MIME data type. This method should very rarely be used -- it allows you
7175 * to override the MIME type that would ordinarily be inferred from the
7176 * data with your own type given here.
7177 *
7178 * <p><em>Note: MIME type and Uri scheme matching in the
7179 * Android framework is case-sensitive, unlike the formal RFC definitions.
7180 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007181 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007182 * {@link #setDataAndTypeAndNormalize}
7183 * to ensure that they are converted to lower case.</em>
7184 *
7185 * @param data The Uri of the data this intent is now targeting.
7186 * @param type The MIME type of the data being handled by this intent.
7187 *
7188 * @return Returns the same Intent object, for chaining multiple calls
7189 * into a single statement.
7190 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007191 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007192 * @see #setData
7193 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007194 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007195 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007196 */
7197 public Intent setDataAndType(Uri data, String type) {
7198 mData = data;
7199 mType = type;
7200 return this;
7201 }
7202
7203 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007204 * (Usually optional) Normalize and set both the data Uri and an explicit
7205 * MIME data type. This method should very rarely be used -- it allows you
7206 * to override the MIME type that would ordinarily be inferred from the
7207 * data with your own type given here.
7208 *
7209 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007210 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007211 * before they are set, so really this is just a convenience method for
7212 * <pre>
7213 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7214 * </pre>
7215 *
7216 * @param data The Uri of the data this intent is now targeting.
7217 * @param type The MIME type of the data being handled by this intent.
7218 *
7219 * @return Returns the same Intent object, for chaining multiple calls
7220 * into a single statement.
7221 *
7222 * @see #setType
7223 * @see #setData
7224 * @see #setDataAndType
7225 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007226 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007227 */
7228 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007229 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007230 }
7231
7232 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007233 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007234 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007235 * activities that provide <em>all</em> of the requested categories will be
7236 * used.
7237 *
7238 * @param category The desired category. This can be either one of the
7239 * predefined Intent categories, or a custom category in your own
7240 * namespace.
7241 *
7242 * @return Returns the same Intent object, for chaining multiple calls
7243 * into a single statement.
7244 *
7245 * @see #hasCategory
7246 * @see #removeCategory
7247 */
7248 public Intent addCategory(String category) {
7249 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007250 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007251 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007252 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007253 return this;
7254 }
7255
7256 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007257 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007258 *
7259 * @param category The category to remove.
7260 *
7261 * @see #addCategory
7262 */
7263 public void removeCategory(String category) {
7264 if (mCategories != null) {
7265 mCategories.remove(category);
7266 if (mCategories.size() == 0) {
7267 mCategories = null;
7268 }
7269 }
7270 }
7271
7272 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007273 * Set a selector for this Intent. This is a modification to the kinds of
7274 * things the Intent will match. If the selector is set, it will be used
7275 * when trying to find entities that can handle the Intent, instead of the
7276 * main contents of the Intent. This allows you build an Intent containing
7277 * a generic protocol while targeting it more specifically.
7278 *
7279 * <p>An example of where this may be used is with things like
7280 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7281 * Intent that will launch the Browser application. However, the correct
7282 * main entry point of an application is actually {@link #ACTION_MAIN}
7283 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7284 * used to specify the actual Activity to launch. If you launch the browser
7285 * with something different, undesired behavior may happen if the user has
7286 * previously or later launches it the normal way, since they do not match.
7287 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7288 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7289 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7290 *
7291 * <p>Setting a selector does not impact the behavior of
7292 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7293 * desired behavior of a selector -- it does not impact the base meaning
7294 * of the Intent, just what kinds of things will be matched against it
7295 * when determining who can handle it.</p>
7296 *
7297 * <p>You can not use both a selector and {@link #setPackage(String)} on
7298 * the same base Intent.</p>
7299 *
7300 * @param selector The desired selector Intent; set to null to not use
7301 * a special selector.
7302 */
7303 public void setSelector(Intent selector) {
7304 if (selector == this) {
7305 throw new IllegalArgumentException(
7306 "Intent being set as a selector of itself");
7307 }
7308 if (selector != null && mPackage != null) {
7309 throw new IllegalArgumentException(
7310 "Can't set selector when package name is already set");
7311 }
7312 mSelector = selector;
7313 }
7314
7315 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007316 * Set a {@link ClipData} associated with this Intent. This replaces any
7317 * previously set ClipData.
7318 *
7319 * <p>The ClipData in an intent is not used for Intent matching or other
7320 * such operations. Semantically it is like extras, used to transmit
7321 * additional data with the Intent. The main feature of using this over
7322 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7323 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7324 * items included in the clip data. This is useful, in particular, if
7325 * you want to transmit an Intent containing multiple <code>content:</code>
7326 * URIs for which the recipient may not have global permission to access the
7327 * content provider.
7328 *
7329 * <p>If the ClipData contains items that are themselves Intents, any
7330 * grant flags in those Intents will be ignored. Only the top-level flags
7331 * of the main Intent are respected, and will be applied to all Uri or
7332 * Intent items in the clip (or sub-items of the clip).
7333 *
7334 * <p>The MIME type, label, and icon in the ClipData object are not
7335 * directly used by Intent. Applications should generally rely on the
7336 * MIME type of the Intent itself, not what it may find in the ClipData.
7337 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007338 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007339 *
7340 * @param clip The new clip to set. May be null to clear the current clip.
7341 */
7342 public void setClipData(ClipData clip) {
7343 mClipData = clip;
7344 }
7345
7346 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007347 * This is NOT a secure mechanism to identify the user who sent the intent.
7348 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7349 * who sent the intent.
7350 * @hide
7351 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007352 public void prepareToLeaveUser(int userId) {
7353 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7354 // We want mContentUserHint to refer to the original user, so don't do anything.
7355 if (mContentUserHint == UserHandle.USER_CURRENT) {
7356 mContentUserHint = userId;
7357 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007358 }
7359
7360 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007361 * Add extended data to the intent. The name must include a package
7362 * prefix, for example the app com.android.contacts would use names
7363 * like "com.android.contacts.ShowAll".
7364 *
7365 * @param name The name of the extra data, with package prefix.
7366 * @param value The boolean data value.
7367 *
7368 * @return Returns the same Intent object, for chaining multiple calls
7369 * into a single statement.
7370 *
7371 * @see #putExtras
7372 * @see #removeExtra
7373 * @see #getBooleanExtra(String, boolean)
7374 */
7375 public Intent putExtra(String name, boolean value) {
7376 if (mExtras == null) {
7377 mExtras = new Bundle();
7378 }
7379 mExtras.putBoolean(name, value);
7380 return this;
7381 }
7382
7383 /**
7384 * Add extended data to the intent. The name must include a package
7385 * prefix, for example the app com.android.contacts would use names
7386 * like "com.android.contacts.ShowAll".
7387 *
7388 * @param name The name of the extra data, with package prefix.
7389 * @param value The byte data value.
7390 *
7391 * @return Returns the same Intent object, for chaining multiple calls
7392 * into a single statement.
7393 *
7394 * @see #putExtras
7395 * @see #removeExtra
7396 * @see #getByteExtra(String, byte)
7397 */
7398 public Intent putExtra(String name, byte value) {
7399 if (mExtras == null) {
7400 mExtras = new Bundle();
7401 }
7402 mExtras.putByte(name, value);
7403 return this;
7404 }
7405
7406 /**
7407 * Add extended data to the intent. The name must include a package
7408 * prefix, for example the app com.android.contacts would use names
7409 * like "com.android.contacts.ShowAll".
7410 *
7411 * @param name The name of the extra data, with package prefix.
7412 * @param value The char data value.
7413 *
7414 * @return Returns the same Intent object, for chaining multiple calls
7415 * into a single statement.
7416 *
7417 * @see #putExtras
7418 * @see #removeExtra
7419 * @see #getCharExtra(String, char)
7420 */
7421 public Intent putExtra(String name, char value) {
7422 if (mExtras == null) {
7423 mExtras = new Bundle();
7424 }
7425 mExtras.putChar(name, value);
7426 return this;
7427 }
7428
7429 /**
7430 * Add extended data to the intent. The name must include a package
7431 * prefix, for example the app com.android.contacts would use names
7432 * like "com.android.contacts.ShowAll".
7433 *
7434 * @param name The name of the extra data, with package prefix.
7435 * @param value The short data value.
7436 *
7437 * @return Returns the same Intent object, for chaining multiple calls
7438 * into a single statement.
7439 *
7440 * @see #putExtras
7441 * @see #removeExtra
7442 * @see #getShortExtra(String, short)
7443 */
7444 public Intent putExtra(String name, short value) {
7445 if (mExtras == null) {
7446 mExtras = new Bundle();
7447 }
7448 mExtras.putShort(name, value);
7449 return this;
7450 }
7451
7452 /**
7453 * Add extended data to the intent. The name must include a package
7454 * prefix, for example the app com.android.contacts would use names
7455 * like "com.android.contacts.ShowAll".
7456 *
7457 * @param name The name of the extra data, with package prefix.
7458 * @param value The integer data value.
7459 *
7460 * @return Returns the same Intent object, for chaining multiple calls
7461 * into a single statement.
7462 *
7463 * @see #putExtras
7464 * @see #removeExtra
7465 * @see #getIntExtra(String, int)
7466 */
7467 public Intent putExtra(String name, int value) {
7468 if (mExtras == null) {
7469 mExtras = new Bundle();
7470 }
7471 mExtras.putInt(name, value);
7472 return this;
7473 }
7474
7475 /**
7476 * Add extended data to the intent. The name must include a package
7477 * prefix, for example the app com.android.contacts would use names
7478 * like "com.android.contacts.ShowAll".
7479 *
7480 * @param name The name of the extra data, with package prefix.
7481 * @param value The long data value.
7482 *
7483 * @return Returns the same Intent object, for chaining multiple calls
7484 * into a single statement.
7485 *
7486 * @see #putExtras
7487 * @see #removeExtra
7488 * @see #getLongExtra(String, long)
7489 */
7490 public Intent putExtra(String name, long value) {
7491 if (mExtras == null) {
7492 mExtras = new Bundle();
7493 }
7494 mExtras.putLong(name, value);
7495 return this;
7496 }
7497
7498 /**
7499 * Add extended data to the intent. The name must include a package
7500 * prefix, for example the app com.android.contacts would use names
7501 * like "com.android.contacts.ShowAll".
7502 *
7503 * @param name The name of the extra data, with package prefix.
7504 * @param value The float data value.
7505 *
7506 * @return Returns the same Intent object, for chaining multiple calls
7507 * into a single statement.
7508 *
7509 * @see #putExtras
7510 * @see #removeExtra
7511 * @see #getFloatExtra(String, float)
7512 */
7513 public Intent putExtra(String name, float value) {
7514 if (mExtras == null) {
7515 mExtras = new Bundle();
7516 }
7517 mExtras.putFloat(name, value);
7518 return this;
7519 }
7520
7521 /**
7522 * Add extended data to the intent. The name must include a package
7523 * prefix, for example the app com.android.contacts would use names
7524 * like "com.android.contacts.ShowAll".
7525 *
7526 * @param name The name of the extra data, with package prefix.
7527 * @param value The double data value.
7528 *
7529 * @return Returns the same Intent object, for chaining multiple calls
7530 * into a single statement.
7531 *
7532 * @see #putExtras
7533 * @see #removeExtra
7534 * @see #getDoubleExtra(String, double)
7535 */
7536 public Intent putExtra(String name, double value) {
7537 if (mExtras == null) {
7538 mExtras = new Bundle();
7539 }
7540 mExtras.putDouble(name, value);
7541 return this;
7542 }
7543
7544 /**
7545 * Add extended data to the intent. The name must include a package
7546 * prefix, for example the app com.android.contacts would use names
7547 * like "com.android.contacts.ShowAll".
7548 *
7549 * @param name The name of the extra data, with package prefix.
7550 * @param value The String data value.
7551 *
7552 * @return Returns the same Intent object, for chaining multiple calls
7553 * into a single statement.
7554 *
7555 * @see #putExtras
7556 * @see #removeExtra
7557 * @see #getStringExtra(String)
7558 */
7559 public Intent putExtra(String name, String value) {
7560 if (mExtras == null) {
7561 mExtras = new Bundle();
7562 }
7563 mExtras.putString(name, value);
7564 return this;
7565 }
7566
7567 /**
7568 * Add extended data to the intent. The name must include a package
7569 * prefix, for example the app com.android.contacts would use names
7570 * like "com.android.contacts.ShowAll".
7571 *
7572 * @param name The name of the extra data, with package prefix.
7573 * @param value The CharSequence data value.
7574 *
7575 * @return Returns the same Intent object, for chaining multiple calls
7576 * into a single statement.
7577 *
7578 * @see #putExtras
7579 * @see #removeExtra
7580 * @see #getCharSequenceExtra(String)
7581 */
7582 public Intent putExtra(String name, CharSequence value) {
7583 if (mExtras == null) {
7584 mExtras = new Bundle();
7585 }
7586 mExtras.putCharSequence(name, value);
7587 return this;
7588 }
7589
7590 /**
7591 * Add extended data to the intent. The name must include a package
7592 * prefix, for example the app com.android.contacts would use names
7593 * like "com.android.contacts.ShowAll".
7594 *
7595 * @param name The name of the extra data, with package prefix.
7596 * @param value The Parcelable data value.
7597 *
7598 * @return Returns the same Intent object, for chaining multiple calls
7599 * into a single statement.
7600 *
7601 * @see #putExtras
7602 * @see #removeExtra
7603 * @see #getParcelableExtra(String)
7604 */
7605 public Intent putExtra(String name, Parcelable value) {
7606 if (mExtras == null) {
7607 mExtras = new Bundle();
7608 }
7609 mExtras.putParcelable(name, value);
7610 return this;
7611 }
7612
7613 /**
7614 * Add extended data to the intent. The name must include a package
7615 * prefix, for example the app com.android.contacts would use names
7616 * like "com.android.contacts.ShowAll".
7617 *
7618 * @param name The name of the extra data, with package prefix.
7619 * @param value The Parcelable[] data value.
7620 *
7621 * @return Returns the same Intent object, for chaining multiple calls
7622 * into a single statement.
7623 *
7624 * @see #putExtras
7625 * @see #removeExtra
7626 * @see #getParcelableArrayExtra(String)
7627 */
7628 public Intent putExtra(String name, Parcelable[] value) {
7629 if (mExtras == null) {
7630 mExtras = new Bundle();
7631 }
7632 mExtras.putParcelableArray(name, value);
7633 return this;
7634 }
7635
7636 /**
7637 * Add extended data to the intent. The name must include a package
7638 * prefix, for example the app com.android.contacts would use names
7639 * like "com.android.contacts.ShowAll".
7640 *
7641 * @param name The name of the extra data, with package prefix.
7642 * @param value The ArrayList<Parcelable> data value.
7643 *
7644 * @return Returns the same Intent object, for chaining multiple calls
7645 * into a single statement.
7646 *
7647 * @see #putExtras
7648 * @see #removeExtra
7649 * @see #getParcelableArrayListExtra(String)
7650 */
7651 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7652 if (mExtras == null) {
7653 mExtras = new Bundle();
7654 }
7655 mExtras.putParcelableArrayList(name, value);
7656 return this;
7657 }
7658
7659 /**
7660 * Add extended data to the intent. The name must include a package
7661 * prefix, for example the app com.android.contacts would use names
7662 * like "com.android.contacts.ShowAll".
7663 *
7664 * @param name The name of the extra data, with package prefix.
7665 * @param value The ArrayList<Integer> data value.
7666 *
7667 * @return Returns the same Intent object, for chaining multiple calls
7668 * into a single statement.
7669 *
7670 * @see #putExtras
7671 * @see #removeExtra
7672 * @see #getIntegerArrayListExtra(String)
7673 */
7674 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7675 if (mExtras == null) {
7676 mExtras = new Bundle();
7677 }
7678 mExtras.putIntegerArrayList(name, value);
7679 return this;
7680 }
7681
7682 /**
7683 * Add extended data to the intent. The name must include a package
7684 * prefix, for example the app com.android.contacts would use names
7685 * like "com.android.contacts.ShowAll".
7686 *
7687 * @param name The name of the extra data, with package prefix.
7688 * @param value The ArrayList<String> data value.
7689 *
7690 * @return Returns the same Intent object, for chaining multiple calls
7691 * into a single statement.
7692 *
7693 * @see #putExtras
7694 * @see #removeExtra
7695 * @see #getStringArrayListExtra(String)
7696 */
7697 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7698 if (mExtras == null) {
7699 mExtras = new Bundle();
7700 }
7701 mExtras.putStringArrayList(name, value);
7702 return this;
7703 }
7704
7705 /**
7706 * Add extended data to the intent. The name must include a package
7707 * prefix, for example the app com.android.contacts would use names
7708 * like "com.android.contacts.ShowAll".
7709 *
7710 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007711 * @param value The ArrayList<CharSequence> data value.
7712 *
7713 * @return Returns the same Intent object, for chaining multiple calls
7714 * into a single statement.
7715 *
7716 * @see #putExtras
7717 * @see #removeExtra
7718 * @see #getCharSequenceArrayListExtra(String)
7719 */
7720 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7721 if (mExtras == null) {
7722 mExtras = new Bundle();
7723 }
7724 mExtras.putCharSequenceArrayList(name, value);
7725 return this;
7726 }
7727
7728 /**
7729 * Add extended data to the intent. The name must include a package
7730 * prefix, for example the app com.android.contacts would use names
7731 * like "com.android.contacts.ShowAll".
7732 *
7733 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007734 * @param value The Serializable data value.
7735 *
7736 * @return Returns the same Intent object, for chaining multiple calls
7737 * into a single statement.
7738 *
7739 * @see #putExtras
7740 * @see #removeExtra
7741 * @see #getSerializableExtra(String)
7742 */
7743 public Intent putExtra(String name, Serializable value) {
7744 if (mExtras == null) {
7745 mExtras = new Bundle();
7746 }
7747 mExtras.putSerializable(name, value);
7748 return this;
7749 }
7750
7751 /**
7752 * Add extended data to the intent. The name must include a package
7753 * prefix, for example the app com.android.contacts would use names
7754 * like "com.android.contacts.ShowAll".
7755 *
7756 * @param name The name of the extra data, with package prefix.
7757 * @param value The boolean array data value.
7758 *
7759 * @return Returns the same Intent object, for chaining multiple calls
7760 * into a single statement.
7761 *
7762 * @see #putExtras
7763 * @see #removeExtra
7764 * @see #getBooleanArrayExtra(String)
7765 */
7766 public Intent putExtra(String name, boolean[] value) {
7767 if (mExtras == null) {
7768 mExtras = new Bundle();
7769 }
7770 mExtras.putBooleanArray(name, value);
7771 return this;
7772 }
7773
7774 /**
7775 * Add extended data to the intent. The name must include a package
7776 * prefix, for example the app com.android.contacts would use names
7777 * like "com.android.contacts.ShowAll".
7778 *
7779 * @param name The name of the extra data, with package prefix.
7780 * @param value The byte array data value.
7781 *
7782 * @return Returns the same Intent object, for chaining multiple calls
7783 * into a single statement.
7784 *
7785 * @see #putExtras
7786 * @see #removeExtra
7787 * @see #getByteArrayExtra(String)
7788 */
7789 public Intent putExtra(String name, byte[] value) {
7790 if (mExtras == null) {
7791 mExtras = new Bundle();
7792 }
7793 mExtras.putByteArray(name, value);
7794 return this;
7795 }
7796
7797 /**
7798 * Add extended data to the intent. The name must include a package
7799 * prefix, for example the app com.android.contacts would use names
7800 * like "com.android.contacts.ShowAll".
7801 *
7802 * @param name The name of the extra data, with package prefix.
7803 * @param value The short array data value.
7804 *
7805 * @return Returns the same Intent object, for chaining multiple calls
7806 * into a single statement.
7807 *
7808 * @see #putExtras
7809 * @see #removeExtra
7810 * @see #getShortArrayExtra(String)
7811 */
7812 public Intent putExtra(String name, short[] value) {
7813 if (mExtras == null) {
7814 mExtras = new Bundle();
7815 }
7816 mExtras.putShortArray(name, value);
7817 return this;
7818 }
7819
7820 /**
7821 * Add extended data to the intent. The name must include a package
7822 * prefix, for example the app com.android.contacts would use names
7823 * like "com.android.contacts.ShowAll".
7824 *
7825 * @param name The name of the extra data, with package prefix.
7826 * @param value The char array data value.
7827 *
7828 * @return Returns the same Intent object, for chaining multiple calls
7829 * into a single statement.
7830 *
7831 * @see #putExtras
7832 * @see #removeExtra
7833 * @see #getCharArrayExtra(String)
7834 */
7835 public Intent putExtra(String name, char[] value) {
7836 if (mExtras == null) {
7837 mExtras = new Bundle();
7838 }
7839 mExtras.putCharArray(name, value);
7840 return this;
7841 }
7842
7843 /**
7844 * Add extended data to the intent. The name must include a package
7845 * prefix, for example the app com.android.contacts would use names
7846 * like "com.android.contacts.ShowAll".
7847 *
7848 * @param name The name of the extra data, with package prefix.
7849 * @param value The int array data value.
7850 *
7851 * @return Returns the same Intent object, for chaining multiple calls
7852 * into a single statement.
7853 *
7854 * @see #putExtras
7855 * @see #removeExtra
7856 * @see #getIntArrayExtra(String)
7857 */
7858 public Intent putExtra(String name, int[] value) {
7859 if (mExtras == null) {
7860 mExtras = new Bundle();
7861 }
7862 mExtras.putIntArray(name, value);
7863 return this;
7864 }
7865
7866 /**
7867 * Add extended data to the intent. The name must include a package
7868 * prefix, for example the app com.android.contacts would use names
7869 * like "com.android.contacts.ShowAll".
7870 *
7871 * @param name The name of the extra data, with package prefix.
7872 * @param value The byte array data value.
7873 *
7874 * @return Returns the same Intent object, for chaining multiple calls
7875 * into a single statement.
7876 *
7877 * @see #putExtras
7878 * @see #removeExtra
7879 * @see #getLongArrayExtra(String)
7880 */
7881 public Intent putExtra(String name, long[] value) {
7882 if (mExtras == null) {
7883 mExtras = new Bundle();
7884 }
7885 mExtras.putLongArray(name, value);
7886 return this;
7887 }
7888
7889 /**
7890 * Add extended data to the intent. The name must include a package
7891 * prefix, for example the app com.android.contacts would use names
7892 * like "com.android.contacts.ShowAll".
7893 *
7894 * @param name The name of the extra data, with package prefix.
7895 * @param value The float array data value.
7896 *
7897 * @return Returns the same Intent object, for chaining multiple calls
7898 * into a single statement.
7899 *
7900 * @see #putExtras
7901 * @see #removeExtra
7902 * @see #getFloatArrayExtra(String)
7903 */
7904 public Intent putExtra(String name, float[] value) {
7905 if (mExtras == null) {
7906 mExtras = new Bundle();
7907 }
7908 mExtras.putFloatArray(name, value);
7909 return this;
7910 }
7911
7912 /**
7913 * Add extended data to the intent. The name must include a package
7914 * prefix, for example the app com.android.contacts would use names
7915 * like "com.android.contacts.ShowAll".
7916 *
7917 * @param name The name of the extra data, with package prefix.
7918 * @param value The double array data value.
7919 *
7920 * @return Returns the same Intent object, for chaining multiple calls
7921 * into a single statement.
7922 *
7923 * @see #putExtras
7924 * @see #removeExtra
7925 * @see #getDoubleArrayExtra(String)
7926 */
7927 public Intent putExtra(String name, double[] value) {
7928 if (mExtras == null) {
7929 mExtras = new Bundle();
7930 }
7931 mExtras.putDoubleArray(name, value);
7932 return this;
7933 }
7934
7935 /**
7936 * Add extended data to the intent. The name must include a package
7937 * prefix, for example the app com.android.contacts would use names
7938 * like "com.android.contacts.ShowAll".
7939 *
7940 * @param name The name of the extra data, with package prefix.
7941 * @param value The String array data value.
7942 *
7943 * @return Returns the same Intent object, for chaining multiple calls
7944 * into a single statement.
7945 *
7946 * @see #putExtras
7947 * @see #removeExtra
7948 * @see #getStringArrayExtra(String)
7949 */
7950 public Intent putExtra(String name, String[] value) {
7951 if (mExtras == null) {
7952 mExtras = new Bundle();
7953 }
7954 mExtras.putStringArray(name, value);
7955 return this;
7956 }
7957
7958 /**
7959 * Add extended data to the intent. The name must include a package
7960 * prefix, for example the app com.android.contacts would use names
7961 * like "com.android.contacts.ShowAll".
7962 *
7963 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007964 * @param value The CharSequence array data value.
7965 *
7966 * @return Returns the same Intent object, for chaining multiple calls
7967 * into a single statement.
7968 *
7969 * @see #putExtras
7970 * @see #removeExtra
7971 * @see #getCharSequenceArrayExtra(String)
7972 */
7973 public Intent putExtra(String name, CharSequence[] value) {
7974 if (mExtras == null) {
7975 mExtras = new Bundle();
7976 }
7977 mExtras.putCharSequenceArray(name, value);
7978 return this;
7979 }
7980
7981 /**
7982 * Add extended data to the intent. The name must include a package
7983 * prefix, for example the app com.android.contacts would use names
7984 * like "com.android.contacts.ShowAll".
7985 *
7986 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007987 * @param value The Bundle data value.
7988 *
7989 * @return Returns the same Intent object, for chaining multiple calls
7990 * into a single statement.
7991 *
7992 * @see #putExtras
7993 * @see #removeExtra
7994 * @see #getBundleExtra(String)
7995 */
7996 public Intent putExtra(String name, Bundle value) {
7997 if (mExtras == null) {
7998 mExtras = new Bundle();
7999 }
8000 mExtras.putBundle(name, value);
8001 return this;
8002 }
8003
8004 /**
8005 * Add extended data to the intent. The name must include a package
8006 * prefix, for example the app com.android.contacts would use names
8007 * like "com.android.contacts.ShowAll".
8008 *
8009 * @param name The name of the extra data, with package prefix.
8010 * @param value The IBinder data value.
8011 *
8012 * @return Returns the same Intent object, for chaining multiple calls
8013 * into a single statement.
8014 *
8015 * @see #putExtras
8016 * @see #removeExtra
8017 * @see #getIBinderExtra(String)
8018 *
8019 * @deprecated
8020 * @hide
8021 */
8022 @Deprecated
8023 public Intent putExtra(String name, IBinder value) {
8024 if (mExtras == null) {
8025 mExtras = new Bundle();
8026 }
8027 mExtras.putIBinder(name, value);
8028 return this;
8029 }
8030
8031 /**
8032 * Copy all extras in 'src' in to this intent.
8033 *
8034 * @param src Contains the extras to copy.
8035 *
8036 * @see #putExtra
8037 */
8038 public Intent putExtras(Intent src) {
8039 if (src.mExtras != null) {
8040 if (mExtras == null) {
8041 mExtras = new Bundle(src.mExtras);
8042 } else {
8043 mExtras.putAll(src.mExtras);
8044 }
8045 }
8046 return this;
8047 }
8048
8049 /**
8050 * Add a set of extended data to the intent. The keys must include a package
8051 * prefix, for example the app com.android.contacts would use names
8052 * like "com.android.contacts.ShowAll".
8053 *
8054 * @param extras The Bundle of extras to add to this intent.
8055 *
8056 * @see #putExtra
8057 * @see #removeExtra
8058 */
8059 public Intent putExtras(Bundle extras) {
8060 if (mExtras == null) {
8061 mExtras = new Bundle();
8062 }
8063 mExtras.putAll(extras);
8064 return this;
8065 }
8066
8067 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008068 * Completely replace the extras in the Intent with the extras in the
8069 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008070 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008071 * @param src The exact extras contained in this Intent are copied
8072 * into the target intent, replacing any that were previously there.
8073 */
8074 public Intent replaceExtras(Intent src) {
8075 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8076 return this;
8077 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008078
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008079 /**
8080 * Completely replace the extras in the Intent with the given Bundle of
8081 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008082 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008083 * @param extras The new set of extras in the Intent, or null to erase
8084 * all extras.
8085 */
8086 public Intent replaceExtras(Bundle extras) {
8087 mExtras = extras != null ? new Bundle(extras) : 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 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008092 * Remove extended data from the intent.
8093 *
8094 * @see #putExtra
8095 */
8096 public void removeExtra(String name) {
8097 if (mExtras != null) {
8098 mExtras.remove(name);
8099 if (mExtras.size() == 0) {
8100 mExtras = null;
8101 }
8102 }
8103 }
8104
8105 /**
8106 * Set special flags controlling how this intent is handled. Most values
8107 * here depend on the type of component being executed by the Intent,
8108 * specifically the FLAG_ACTIVITY_* flags are all for use with
8109 * {@link Context#startActivity Context.startActivity()} and the
8110 * FLAG_RECEIVER_* flags are all for use with
8111 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8112 *
Scott Main7aee61f2011-02-08 11:25:01 -08008113 * <p>See the
8114 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8115 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008116 * the behavior of your application.
8117 *
8118 * @param flags The desired flags.
8119 *
8120 * @return Returns the same Intent object, for chaining multiple calls
8121 * into a single statement.
8122 *
8123 * @see #getFlags
8124 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008125 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008126 *
8127 * @see #FLAG_GRANT_READ_URI_PERMISSION
8128 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008129 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8130 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008131 * @see #FLAG_DEBUG_LOG_RESOLUTION
8132 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008133 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008134 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008135 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008136 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008137 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8138 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008139 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008140 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008141 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008142 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008143 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008144 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008145 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008146 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8147 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008148 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008149 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008150 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008151 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8152 */
8153 public Intent setFlags(int flags) {
8154 mFlags = flags;
8155 return this;
8156 }
8157
8158 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008159 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008160 *
8161 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008162 * @return Returns the same Intent object, for chaining multiple calls into
8163 * a single statement.
8164 * @see #setFlags(int)
8165 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008166 */
8167 public Intent addFlags(int flags) {
8168 mFlags |= flags;
8169 return this;
8170 }
8171
8172 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008173 * Remove these flags from the intent.
8174 *
8175 * @param flags The flags to remove.
8176 * @see #setFlags(int)
8177 * @see #addFlags(int)
8178 */
8179 public void removeFlags(int flags) {
8180 mFlags &= ~flags;
8181 }
8182
8183 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008184 * (Usually optional) Set an explicit application package name that limits
8185 * the components this Intent will resolve to. If left to the default
8186 * value of null, all components in all applications will considered.
8187 * If non-null, the Intent can only match the components in the given
8188 * application package.
8189 *
8190 * @param packageName The name of the application package to handle the
8191 * intent, or null to allow any application package.
8192 *
8193 * @return Returns the same Intent object, for chaining multiple calls
8194 * into a single statement.
8195 *
8196 * @see #getPackage
8197 * @see #resolveActivity
8198 */
8199 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008200 if (packageName != null && mSelector != null) {
8201 throw new IllegalArgumentException(
8202 "Can't set package name when selector is already set");
8203 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008204 mPackage = packageName;
8205 return this;
8206 }
8207
8208 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008209 * (Usually optional) Explicitly set the component to handle the intent.
8210 * If left with the default value of null, the system will determine the
8211 * appropriate class to use based on the other fields (action, data,
8212 * type, categories) in the Intent. If this class is defined, the
8213 * specified class will always be used regardless of the other fields. You
8214 * should only set this value when you know you absolutely want a specific
8215 * class to be used; otherwise it is better to let the system find the
8216 * appropriate class so that you will respect the installed applications
8217 * and user preferences.
8218 *
8219 * @param component The name of the application component to handle the
8220 * intent, or null to let the system find one for you.
8221 *
8222 * @return Returns the same Intent object, for chaining multiple calls
8223 * into a single statement.
8224 *
8225 * @see #setClass
8226 * @see #setClassName(Context, String)
8227 * @see #setClassName(String, String)
8228 * @see #getComponent
8229 * @see #resolveActivity
8230 */
8231 public Intent setComponent(ComponentName component) {
8232 mComponent = component;
8233 return this;
8234 }
8235
8236 /**
8237 * Convenience for calling {@link #setComponent} with an
8238 * explicit class name.
8239 *
8240 * @param packageContext A Context of the application package implementing
8241 * this class.
8242 * @param className The name of a class inside of the application package
8243 * that will be used as the component for this Intent.
8244 *
8245 * @return Returns the same Intent object, for chaining multiple calls
8246 * into a single statement.
8247 *
8248 * @see #setComponent
8249 * @see #setClass
8250 */
8251 public Intent setClassName(Context packageContext, String className) {
8252 mComponent = new ComponentName(packageContext, className);
8253 return this;
8254 }
8255
8256 /**
8257 * Convenience for calling {@link #setComponent} with an
8258 * explicit application package name and class name.
8259 *
8260 * @param packageName The name of the package implementing the desired
8261 * component.
8262 * @param className The name of a class inside of the application package
8263 * that will be used as the component for this Intent.
8264 *
8265 * @return Returns the same Intent object, for chaining multiple calls
8266 * into a single statement.
8267 *
8268 * @see #setComponent
8269 * @see #setClass
8270 */
8271 public Intent setClassName(String packageName, String className) {
8272 mComponent = new ComponentName(packageName, className);
8273 return this;
8274 }
8275
8276 /**
8277 * Convenience for calling {@link #setComponent(ComponentName)} with the
8278 * name returned by a {@link Class} object.
8279 *
8280 * @param packageContext A Context of the application package implementing
8281 * this class.
8282 * @param cls The class name to set, equivalent to
8283 * <code>setClassName(context, cls.getName())</code>.
8284 *
8285 * @return Returns the same Intent object, for chaining multiple calls
8286 * into a single statement.
8287 *
8288 * @see #setComponent
8289 */
8290 public Intent setClass(Context packageContext, Class<?> cls) {
8291 mComponent = new ComponentName(packageContext, cls);
8292 return this;
8293 }
8294
8295 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008296 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8297 * used as a hint to the receiver for animations and the like. Null means that there
8298 * is no source bounds.
8299 */
8300 public void setSourceBounds(Rect r) {
8301 if (r != null) {
8302 mSourceBounds = new Rect(r);
8303 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008304 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008305 }
8306 }
8307
Tor Norbyed9273d62013-05-30 15:59:53 -07008308 /** @hide */
8309 @IntDef(flag = true,
8310 value = {
8311 FILL_IN_ACTION,
8312 FILL_IN_DATA,
8313 FILL_IN_CATEGORIES,
8314 FILL_IN_COMPONENT,
8315 FILL_IN_PACKAGE,
8316 FILL_IN_SOURCE_BOUNDS,
8317 FILL_IN_SELECTOR,
8318 FILL_IN_CLIP_DATA
8319 })
8320 @Retention(RetentionPolicy.SOURCE)
8321 public @interface FillInFlags {}
8322
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008323 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008324 * Use with {@link #fillIn} to allow the current action value to be
8325 * overwritten, even if it is already set.
8326 */
8327 public static final int FILL_IN_ACTION = 1<<0;
8328
8329 /**
8330 * Use with {@link #fillIn} to allow the current data or type value
8331 * overwritten, even if it is already set.
8332 */
8333 public static final int FILL_IN_DATA = 1<<1;
8334
8335 /**
8336 * Use with {@link #fillIn} to allow the current categories to be
8337 * overwritten, even if they are already set.
8338 */
8339 public static final int FILL_IN_CATEGORIES = 1<<2;
8340
8341 /**
8342 * Use with {@link #fillIn} to allow the current component value to be
8343 * overwritten, even if it is already set.
8344 */
8345 public static final int FILL_IN_COMPONENT = 1<<3;
8346
8347 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008348 * Use with {@link #fillIn} to allow the current package value to be
8349 * overwritten, even if it is already set.
8350 */
8351 public static final int FILL_IN_PACKAGE = 1<<4;
8352
8353 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008354 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008355 * overwritten, even if it is already set.
8356 */
8357 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8358
8359 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008360 * Use with {@link #fillIn} to allow the current selector to be
8361 * overwritten, even if it is already set.
8362 */
8363 public static final int FILL_IN_SELECTOR = 1<<6;
8364
8365 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008366 * Use with {@link #fillIn} to allow the current ClipData to be
8367 * overwritten, even if it is already set.
8368 */
8369 public static final int FILL_IN_CLIP_DATA = 1<<7;
8370
8371 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008372 * Copy the contents of <var>other</var> in to this object, but only
8373 * where fields are not defined by this object. For purposes of a field
8374 * being defined, the following pieces of data in the Intent are
8375 * considered to be separate fields:
8376 *
8377 * <ul>
8378 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008379 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008380 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8381 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008382 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008383 * <li> component, as set by {@link #setComponent(ComponentName)} or
8384 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008385 * <li> source bounds, as set by {@link #setSourceBounds}.
8386 * <li> selector, as set by {@link #setSelector(Intent)}.
8387 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008388 * <li> each top-level name in the associated extras.
8389 * </ul>
8390 *
8391 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008392 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008393 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8394 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8395 * the restriction where the corresponding field will not be replaced if
8396 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008397 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008398 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8399 * is explicitly specified. The selector will only be copied if
8400 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008401 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008402 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8403 * and Intent B with {action="gotit", data-type="some/thing",
8404 * categories="one","two"}.
8405 *
8406 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8407 * containing: {action="gotit", data-type="some/thing",
8408 * categories="bar"}.
8409 *
8410 * @param other Another Intent whose values are to be used to fill in
8411 * the current one.
8412 * @param flags Options to control which fields can be filled in.
8413 *
8414 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008415 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008416 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008417 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008418 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008419 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008420 @FillInFlags
8421 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008422 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008423 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008424 if (other.mAction != null
8425 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008426 mAction = other.mAction;
8427 changes |= FILL_IN_ACTION;
8428 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008429 if ((other.mData != null || other.mType != null)
8430 && ((mData == null && mType == null)
8431 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008432 mData = other.mData;
8433 mType = other.mType;
8434 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008435 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008436 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008437 if (other.mCategories != null
8438 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008439 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008440 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008441 }
8442 changes |= FILL_IN_CATEGORIES;
8443 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008444 if (other.mPackage != null
8445 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008446 // Only do this if mSelector is not set.
8447 if (mSelector == null) {
8448 mPackage = other.mPackage;
8449 changes |= FILL_IN_PACKAGE;
8450 }
8451 }
8452 // Selector is special: it can only be set if explicitly allowed,
8453 // for the same reason as the component name.
8454 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8455 if (mPackage == null) {
8456 mSelector = new Intent(other.mSelector);
8457 mPackage = null;
8458 changes |= FILL_IN_SELECTOR;
8459 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008460 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008461 if (other.mClipData != null
8462 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8463 mClipData = other.mClipData;
8464 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008465 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008466 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008467 // Component is special: it can -only- be set if explicitly allowed,
8468 // since otherwise the sender could force the intent somewhere the
8469 // originator didn't intend.
8470 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008471 mComponent = other.mComponent;
8472 changes |= FILL_IN_COMPONENT;
8473 }
8474 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008475 if (other.mSourceBounds != null
8476 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8477 mSourceBounds = new Rect(other.mSourceBounds);
8478 changes |= FILL_IN_SOURCE_BOUNDS;
8479 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008480 if (mExtras == null) {
8481 if (other.mExtras != null) {
8482 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008483 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008484 }
8485 } else if (other.mExtras != null) {
8486 try {
8487 Bundle newb = new Bundle(other.mExtras);
8488 newb.putAll(mExtras);
8489 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008490 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008491 } catch (RuntimeException e) {
8492 // Modifying the extras can cause us to unparcel the contents
8493 // of the bundle, and if we do this in the system process that
8494 // may fail. We really should handle this (i.e., the Bundle
8495 // impl shouldn't be on top of a plain map), but for now just
8496 // ignore it and keep the original contents. :(
8497 Log.w("Intent", "Failure filling in extras", e);
8498 }
8499 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008500 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8501 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8502 mContentUserHint = other.mContentUserHint;
8503 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008504 return changes;
8505 }
8506
8507 /**
8508 * Wrapper class holding an Intent and implementing comparisons on it for
8509 * the purpose of filtering. The class implements its
8510 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8511 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8512 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8513 * on the wrapped Intent.
8514 */
8515 public static final class FilterComparison {
8516 private final Intent mIntent;
8517 private final int mHashCode;
8518
8519 public FilterComparison(Intent intent) {
8520 mIntent = intent;
8521 mHashCode = intent.filterHashCode();
8522 }
8523
8524 /**
8525 * Return the Intent that this FilterComparison represents.
8526 * @return Returns the Intent held by the FilterComparison. Do
8527 * not modify!
8528 */
8529 public Intent getIntent() {
8530 return mIntent;
8531 }
8532
8533 @Override
8534 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008535 if (obj instanceof FilterComparison) {
8536 Intent other = ((FilterComparison)obj).mIntent;
8537 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008538 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008539 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008540 }
8541
8542 @Override
8543 public int hashCode() {
8544 return mHashCode;
8545 }
8546 }
8547
8548 /**
8549 * Determine if two intents are the same for the purposes of intent
8550 * resolution (filtering). That is, if their action, data, type,
8551 * class, and categories are the same. This does <em>not</em> compare
8552 * any extra data included in the intents.
8553 *
8554 * @param other The other Intent to compare against.
8555 *
8556 * @return Returns true if action, data, type, class, and categories
8557 * are the same.
8558 */
8559 public boolean filterEquals(Intent other) {
8560 if (other == null) {
8561 return false;
8562 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008563 if (!Objects.equals(this.mAction, other.mAction)) return false;
8564 if (!Objects.equals(this.mData, other.mData)) return false;
8565 if (!Objects.equals(this.mType, other.mType)) return false;
8566 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8567 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8568 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008569
8570 return true;
8571 }
8572
8573 /**
8574 * Generate hash code that matches semantics of filterEquals().
8575 *
8576 * @return Returns the hash value of the action, data, type, class, and
8577 * categories.
8578 *
8579 * @see #filterEquals
8580 */
8581 public int filterHashCode() {
8582 int code = 0;
8583 if (mAction != null) {
8584 code += mAction.hashCode();
8585 }
8586 if (mData != null) {
8587 code += mData.hashCode();
8588 }
8589 if (mType != null) {
8590 code += mType.hashCode();
8591 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008592 if (mPackage != null) {
8593 code += mPackage.hashCode();
8594 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008595 if (mComponent != null) {
8596 code += mComponent.hashCode();
8597 }
8598 if (mCategories != null) {
8599 code += mCategories.hashCode();
8600 }
8601 return code;
8602 }
8603
8604 @Override
8605 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008606 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008607
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008608 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008609 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008610 b.append(" }");
8611
8612 return b.toString();
8613 }
8614
8615 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008616 public String toInsecureString() {
8617 StringBuilder b = new StringBuilder(128);
8618
8619 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008620 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008621 b.append(" }");
8622
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008623 return b.toString();
8624 }
Romain Guy4969af72009-06-17 10:53:19 -07008625
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008626 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008627 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008628 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008629
8630 b.append("Intent { ");
8631 toShortString(b, false, true, true, true);
8632 b.append(" }");
8633
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008634 return b.toString();
8635 }
8636
8637 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008638 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8639 StringBuilder b = new StringBuilder(128);
8640 toShortString(b, secure, comp, extras, clip);
8641 return b.toString();
8642 }
8643
8644 /** @hide */
8645 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8646 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008647 boolean first = true;
8648 if (mAction != null) {
8649 b.append("act=").append(mAction);
8650 first = false;
8651 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008652 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008653 if (!first) {
8654 b.append(' ');
8655 }
8656 first = false;
8657 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008658 for (int i=0; i<mCategories.size(); i++) {
8659 if (i > 0) b.append(',');
8660 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008661 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008662 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008663 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008664 if (mData != null) {
8665 if (!first) {
8666 b.append(' ');
8667 }
8668 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008669 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008670 if (secure) {
8671 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008672 } else {
8673 b.append(mData);
8674 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008675 }
8676 if (mType != null) {
8677 if (!first) {
8678 b.append(' ');
8679 }
8680 first = false;
8681 b.append("typ=").append(mType);
8682 }
8683 if (mFlags != 0) {
8684 if (!first) {
8685 b.append(' ');
8686 }
8687 first = false;
8688 b.append("flg=0x").append(Integer.toHexString(mFlags));
8689 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008690 if (mPackage != null) {
8691 if (!first) {
8692 b.append(' ');
8693 }
8694 first = false;
8695 b.append("pkg=").append(mPackage);
8696 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008697 if (comp && mComponent != null) {
8698 if (!first) {
8699 b.append(' ');
8700 }
8701 first = false;
8702 b.append("cmp=").append(mComponent.flattenToShortString());
8703 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008704 if (mSourceBounds != null) {
8705 if (!first) {
8706 b.append(' ');
8707 }
8708 first = false;
8709 b.append("bnds=").append(mSourceBounds.toShortString());
8710 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008711 if (mClipData != null) {
8712 if (!first) {
8713 b.append(' ');
8714 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008715 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008716 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008717 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008718 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008719 if (mClipData.getDescription() != null) {
8720 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8721 } else {
8722 first = true;
8723 }
8724 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008725 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008726 first = false;
8727 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008728 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008729 if (extras && mExtras != null) {
8730 if (!first) {
8731 b.append(' ');
8732 }
8733 first = false;
8734 b.append("(has extras)");
8735 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008736 if (mContentUserHint != UserHandle.USER_CURRENT) {
8737 if (!first) {
8738 b.append(' ');
8739 }
8740 first = false;
8741 b.append("u=").append(mContentUserHint);
8742 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008743 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008744 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008745 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008746 b.append("}");
8747 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008748 }
8749
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008750 /**
8751 * Call {@link #toUri} with 0 flags.
8752 * @deprecated Use {@link #toUri} instead.
8753 */
8754 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008755 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008756 return toUri(0);
8757 }
8758
8759 /**
8760 * Convert this Intent into a String holding a URI representation of it.
8761 * The returned URI string has been properly URI encoded, so it can be
8762 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8763 * Intent's data as the base URI, with an additional fragment describing
8764 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008765 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008766 * <p>You can convert the returned string back to an Intent with
8767 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008768 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008769 * @param flags Additional operating flags. Either 0,
8770 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008771 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008772 * @return Returns a URI encoding URI string describing the entire contents
8773 * of the Intent.
8774 */
8775 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008776 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008777 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8778 if (mPackage == null) {
8779 throw new IllegalArgumentException(
8780 "Intent must include an explicit package name to build an android-app: "
8781 + this);
8782 }
8783 uri.append("android-app://");
8784 uri.append(mPackage);
8785 String scheme = null;
8786 if (mData != null) {
8787 scheme = mData.getScheme();
8788 if (scheme != null) {
8789 uri.append('/');
8790 uri.append(scheme);
8791 String authority = mData.getEncodedAuthority();
8792 if (authority != null) {
8793 uri.append('/');
8794 uri.append(authority);
8795 String path = mData.getEncodedPath();
8796 if (path != null) {
8797 uri.append(path);
8798 }
8799 String queryParams = mData.getEncodedQuery();
8800 if (queryParams != null) {
8801 uri.append('?');
8802 uri.append(queryParams);
8803 }
8804 String fragment = mData.getEncodedFragment();
8805 if (fragment != null) {
8806 uri.append('#');
8807 uri.append(fragment);
8808 }
8809 }
8810 }
8811 }
8812 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8813 mPackage, flags);
8814 return uri.toString();
8815 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008816 String scheme = null;
8817 if (mData != null) {
8818 String data = mData.toString();
8819 if ((flags&URI_INTENT_SCHEME) != 0) {
8820 final int N = data.length();
8821 for (int i=0; i<N; i++) {
8822 char c = data.charAt(i);
8823 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8824 || c == '.' || c == '-') {
8825 continue;
8826 }
8827 if (c == ':' && i > 0) {
8828 // Valid scheme.
8829 scheme = data.substring(0, i);
8830 uri.append("intent:");
8831 data = data.substring(i+1);
8832 break;
8833 }
Tom Taylord4a47292009-12-21 13:59:18 -08008834
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008835 // No scheme.
8836 break;
8837 }
8838 }
8839 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008840
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008841 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8842 uri.append("intent:");
8843 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008844
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008845 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008846
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008847 return uri.toString();
8848 }
8849
8850 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8851 String defPackage, int flags) {
8852 StringBuilder frag = new StringBuilder(128);
8853
8854 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008855 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008856 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008857 // Note that for now we are not going to try to handle the
8858 // data part; not clear how to represent this as a URI, and
8859 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008860 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8861 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008862 }
8863
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008864 if (frag.length() > 0) {
8865 uri.append("#Intent;");
8866 uri.append(frag);
8867 uri.append("end");
8868 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008869 }
8870
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008871 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8872 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008873 if (scheme != null) {
8874 uri.append("scheme=").append(scheme).append(';');
8875 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008876 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008877 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008878 }
8879 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008880 for (int i=0; i<mCategories.size(); i++) {
8881 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008882 }
8883 }
8884 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008885 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008886 }
8887 if (mFlags != 0) {
8888 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8889 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008890 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008891 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8892 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008893 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008894 uri.append("component=").append(Uri.encode(
8895 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008896 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008897 if (mSourceBounds != null) {
8898 uri.append("sourceBounds=")
8899 .append(Uri.encode(mSourceBounds.flattenToString()))
8900 .append(';');
8901 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008902 if (mExtras != null) {
8903 for (String key : mExtras.keySet()) {
8904 final Object value = mExtras.get(key);
8905 char entryType =
8906 value instanceof String ? 'S' :
8907 value instanceof Boolean ? 'B' :
8908 value instanceof Byte ? 'b' :
8909 value instanceof Character ? 'c' :
8910 value instanceof Double ? 'd' :
8911 value instanceof Float ? 'f' :
8912 value instanceof Integer ? 'i' :
8913 value instanceof Long ? 'l' :
8914 value instanceof Short ? 's' :
8915 '\0';
8916
8917 if (entryType != '\0') {
8918 uri.append(entryType);
8919 uri.append('.');
8920 uri.append(Uri.encode(key));
8921 uri.append('=');
8922 uri.append(Uri.encode(value.toString()));
8923 uri.append(';');
8924 }
8925 }
8926 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008927 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008928
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008929 public int describeContents() {
8930 return (mExtras != null) ? mExtras.describeContents() : 0;
8931 }
8932
8933 public void writeToParcel(Parcel out, int flags) {
8934 out.writeString(mAction);
8935 Uri.writeToParcel(out, mData);
8936 out.writeString(mType);
8937 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008938 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008939 ComponentName.writeToParcel(mComponent, out);
8940
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008941 if (mSourceBounds != null) {
8942 out.writeInt(1);
8943 mSourceBounds.writeToParcel(out, flags);
8944 } else {
8945 out.writeInt(0);
8946 }
8947
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008948 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008949 final int N = mCategories.size();
8950 out.writeInt(N);
8951 for (int i=0; i<N; i++) {
8952 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008953 }
8954 } else {
8955 out.writeInt(0);
8956 }
8957
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008958 if (mSelector != null) {
8959 out.writeInt(1);
8960 mSelector.writeToParcel(out, flags);
8961 } else {
8962 out.writeInt(0);
8963 }
8964
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008965 if (mClipData != null) {
8966 out.writeInt(1);
8967 mClipData.writeToParcel(out, flags);
8968 } else {
8969 out.writeInt(0);
8970 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008971 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008972 out.writeBundle(mExtras);
8973 }
8974
8975 public static final Parcelable.Creator<Intent> CREATOR
8976 = new Parcelable.Creator<Intent>() {
8977 public Intent createFromParcel(Parcel in) {
8978 return new Intent(in);
8979 }
8980 public Intent[] newArray(int size) {
8981 return new Intent[size];
8982 }
8983 };
8984
Dianne Hackborneb034652009-09-07 00:49:58 -07008985 /** @hide */
8986 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008987 readFromParcel(in);
8988 }
8989
8990 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008991 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008992 mData = Uri.CREATOR.createFromParcel(in);
8993 mType = in.readString();
8994 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008995 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008996 mComponent = ComponentName.readFromParcel(in);
8997
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008998 if (in.readInt() != 0) {
8999 mSourceBounds = Rect.CREATOR.createFromParcel(in);
9000 }
9001
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009002 int N = in.readInt();
9003 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07009004 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009005 int i;
9006 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08009007 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009008 }
9009 } else {
9010 mCategories = null;
9011 }
9012
Dianne Hackbornf5b86712011-12-05 17:42:41 -08009013 if (in.readInt() != 0) {
9014 mSelector = new Intent(in);
9015 }
9016
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009017 if (in.readInt() != 0) {
9018 mClipData = new ClipData(in);
9019 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009020 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009021 mExtras = in.readBundle();
9022 }
9023
9024 /**
9025 * Parses the "intent" element (and its children) from XML and instantiates
9026 * an Intent object. The given XML parser should be located at the tag
9027 * where parsing should start (often named "intent"), from which the
9028 * basic action, data, type, and package and class name will be
9029 * retrieved. The function will then parse in to any child elements,
9030 * looking for <category android:name="xxx"> tags to add categories and
9031 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9032 * to the intent.
9033 *
9034 * @param resources The Resources to use when inflating resources.
9035 * @param parser The XML parser pointing at an "intent" tag.
9036 * @param attrs The AttributeSet interface for retrieving extended
9037 * attribute data at the current <var>parser</var> location.
9038 * @return An Intent object matching the XML data.
9039 * @throws XmlPullParserException If there was an XML parsing error.
9040 * @throws IOException If there was an I/O error.
9041 */
9042 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
9043 throws XmlPullParserException, IOException {
9044 Intent intent = new Intent();
9045
9046 TypedArray sa = resources.obtainAttributes(attrs,
9047 com.android.internal.R.styleable.Intent);
9048
9049 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9050
9051 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9052 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9053 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9054
9055 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9056 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9057 if (packageName != null && className != null) {
9058 intent.setComponent(new ComponentName(packageName, className));
9059 }
9060
9061 sa.recycle();
9062
9063 int outerDepth = parser.getDepth();
9064 int type;
9065 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9066 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9067 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9068 continue;
9069 }
9070
9071 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009072 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009073 sa = resources.obtainAttributes(attrs,
9074 com.android.internal.R.styleable.IntentCategory);
9075 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9076 sa.recycle();
9077
9078 if (cat != null) {
9079 intent.addCategory(cat);
9080 }
9081 XmlUtils.skipCurrentTag(parser);
9082
Craig Mautner21d24a22014-04-23 11:45:37 -07009083 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009084 if (intent.mExtras == null) {
9085 intent.mExtras = new Bundle();
9086 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009087 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009088 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009089
9090 } else {
9091 XmlUtils.skipCurrentTag(parser);
9092 }
9093 }
9094
9095 return intent;
9096 }
Nick Pellyccae4122012-01-09 14:12:58 -08009097
Craig Mautner21d24a22014-04-23 11:45:37 -07009098 /** @hide */
9099 public void saveToXml(XmlSerializer out) throws IOException {
9100 if (mAction != null) {
9101 out.attribute(null, ATTR_ACTION, mAction);
9102 }
9103 if (mData != null) {
9104 out.attribute(null, ATTR_DATA, mData.toString());
9105 }
9106 if (mType != null) {
9107 out.attribute(null, ATTR_TYPE, mType);
9108 }
9109 if (mComponent != null) {
9110 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9111 }
9112 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9113
9114 if (mCategories != null) {
9115 out.startTag(null, TAG_CATEGORIES);
9116 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9117 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9118 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009119 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009120 }
9121 }
9122
9123 /** @hide */
9124 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9125 XmlPullParserException {
9126 Intent intent = new Intent();
9127 final int outerDepth = in.getDepth();
9128
9129 int attrCount = in.getAttributeCount();
9130 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9131 final String attrName = in.getAttributeName(attrNdx);
9132 final String attrValue = in.getAttributeValue(attrNdx);
9133 if (ATTR_ACTION.equals(attrName)) {
9134 intent.setAction(attrValue);
9135 } else if (ATTR_DATA.equals(attrName)) {
9136 intent.setData(Uri.parse(attrValue));
9137 } else if (ATTR_TYPE.equals(attrName)) {
9138 intent.setType(attrValue);
9139 } else if (ATTR_COMPONENT.equals(attrName)) {
9140 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9141 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009142 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009143 } else {
9144 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9145 }
9146 }
9147
9148 int event;
9149 String name;
9150 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9151 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9152 if (event == XmlPullParser.START_TAG) {
9153 name = in.getName();
9154 if (TAG_CATEGORIES.equals(name)) {
9155 attrCount = in.getAttributeCount();
9156 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9157 intent.addCategory(in.getAttributeValue(attrNdx));
9158 }
9159 } else {
9160 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9161 XmlUtils.skipCurrentTag(in);
9162 }
9163 }
9164 }
9165
9166 return intent;
9167 }
9168
Nick Pellyccae4122012-01-09 14:12:58 -08009169 /**
9170 * Normalize a MIME data type.
9171 *
9172 * <p>A normalized MIME type has white-space trimmed,
9173 * content-type parameters removed, and is lower-case.
9174 * This aligns the type with Android best practices for
9175 * intent filtering.
9176 *
9177 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9178 * "text/x-vCard" becomes "text/x-vcard".
9179 *
9180 * <p>All MIME types received from outside Android (such as user input,
9181 * or external sources like Bluetooth, NFC, or the Internet) should
9182 * be normalized before they are used to create an Intent.
9183 *
9184 * @param type MIME data type to normalize
9185 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009186 * @see #setType
9187 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009188 */
9189 public static String normalizeMimeType(String type) {
9190 if (type == null) {
9191 return null;
9192 }
9193
Elliott Hughescb64d432013-08-02 10:00:44 -07009194 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009195
9196 final int semicolonIndex = type.indexOf(';');
9197 if (semicolonIndex != -1) {
9198 type = type.substring(0, semicolonIndex);
9199 }
9200 return type;
9201 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009202
9203 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009204 * Prepare this {@link Intent} to leave an app process.
9205 *
9206 * @hide
9207 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009208 public void prepareToLeaveProcess(Context context) {
9209 final boolean leavingPackage = (mComponent == null)
9210 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9211 prepareToLeaveProcess(leavingPackage);
9212 }
9213
9214 /**
9215 * Prepare this {@link Intent} to leave an app process.
9216 *
9217 * @hide
9218 */
9219 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009220 setAllowFds(false);
9221
9222 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009223 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009224 }
9225 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009226 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009227 }
9228
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009229 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9230 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009231 switch (mAction) {
9232 case ACTION_MEDIA_REMOVED:
9233 case ACTION_MEDIA_UNMOUNTED:
9234 case ACTION_MEDIA_CHECKING:
9235 case ACTION_MEDIA_NOFS:
9236 case ACTION_MEDIA_MOUNTED:
9237 case ACTION_MEDIA_SHARED:
9238 case ACTION_MEDIA_UNSHARED:
9239 case ACTION_MEDIA_BAD_REMOVAL:
9240 case ACTION_MEDIA_UNMOUNTABLE:
9241 case ACTION_MEDIA_EJECT:
9242 case ACTION_MEDIA_SCANNER_STARTED:
9243 case ACTION_MEDIA_SCANNER_FINISHED:
9244 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009245 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9246 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009247 // Ignore legacy actions
9248 break;
9249 default:
9250 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009251 }
9252 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009253
9254 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9255 && leavingPackage) {
9256 switch (mAction) {
9257 case ACTION_PROVIDER_CHANGED:
9258 // Ignore actions that don't need to grant
9259 break;
9260 default:
9261 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9262 }
9263 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009264 }
9265
9266 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009267 * @hide
9268 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009269 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009270 // We just entered destination process, so we should be able to read all
9271 // parcelables inside.
9272 setDefusable(true);
9273
9274 if (mSelector != null) {
9275 mSelector.prepareToEnterProcess();
9276 }
9277 if (mClipData != null) {
9278 mClipData.prepareToEnterProcess();
9279 }
9280
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009281 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009282 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9283 fixUris(mContentUserHint);
9284 mContentUserHint = UserHandle.USER_CURRENT;
9285 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009286 }
9287 }
9288
9289 /**
9290 * @hide
9291 */
9292 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009293 Uri data = getData();
9294 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009295 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009296 }
9297 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009298 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009299 }
9300 String action = getAction();
9301 if (ACTION_SEND.equals(action)) {
9302 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9303 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009304 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009305 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009306 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009307 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9308 if (streams != null) {
9309 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9310 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009311 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009312 }
9313 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9314 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009315 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9316 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9317 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9318 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9319 if (output != null) {
9320 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9321 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009322 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009323 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009324
9325 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009326 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009327 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9328 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009329 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009330 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009331 * @hide
9332 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009333 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009334 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009335 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009336
9337 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009338 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009339
9340 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009341 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009342 // Inspect contained intents to see if we need to migrate extras. We
9343 // don't promote ClipData to the parent, since ChooserActivity will
9344 // already start the picked item as the caller, and we can't combine
9345 // the flags in a safe way.
9346
9347 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009348 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009349 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9350 if (intent != null) {
9351 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009352 }
9353 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009354 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009355 try {
9356 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9357 if (intents != null) {
9358 for (int i = 0; i < intents.length; i++) {
9359 final Intent intent = (Intent) intents[i];
9360 if (intent != null) {
9361 migrated |= intent.migrateExtraStreamToClipData();
9362 }
9363 }
9364 }
9365 } catch (ClassCastException e) {
9366 }
9367 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009368
9369 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009370 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009371 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9372 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9373 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9374 if (stream != null || text != null || htmlText != null) {
9375 final ClipData clipData = new ClipData(
9376 null, new String[] { getType() },
9377 new ClipData.Item(text, htmlText, null, stream));
9378 setClipData(clipData);
9379 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009380 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009381 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009382 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009383 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009384
9385 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009386 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009387 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9388 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9389 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9390 int num = -1;
9391 if (streams != null) {
9392 num = streams.size();
9393 }
9394 if (texts != null) {
9395 if (num >= 0 && num != texts.size()) {
9396 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009397 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009398 }
9399 num = texts.size();
9400 }
9401 if (htmlTexts != null) {
9402 if (num >= 0 && num != htmlTexts.size()) {
9403 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009404 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009405 }
9406 num = htmlTexts.size();
9407 }
9408 if (num > 0) {
9409 final ClipData clipData = new ClipData(
9410 null, new String[] { getType() },
9411 makeClipItem(streams, texts, htmlTexts, 0));
9412
9413 for (int i = 1; i < num; i++) {
9414 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9415 }
9416
9417 setClipData(clipData);
9418 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009419 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009420 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009421 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009422 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009423 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9424 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9425 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9426 final Uri output;
9427 try {
9428 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9429 } catch (ClassCastException e) {
9430 return false;
9431 }
9432 if (output != null) {
9433 setClipData(ClipData.newRawUri("", output));
9434 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9435 return true;
9436 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009437 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009438
9439 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009440 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009441
9442 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9443 ArrayList<String> htmlTexts, int which) {
9444 Uri uri = streams != null ? streams.get(which) : null;
9445 CharSequence text = texts != null ? texts.get(which) : null;
9446 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9447 return new ClipData.Item(text, htmlText, null, uri);
9448 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009449
9450 /** @hide */
9451 public boolean isDocument() {
9452 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9453 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009454}