blob: 6a0da33c04a73555a8a0bd2dbd917f7409890a40 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700118 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700189 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700342 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700361 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
Zak Cohendb6ca492017-01-26 14:09:00 -0800572 * <li> {@link #CATEGORY_VR_HOME}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700573 * </ul>
574 *
575 * <h3>Standard Extra Data</h3>
576 *
577 * <p>These are the current standard fields that can be used as extra data via
578 * {@link #putExtra}.
579 *
580 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800581 * <li> {@link #EXTRA_ALARM_COUNT}
582 * <li> {@link #EXTRA_BCC}
583 * <li> {@link #EXTRA_CC}
584 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
585 * <li> {@link #EXTRA_DATA_REMOVED}
586 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500587 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
588 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_DOCK_STATE_CAR}
590 * <li> {@link #EXTRA_DOCK_STATE_DESK}
591 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
592 * <li> {@link #EXTRA_DONT_KILL_APP}
593 * <li> {@link #EXTRA_EMAIL}
594 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800596 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700597 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800598 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700599 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
601 * <li> {@link #EXTRA_REPLACING}
602 * <li> {@link #EXTRA_SHORTCUT_ICON}
603 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
604 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800606 * <li> {@link #EXTRA_SHORTCUT_NAME}
607 * <li> {@link #EXTRA_SUBJECT}
608 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700609 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800610 * <li> {@link #EXTRA_TITLE}
611 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * </ul>
613 *
614 * <h3>Flags</h3>
615 *
616 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800617 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
618 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800620public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700621 private static final String ATTR_ACTION = "action";
622 private static final String TAG_CATEGORIES = "categories";
623 private static final String ATTR_CATEGORY = "category";
624 private static final String TAG_EXTRA = "extra";
625 private static final String ATTR_TYPE = "type";
626 private static final String ATTR_COMPONENT = "component";
627 private static final String ATTR_DATA = "data";
628 private static final String ATTR_FLAGS = "flags";
629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 // ---------------------------------------------------------------------
631 // ---------------------------------------------------------------------
632 // Standard intent activity actions (see action variable).
633
634 /**
635 * Activity Action: Start as a main entry point, does not expect to
636 * receive data.
637 * <p>Input: nothing
638 * <p>Output: nothing
639 */
640 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
641 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700643 /**
644 * Activity Action: Display the data to the user. This is the most common
645 * action performed on data -- it is the generic action you can use on
646 * a piece of data to get the most reasonable thing to occur. For example,
647 * when used on a contacts entry it will view the entry; when used on a
648 * mailto: URI it will bring up a compose window filled with the information
649 * supplied by the URI; when used with a tel: URI it will invoke the
650 * dialer.
651 * <p>Input: {@link #getData} is URI from which to retrieve data.
652 * <p>Output: nothing.
653 */
654 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
655 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700657 /**
658 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
659 * performed on a piece of data.
660 */
661 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900664 * Activity Action: Quick view the data. Launches a quick viewer for
665 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900666 * <p>Activities handling this intent action should handle the vast majority of
667 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900668 * <p>Input: {@link #getData} is a mandatory content URI of the item to
669 * preview. {@link #getClipData} contains an optional list of content URIs
670 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
671 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700672 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700673 */
674 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
675 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
676
677 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 * Used to indicate that some piece of data should be attached to some other
679 * place. For example, image data could be attached to a contact. It is up
680 * to the recipient to decide where the data should be attached; the intent
681 * does not specify the ultimate destination.
682 * <p>Input: {@link #getData} is URI of data to be attached.
683 * <p>Output: nothing.
684 */
685 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
686 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800687
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700688 /**
689 * Activity Action: Provide explicit editable access to the given data.
690 * <p>Input: {@link #getData} is URI of data to be edited.
691 * <p>Output: nothing.
692 */
693 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
694 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700696 /**
697 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
698 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
699 * The extras can contain type specific data to pass through to the editing/creating
700 * activity.
701 * <p>Output: The URI of the item that was picked. This must be a content:
702 * URI so that any receiver can access it.
703 */
704 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
705 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800706
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700707 /**
708 * Activity Action: Pick an item from the data, returning what was selected.
709 * <p>Input: {@link #getData} is URI containing a directory of data
710 * (vnd.android.cursor.dir/*) from which to pick an item.
711 * <p>Output: The URI of the item that was picked.
712 */
713 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
714 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800715
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700716 /**
717 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * <p>Input: Nothing.</p>
Sunny Goyala6be88a2017-01-12 16:27:58 -0800719 * <p>Output: An Intent representing the {@link android.content.pm.ShortcutInfo} result.</p>
720 * <p>For compatibility with older versions of android the intent may also contain three
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700721 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
722 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800723 * (value: ShortcutIconResource).</p>
724 *
Sunny Goyala6be88a2017-01-12 16:27:58 -0800725 * @see android.content.pm.ShortcutManager#createShortcutResultIntent
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700726 * @see #EXTRA_SHORTCUT_INTENT
727 * @see #EXTRA_SHORTCUT_NAME
728 * @see #EXTRA_SHORTCUT_ICON
729 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
730 * @see android.content.Intent.ShortcutIconResource
731 */
732 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
733 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
734
735 /**
736 * The name of the extra used to define the Intent of a shortcut.
737 *
738 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800739 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700740 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800741 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700742 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
743 /**
744 * The name of the extra used to define the name of a shortcut.
745 *
746 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800747 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700748 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800749 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700750 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
751 /**
752 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
753 *
754 * @see #ACTION_CREATE_SHORTCUT
Sunny Goyala6be88a2017-01-12 16:27:58 -0800755 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700756 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800757 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700758 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
759 /**
760 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
761 *
762 * @see #ACTION_CREATE_SHORTCUT
763 * @see android.content.Intent.ShortcutIconResource
Sunny Goyala6be88a2017-01-12 16:27:58 -0800764 * @deprecated Replaced with {@link android.content.pm.ShortcutManager#createShortcutResultIntent}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700765 */
Sunny Goyala6be88a2017-01-12 16:27:58 -0800766 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700767 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
768 "android.intent.extra.shortcut.ICON_RESOURCE";
769
770 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500771 * An activity that provides a user interface for adjusting application preferences.
772 * Optional but recommended settings for all applications which have settings.
773 */
774 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
775 public static final String ACTION_APPLICATION_PREFERENCES
776 = "android.intent.action.APPLICATION_PREFERENCES";
777
778 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700779 * Activity Action: Launch an activity showing the app information.
780 * For applications which install other applications (such as app stores), it is recommended
781 * to handle this action for providing the app information to the user.
782 *
783 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
784 * to be displayed.
785 * <p>Output: Nothing.
786 */
787 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
788 public static final String ACTION_SHOW_APP_INFO
789 = "android.intent.action.SHOW_APP_INFO";
790
791 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800792 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700793 *
794 * @see Intent#ACTION_CREATE_SHORTCUT
795 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800796 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
797 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700798 */
799 public static class ShortcutIconResource implements Parcelable {
800 /**
801 * The package name of the application containing the icon.
802 */
803 public String packageName;
804
805 /**
806 * The resource name of the icon, including package, name and type.
807 */
808 public String resourceName;
809
810 /**
811 * Creates a new ShortcutIconResource for the specified context and resource
812 * identifier.
813 *
814 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700815 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700816 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700817 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700818 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700819 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 ShortcutIconResource icon = new ShortcutIconResource();
821 icon.packageName = context.getPackageName();
822 icon.resourceName = context.getResources().getResourceName(resourceId);
823 return icon;
824 }
825
826 /**
827 * Used to read a ShortcutIconResource from a Parcel.
828 */
829 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
830 new Parcelable.Creator<ShortcutIconResource>() {
831
832 public ShortcutIconResource createFromParcel(Parcel source) {
833 ShortcutIconResource icon = new ShortcutIconResource();
834 icon.packageName = source.readString();
835 icon.resourceName = source.readString();
836 return icon;
837 }
838
839 public ShortcutIconResource[] newArray(int size) {
840 return new ShortcutIconResource[size];
841 }
842 };
843
844 /**
845 * No special parcel contents.
846 */
847 public int describeContents() {
848 return 0;
849 }
850
851 public void writeToParcel(Parcel dest, int flags) {
852 dest.writeString(packageName);
853 dest.writeString(resourceName);
854 }
855
856 @Override
857 public String toString() {
858 return resourceName;
859 }
860 }
861
862 /**
863 * Activity Action: Display an activity chooser, allowing the user to pick
864 * what they want to before proceeding. This can be used as an alternative
865 * to the standard activity picker that is displayed by the system when
866 * you try to start an activity with multiple possible matches, with these
867 * differences in behavior:
868 * <ul>
869 * <li>You can specify the title that will appear in the activity chooser.
870 * <li>The user does not have the option to make one of the matching
871 * activities a preferred activity, and all possible activities will
872 * always be shown even if one of them is currently marked as the
873 * preferred activity.
874 * </ul>
875 * <p>
876 * This action should be used when the user will naturally expect to
877 * select an activity in order to proceed. An example if when not to use
878 * it is when the user clicks on a "mailto:" link. They would naturally
879 * expect to go directly to their mail app, so startActivity() should be
880 * called directly: it will
881 * either launch the current preferred app, or put up a dialog allowing the
882 * user to pick an app to use and optionally marking that as preferred.
883 * <p>
884 * In contrast, if the user is selecting a menu item to send a picture
885 * they are viewing to someone else, there are many different things they
886 * may want to do at this point: send it through e-mail, upload it to a
887 * web service, etc. In this case the CHOOSER action should be used, to
888 * always present to the user a list of the things they can do, with a
889 * nice title given by the caller such as "Send this photo with:".
890 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700891 * If you need to grant URI permissions through a chooser, you must specify
892 * the permissions to be granted on the ACTION_CHOOSER Intent
893 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
894 * {@link #setClipData} to specify the URIs to be granted as well as
895 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
896 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
897 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700898 * As a convenience, an Intent of this form can be created with the
899 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700900 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700901 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700902 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
903 * and can optionally have a {@link #EXTRA_TITLE} field containing the
904 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700905 * <p>
906 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700907 */
908 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
909 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
910
911 /**
912 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
913 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700914 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
915 * target intent, also optionally supplying a title. If the target
916 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
917 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
918 * set in the returned chooser intent, with its ClipData set appropriately:
919 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500920 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700921 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700922 * @param target The Intent that the user will be selecting an activity
923 * to perform.
924 * @param title Optional title that will be displayed in the chooser.
925 * @return Return a new Intent object that you can hand to
926 * {@link Context#startActivity(Intent) Context.startActivity()} and
927 * related methods.
928 */
929 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700930 return createChooser(target, title, null);
931 }
932
933 /**
934 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
935 *
936 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
937 * target intent, also optionally supplying a title. If the target
938 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
939 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
940 * set in the returned chooser intent, with its ClipData set appropriately:
941 * either a direct reflection of {@link #getClipData()} if that is non-null,
942 * or a new ClipData built from {@link #getData()}.</p>
943 *
944 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
945 * when the user makes a choice. This can be useful if the calling application wants
946 * to remember the last chosen target and surface it as a more prominent or one-touch
947 * affordance elsewhere in the UI for next time.</p>
948 *
949 * @param target The Intent that the user will be selecting an activity
950 * to perform.
951 * @param title Optional title that will be displayed in the chooser.
952 * @param sender Optional IntentSender to be called when a choice is made.
953 * @return Return a new Intent object that you can hand to
954 * {@link Context#startActivity(Intent) Context.startActivity()} and
955 * related methods.
956 */
957 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700958 Intent intent = new Intent(ACTION_CHOOSER);
959 intent.putExtra(EXTRA_INTENT, target);
960 if (title != null) {
961 intent.putExtra(EXTRA_TITLE, title);
962 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700963
Adam Powell0b3c1122014-10-09 12:50:14 -0700964 if (sender != null) {
965 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
966 }
967
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700968 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700969 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
970 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
971 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700972 if (permFlags != 0) {
973 ClipData targetClipData = target.getClipData();
974 if (targetClipData == null && target.getData() != null) {
975 ClipData.Item item = new ClipData.Item(target.getData());
976 String[] mimeTypes;
977 if (target.getType() != null) {
978 mimeTypes = new String[] { target.getType() };
979 } else {
980 mimeTypes = new String[] { };
981 }
982 targetClipData = new ClipData(null, mimeTypes, item);
983 }
984 if (targetClipData != null) {
985 intent.setClipData(targetClipData);
986 intent.addFlags(permFlags);
987 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700988 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700989
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700990 return intent;
991 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700992
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700993 /**
994 * Activity Action: Allow the user to select a particular kind of data and
995 * return it. This is different than {@link #ACTION_PICK} in that here we
996 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800997 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700998 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900999 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001000 * etc.
1001 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001002 * 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 -07001003 * of data, such as a person contact, you set the MIME type to the kind of
1004 * data you want and launch it with {@link Context#startActivity(Intent)}.
1005 * The system will then launch the best application to select that kind
1006 * of data for you.
1007 * <p>
1008 * You may also be interested in any of a set of types of content the user
1009 * can pick. For example, an e-mail application that wants to allow the
1010 * user to add an attachment to an e-mail message can use this action to
1011 * bring up a list of all of the types of content the user can attach.
1012 * <p>
1013 * In this case, you should wrap the GET_CONTENT intent with a chooser
1014 * (through {@link #createChooser}), which will give the proper interface
1015 * for the user to pick how to send your data and allow you to specify
1016 * a prompt indicating what they are doing. You will usually specify a
1017 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1018 * broad range of content types the user can select from.
1019 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001020 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001021 * only pick from data that can be represented as a stream. This is
1022 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1023 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001024 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001025 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001026 * is locally available on the device. For example, if this extra is set
1027 * to true then an image picker should not show any pictures that are available
1028 * from a remote server but not already on the local device (thus requiring
1029 * they be downloaded when opened).
1030 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001031 * If the caller can handle multiple returned items (the user performing
1032 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1033 * to indicate this.
1034 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001035 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1036 * that no URI is supplied in the intent, as there are no constraints on
1037 * where the returned data originally comes from. You may also include the
1038 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001039 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001040 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1041 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001042 * <p>
1043 * Output: The URI of the item that was picked. This must be a content:
1044 * URI so that any receiver can access it.
1045 */
1046 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1047 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1048 /**
1049 * Activity Action: Dial a number as specified by the data. This shows a
1050 * UI with the number being dialed, allowing the user to explicitly
1051 * initiate the call.
1052 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1053 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1054 * number.
1055 * <p>Output: nothing.
1056 */
1057 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1058 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1059 /**
1060 * Activity Action: Perform a call to someone specified by the data.
1061 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1062 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1063 * number.
1064 * <p>Output: nothing.
1065 *
1066 * <p>Note: there will be restrictions on which applications can initiate a
1067 * call; most applications should use the {@link #ACTION_DIAL}.
1068 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1069 * numbers. Applications can <strong>dial</strong> emergency numbers using
1070 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001071 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001072 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001073 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001074 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001075 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_CALL = "android.intent.action.CALL";
1079 /**
1080 * Activity Action: Perform a call to an emergency number specified by the
1081 * data.
1082 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1083 * tel: URI of an explicit phone number.
1084 * <p>Output: nothing.
1085 * @hide
1086 */
1087 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1088 /**
1089 * Activity action: Perform a call to any number (emergency or not)
1090 * specified by the data.
1091 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1092 * tel: URI of an explicit phone number.
1093 * <p>Output: nothing.
1094 * @hide
1095 */
1096 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1097 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001098 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1099 * sending this intent is a no-op.
1100 * <p>Input: No data should be specified. get*Extra may have an optional
1101 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1102 * send the activation result.
1103 * <p>Output: nothing.
1104 * @hide
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1108 "android.intent.action.SIM_ACTIVATION_REQUEST";
1109 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001110 * Activity Action: Send a message to someone specified by the data.
1111 * <p>Input: {@link #getData} is URI describing the target.
1112 * <p>Output: nothing.
1113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1116 /**
1117 * Activity Action: Deliver some data to someone else. Who the data is
1118 * being delivered to is not specified; it is up to the receiver of this
1119 * action to ask the user where the data should be sent.
1120 * <p>
1121 * When launching a SEND intent, you should usually wrap it in a chooser
1122 * (through {@link #createChooser}), which will give the proper interface
1123 * for the user to pick how to send your data and allow you to specify
1124 * a prompt indicating what they are doing.
1125 * <p>
1126 * Input: {@link #getType} is the MIME type of the data being sent.
1127 * get*Extra can have either a {@link #EXTRA_TEXT}
1128 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1129 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1130 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1131 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001132 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1133 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1134 * your text with HTML formatting.
1135 * <p>
1136 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1137 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1138 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1139 * content: URIs and other advanced features of {@link ClipData}. If
1140 * using this approach, you still must supply the same data through the
1141 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1142 * for compatibility with old applications. If you don't set a ClipData,
1143 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001144 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001145 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1146 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1147 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1148 * be openable only as asset typed files using
1149 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1150 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001151 * Optional standard extras, which may be interpreted by some recipients as
1152 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1153 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1154 * <p>
1155 * Output: nothing.
1156 */
1157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1158 public static final String ACTION_SEND = "android.intent.action.SEND";
1159 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001160 * Activity Action: Deliver multiple data to someone else.
1161 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001162 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001163 * <p>
1164 * Input: {@link #getType} is the MIME type of the data being sent.
1165 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001166 * #EXTRA_STREAM} field, containing the data to be sent. If using
1167 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1168 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001169 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001170 * Multiple types are supported, and receivers should handle mixed types
1171 * whenever possible. The right way for the receiver to check them is to
1172 * use the content resolver on each URI. The intent sender should try to
1173 * put the most concrete mime type in the intent type, but it can fall
1174 * back to {@literal <type>/*} or {@literal *}/* as needed.
1175 * <p>
1176 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1177 * be image/jpg, but if you are sending image/jpg and image/png, then the
1178 * intent's type should be image/*.
1179 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001180 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1181 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1182 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1183 * content: URIs and other advanced features of {@link ClipData}. If
1184 * using this approach, you still must supply the same data through the
1185 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1186 * for compatibility with old applications. If you don't set a ClipData,
1187 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1188 * <p>
Tomasz Mikolajewskid8a2e192016-12-15 16:10:46 +09001189 * Starting from {@link android.os.Build.VERSION_CODES#O}, if
1190 * {@link #CATEGORY_TYPED_OPENABLE} is passed, then the Uris passed in
1191 * either {@link #EXTRA_STREAM} or via {@link #setClipData(ClipData)} may
1192 * be openable only as asset typed files using
1193 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}.
1194 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001195 * Optional standard extras, which may be interpreted by some recipients as
1196 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1197 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1198 * <p>
1199 * Output: nothing.
1200 */
1201 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1202 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1203 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001204 * Activity Action: Handle an incoming phone call.
1205 * <p>Input: nothing.
1206 * <p>Output: nothing.
1207 */
1208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1209 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1210 /**
1211 * Activity Action: Insert an empty item into the given container.
1212 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1213 * in which to place the data.
1214 * <p>Output: URI of the new data that was created.
1215 */
1216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1217 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1218 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001219 * Activity Action: Create a new item in the given container, initializing it
1220 * from the current contents of the clipboard.
1221 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1222 * in which to place the data.
1223 * <p>Output: URI of the new data that was created.
1224 */
1225 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1226 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1227 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001228 * Activity Action: Delete the given data from its container.
1229 * <p>Input: {@link #getData} is URI of data to be deleted.
1230 * <p>Output: nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1234 /**
1235 * Activity Action: Run the data, whatever that means.
1236 * <p>Input: ? (Note: this is currently specific to the test harness.)
1237 * <p>Output: nothing.
1238 */
1239 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1240 public static final String ACTION_RUN = "android.intent.action.RUN";
1241 /**
1242 * Activity Action: Perform a data synchronization.
1243 * <p>Input: ?
1244 * <p>Output: ?
1245 */
1246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1247 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1248 /**
1249 * Activity Action: Pick an activity given an intent, returning the class
1250 * selected.
1251 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1252 * used with {@link PackageManager#queryIntentActivities} to determine the
1253 * set of activities from which to pick.
1254 * <p>Output: Class name of the activity that was selected.
1255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1258 /**
1259 * Activity Action: Perform a search.
1260 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1261 * is the text to search for. If empty, simply
1262 * enter your search results Activity with the search UI activated.
1263 * <p>Output: nothing.
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1267 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001268 * Activity Action: Start the platform-defined tutorial
1269 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1270 * is the text to search for. If empty, simply
1271 * enter your search results Activity with the search UI activated.
1272 * <p>Output: nothing.
1273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1276 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001277 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001278 * <p>
1279 * Input: {@link android.app.SearchManager#QUERY
1280 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1281 * a url starts with http or https, the site will be opened. If it is plain
1282 * text, Google search will be applied.
1283 * <p>
1284 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001285 */
1286 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1287 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001288
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001289 /**
Jim Miller07994402012-05-02 14:22:27 -07001290 * Activity Action: Perform assist action.
1291 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001292 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1293 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001294 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1295 * information.
Jim Miller07994402012-05-02 14:22:27 -07001296 * Output: nothing.
1297 */
1298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1299 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001300
1301 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001302 * Activity Action: Perform voice assist action.
1303 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001304 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1305 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001306 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001307 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001308 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1312
1313 /**
Adam Skory7140a252013-09-11 12:04:58 +01001314 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1315 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001316 */
1317 public static final String EXTRA_ASSIST_PACKAGE
1318 = "android.intent.extra.ASSIST_PACKAGE";
1319
1320 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001321 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1322 * application package at the time the assist was invoked.
1323 */
1324 public static final String EXTRA_ASSIST_UID
1325 = "android.intent.extra.ASSIST_UID";
1326
1327 /**
Adam Skory7140a252013-09-11 12:04:58 +01001328 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1329 * information supplied by the current foreground app at the time of the assist request.
1330 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001331 */
1332 public static final String EXTRA_ASSIST_CONTEXT
1333 = "android.intent.extra.ASSIST_CONTEXT";
1334
Jim Miller07994402012-05-02 14:22:27 -07001335 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001336 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1337 * keyboard as the primary input device for assistance.
1338 */
1339 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1340 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1341
1342 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001343 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1344 * that was used to invoke the assist.
1345 */
1346 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1347 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1348
1349 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001350 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001351 * <p>Input: Nothing.
1352 * <p>Output: nothing.
1353 */
1354 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1355 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1356 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001357 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001358 * <p>Input: Nothing.
1359 * <p>Output: Nothing.
1360 */
1361 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1362 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1363
1364 /**
1365 * Activity Action: Show activity for reporting a bug.
1366 * <p>Input: Nothing.
1367 * <p>Output: Nothing.
1368 */
1369 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1370 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1371
1372 /**
1373 * Activity Action: Main entry point for factory tests. Only used when
1374 * the device is booting in factory test node. The implementing package
1375 * must be installed in the system image.
1376 * <p>Input: nothing
1377 * <p>Output: nothing
1378 */
1379 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1380
1381 /**
1382 * Activity Action: The user pressed the "call" button to go to the dialer
1383 * or other appropriate UI for placing a call.
1384 * <p>Input: Nothing.
1385 * <p>Output: Nothing.
1386 */
1387 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1388 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1389
1390 /**
1391 * Activity Action: Start Voice Command.
1392 * <p>Input: Nothing.
1393 * <p>Output: Nothing.
1394 */
1395 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1396 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001397
1398 /**
1399 * Activity Action: Start action associated with long pressing on the
1400 * search key.
1401 * <p>Input: Nothing.
1402 * <p>Output: Nothing.
1403 */
1404 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1405 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001406
Jacek Surazski86b6c532009-05-13 14:38:28 +02001407 /**
1408 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1409 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001410 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001411 * <p>Input: No data is specified. The bug report is passed in using
1412 * an {@link #EXTRA_BUG_REPORT} field.
1413 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001414 *
1415 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001416 */
1417 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1418 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001419
1420 /**
1421 * Activity Action: Show power usage information to the user.
1422 * <p>Input: Nothing.
1423 * <p>Output: Nothing.
1424 */
1425 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1426 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001427
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001428 /**
1429 * Activity Action: Setup wizard to launch after a platform update. This
1430 * activity should have a string meta-data field associated with it,
1431 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1432 * the platform for setup. The activity will be launched only if
1433 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1434 * same value.
1435 * <p>Input: Nothing.
1436 * <p>Output: Nothing.
1437 * @hide
1438 */
1439 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1440 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001441
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001442 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001443 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1444 * <p>Input: Nothing.
1445 * <p>Output: Nothing.
1446 * @hide
1447 */
1448 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1449 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1450 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1451
1452 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001453 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1454 * <p>Input: Nothing.
1455 * <p>Output: Nothing.
1456 * @hide
1457 */
1458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1459 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1460 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1461
1462 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001463 * Activity Action: Show settings for managing network data usage of a
1464 * specific application. Applications should define an activity that offers
1465 * options to control data usage.
1466 */
1467 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1468 public static final String ACTION_MANAGE_NETWORK_USAGE =
1469 "android.intent.action.MANAGE_NETWORK_USAGE";
1470
1471 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001472 * Activity Action: Launch application installer.
1473 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001474 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001475 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1476 * you can also use "package:<package-name>" to install an application for the
1477 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001478 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1479 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1480 * <p>
1481 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1482 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001483 * <p>
1484 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1485 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1486 * in order to launch the application installer.
1487 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001488 *
1489 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1490 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1491 * @see #EXTRA_RETURN_RESULT
1492 */
1493 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1494 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1495
1496 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001497 * Activity Action: Launch ephemeral installer.
1498 * <p>
1499 * Input: The data must be a http: URI that the ephemeral application is registered
1500 * to handle.
1501 * <p class="note">
1502 * This is a protected intent that can only be sent by the system.
1503 * </p>
1504 *
1505 * @hide
1506 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001507 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1508 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1509 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1510
1511 /**
1512 * Service Action: Resolve ephemeral application.
1513 * <p>
1514 * The system will have a persistent connection to this service.
1515 * This is a protected intent that can only be sent by the system.
1516 * </p>
1517 *
1518 * @hide
1519 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001520 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1521 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1522 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1523
1524 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001525 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1526 * package. Specifies the installer package name; this package will receive the
1527 * {@link #ACTION_APP_ERROR} intent.
1528 */
1529 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1530 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1531
1532 /**
1533 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1534 * package. Specifies that the application being installed should not be
1535 * treated as coming from an unknown source, but as coming from the app
1536 * invoking the Intent. For this to work you must start the installer with
1537 * startActivityForResult().
1538 */
1539 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1540 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1541
1542 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001543 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1544 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001545 * data field originated from.
1546 */
rich cannings706e8ba2012-08-20 13:20:14 -07001547 public static final String EXTRA_ORIGINATING_URI
1548 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001549
1550 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001551 * This extra can be used with any Intent used to launch an activity, supplying information
1552 * about who is launching that activity. This field contains a {@link android.net.Uri}
1553 * object, typically an http: or https: URI of the web site that the referral came from;
1554 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1555 * a native application that it came from.
1556 *
1557 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1558 * instead of directly retrieving the extra. It is also valid for applications to
1559 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1560 * a string, not a Uri; the field here, if supplied, will always take precedence,
1561 * however.</p>
1562 *
1563 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001564 */
1565 public static final String EXTRA_REFERRER
1566 = "android.intent.extra.REFERRER";
1567
1568 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001569 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1570 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1571 * not be created, in particular when Intent extras are supplied through the
1572 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1573 * schemes.
1574 *
1575 * @see #EXTRA_REFERRER
1576 */
1577 public static final String EXTRA_REFERRER_NAME
1578 = "android.intent.extra.REFERRER_NAME";
1579
1580 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001581 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001582 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001583 * @hide
1584 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001585 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001586 public static final String EXTRA_ORIGINATING_UID
1587 = "android.intent.extra.ORIGINATING_UID";
1588
1589 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001590 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1591 * package. Tells the installer UI to skip the confirmation with the user
1592 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001593 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1594 * will no longer show an interstitial message about updating existing
1595 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001596 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001597 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001598 public static final String EXTRA_ALLOW_REPLACE
1599 = "android.intent.extra.ALLOW_REPLACE";
1600
1601 /**
1602 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1603 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1604 * return to the application the result code of the install/uninstall. The returned result
1605 * code will be {@link android.app.Activity#RESULT_OK} on success or
1606 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1607 */
1608 public static final String EXTRA_RETURN_RESULT
1609 = "android.intent.extra.RETURN_RESULT";
1610
1611 /**
1612 * Package manager install result code. @hide because result codes are not
1613 * yet ready to be exposed.
1614 */
1615 public static final String EXTRA_INSTALL_RESULT
1616 = "android.intent.extra.INSTALL_RESULT";
1617
1618 /**
1619 * Activity Action: Launch application uninstaller.
1620 * <p>
1621 * Input: The data must be a package: URI whose scheme specific part is
1622 * the package name of the current installed package to be uninstalled.
1623 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1624 * <p>
1625 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1626 * succeeded.
1627 */
1628 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1629 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1630
1631 /**
msnider3c191b82017-01-23 14:23:16 -08001632 * Activity Action: Launch application uninstaller.
1633 * <p>
1634 * Input: The data must be a package: URI whose scheme specific part is
1635 * the package name of the current installed package to be uninstalled.
1636 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1637 * <p>
1638 * Output: Nothing.
1639 * </p>
1640 */
1641 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1642 public static final String ACTION_CLEAR_PACKAGE = "android.intent.action.CLEAR_PACKAGE";
1643
1644 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001645 * Specify whether the package should be uninstalled for all users.
1646 * @hide because these should not be part of normal application flow.
1647 */
1648 public static final String EXTRA_UNINSTALL_ALL_USERS
1649 = "android.intent.extra.UNINSTALL_ALL_USERS";
1650
1651 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001652 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1653 * describing the last run version of the platform that was setup.
1654 * @hide
1655 */
1656 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1657
Svet Ganov3695b8a2015-03-24 16:30:25 -07001658 /**
1659 * Activity action: Launch UI to manage the permissions of an app.
1660 * <p>
1661 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1662 * will be managed by the launched UI.
1663 * </p>
1664 * <p>
1665 * Output: Nothing.
1666 * </p>
1667 *
1668 * @see #EXTRA_PACKAGE_NAME
1669 *
1670 * @hide
1671 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001672 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1674 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1675 "android.intent.action.MANAGE_APP_PERMISSIONS";
1676
1677 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001678 * Activity action: Launch UI to manage permissions.
1679 * <p>
1680 * Input: Nothing.
1681 * </p>
1682 * <p>
1683 * Output: Nothing.
1684 * </p>
1685 *
1686 * @hide
1687 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001688 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001689 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1690 public static final String ACTION_MANAGE_PERMISSIONS =
1691 "android.intent.action.MANAGE_PERMISSIONS";
1692
1693 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001694 * Activity action: Launch UI to review permissions for an app.
1695 * The system uses this intent if permission review for apps not
1696 * supporting the new runtime permissions model is enabled. In
1697 * this mode a permission review is required before any of the
1698 * app components can run.
1699 * <p>
1700 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1701 * permissions will be reviewed (mandatory).
1702 * </p>
1703 * <p>
1704 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1705 * be fired after the permission review (optional).
1706 * </p>
1707 * <p>
1708 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1709 * be invoked after the permission review (optional).
1710 * </p>
1711 * <p>
1712 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1713 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1714 * </p>
1715 * <p>
1716 * Output: Nothing.
1717 * </p>
1718 *
1719 * @see #EXTRA_PACKAGE_NAME
1720 * @see #EXTRA_INTENT
1721 * @see #EXTRA_REMOTE_CALLBACK
1722 * @see #EXTRA_RESULT_NEEDED
1723 *
1724 * @hide
1725 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001726 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001727 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1728 public static final String ACTION_REVIEW_PERMISSIONS =
1729 "android.intent.action.REVIEW_PERMISSIONS";
1730
1731 /**
1732 * Intent extra: A callback for reporting remote result as a bundle.
1733 * <p>
1734 * Type: IRemoteCallback
1735 * </p>
1736 *
1737 * @hide
1738 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001739 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001740 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1741
1742 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001743 * Intent extra: An app package name.
1744 * <p>
1745 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001746 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001747 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001748 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001749 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1750
1751 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001752 * Intent extra: An app split name.
1753 * <p>
1754 * Type: String
1755 * </p>
1756 * @hide
1757 */
1758 @SystemApi
1759 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1760
1761 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001762 * Intent extra: An extra for specifying whether a result is needed.
1763 * <p>
1764 * Type: boolean
1765 * </p>
1766 *
1767 * @hide
1768 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001769 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001770 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1771
1772 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001773 * Activity action: Launch UI to manage which apps have a given permission.
1774 * <p>
1775 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1776 * to which will be managed by the launched UI.
1777 * </p>
1778 * <p>
1779 * Output: Nothing.
1780 * </p>
1781 *
1782 * @see #EXTRA_PERMISSION_NAME
1783 *
1784 * @hide
1785 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001786 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001787 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1788 public static final String ACTION_MANAGE_PERMISSION_APPS =
1789 "android.intent.action.MANAGE_PERMISSION_APPS";
1790
1791 /**
1792 * Intent extra: The name of a permission.
1793 * <p>
1794 * Type: String
1795 * </p>
1796 *
1797 * @hide
1798 */
1799 @SystemApi
1800 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1801
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001802 // ---------------------------------------------------------------------
1803 // ---------------------------------------------------------------------
1804 // Standard intent broadcast actions (see action variable).
1805
1806 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001807 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1808 * <p>
1809 * For historical reasons, the name of this broadcast action refers to the power
1810 * state of the screen but it is actually sent in response to changes in the
1811 * overall interactive state of the device.
1812 * </p><p>
1813 * This broadcast is sent when the device becomes non-interactive which may have
1814 * nothing to do with the screen turning off. To determine the
1815 * actual state of the screen, use {@link android.view.Display#getState}.
1816 * </p><p>
1817 * See {@link android.os.PowerManager#isInteractive} for details.
1818 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001819 * You <em>cannot</em> receive this through components declared in
1820 * manifests, only by explicitly registering for it with
1821 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1822 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001823 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001824 * <p class="note">This is a protected intent that can only be sent
1825 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001826 */
1827 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1828 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001829
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001831 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1832 * <p>
1833 * For historical reasons, the name of this broadcast action refers to the power
1834 * state of the screen but it is actually sent in response to changes in the
1835 * overall interactive state of the device.
1836 * </p><p>
1837 * This broadcast is sent when the device becomes interactive which may have
1838 * nothing to do with the screen turning on. To determine the
1839 * actual state of the screen, use {@link android.view.Display#getState}.
1840 * </p><p>
1841 * See {@link android.os.PowerManager#isInteractive} for details.
1842 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001843 * You <em>cannot</em> receive this through components declared in
1844 * manifests, only by explicitly registering for it with
1845 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1846 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001847 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001848 * <p class="note">This is a protected intent that can only be sent
1849 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001850 */
1851 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1852 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001853
1854 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001855 * Broadcast Action: Sent after the system stops dreaming.
1856 *
1857 * <p class="note">This is a protected intent that can only be sent by the system.
1858 * It is only sent to registered receivers.</p>
1859 */
1860 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1861 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1862
1863 /**
1864 * Broadcast Action: Sent after the system starts dreaming.
1865 *
1866 * <p class="note">This is a protected intent that can only be sent by the system.
1867 * It is only sent to registered receivers.</p>
1868 */
1869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1870 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1871
1872 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001873 * 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 -07001874 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001875 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001876 * <p class="note">This is a protected intent that can only be sent
1877 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001878 */
1879 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001880 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001882 /**
1883 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001884 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001885 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001886 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1887 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001888 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001889 * <p class="note">This is a protected intent that can only be sent
1890 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001891 */
1892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1893 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1894 /**
1895 * Broadcast Action: The time was set.
1896 */
1897 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1898 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1899 /**
1900 * Broadcast Action: The date has changed.
1901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1904 /**
1905 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1906 * <ul>
1907 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1908 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001909 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001910 * <p class="note">This is a protected intent that can only be sent
1911 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1915 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001916 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1917 * DNS entries should be tossed.
1918 * @hide
1919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1922 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 * Alarm Changed Action: This is broadcast when the AlarmClock
1924 * application's alarm is set or unset. It is used by the
1925 * AlarmClock application and the StatusBar service.
1926 * @hide
1927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001930
1931 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001932 * Broadcast Action: This is broadcast once, after the user has finished
1933 * booting, but while still in the "locked" state. It can be used to perform
1934 * application-specific initialization, such as installing alarms. You must
1935 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1936 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001937 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001938 * This broadcast is sent immediately at boot by all devices (regardless of
1939 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1940 * higher. Upon receipt of this broadcast, the user is still locked and only
1941 * device-protected storage can be accessed safely. If you want to access
1942 * credential-protected storage, you need to wait for the user to be
1943 * unlocked (typically by entering their lock pattern or PIN for the first
1944 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1945 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1946 * <p>
1947 * To receive this broadcast, your receiver component must be marked as
1948 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001949 * <p class="note">
1950 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001951 *
1952 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001953 */
1954 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1955 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001957 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001958 * Broadcast Action: This is broadcast once, after the user has finished
1959 * booting. It can be used to perform application-specific initialization,
1960 * such as installing alarms. You must hold the
1961 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1962 * order to receive this broadcast.
1963 * <p>
1964 * This broadcast is sent at boot by all devices (both with and without
1965 * direct boot support). Upon receipt of this broadcast, the user is
1966 * unlocked and both device-protected and credential-protected storage can
1967 * accessed safely.
1968 * <p>
1969 * If you need to run while the user is still locked (before they've entered
1970 * their lock pattern or PIN for the first time), you can listen for the
1971 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1972 * <p class="note">
1973 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001977
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 /**
1979 * Broadcast Action: This is broadcast when a user action should request a
1980 * temporary system dialog to dismiss. Some examples of temporary system
1981 * dialogs are the notification window-shade and the recent tasks dialog.
1982 */
1983 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1984 /**
1985 * Broadcast Action: Trigger the download and eventual installation
1986 * of a package.
1987 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001988 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001989 * <p class="note">This is a protected intent that can only be sent
1990 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001991 *
1992 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001994 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001995 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1996 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1997 /**
1998 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001999 * device. The data contains the name of the package. Note that the
2000 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002001 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002002 * <ul>
2003 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2004 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2005 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2006 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002007 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002008 * <p class="note">This is a protected intent that can only be sent
2009 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002010 */
2011 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2012 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2013 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002014 * Broadcast Action: A new version of an application package has been
2015 * installed, replacing an existing version that was previously installed.
2016 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002017 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002018 * <ul>
2019 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2020 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002021 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002022 * <p class="note">This is a protected intent that can only be sent
2023 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2027 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002028 * Broadcast Action: A new version of your application has been installed
2029 * over an existing one. This is only sent to the application that was
2030 * replaced. It does not contain any additional data; to receive it, just
2031 * use an intent filter for this action.
2032 *
2033 * <p class="note">This is a protected intent that can only be sent
2034 * by the system.
2035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2038 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002039 * Broadcast Action: An existing application package has been removed from
2040 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002041 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002042 * <ul>
2043 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2044 * to the package.
2045 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2046 * application -- data and code -- is being removed.
2047 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2048 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2049 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002050 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002051 * <p class="note">This is a protected intent that can only be sent
2052 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2056 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002057 * Broadcast Action: An existing application package has been completely
2058 * removed from the device. The data contains the name of the package.
2059 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2060 * {@link #EXTRA_DATA_REMOVED} is true and
2061 * {@link #EXTRA_REPLACING} is false of that broadcast.
2062 *
2063 * <ul>
2064 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2065 * to the package.
2066 * </ul>
2067 *
2068 * <p class="note">This is a protected intent that can only be sent
2069 * by the system.
2070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_PACKAGE_FULLY_REMOVED
2073 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2074 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002075 * Broadcast Action: An existing application package has been changed (for
2076 * example, a component has been enabled or disabled). The data contains
2077 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 * <ul>
2079 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002080 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002081 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002082 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2083 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002084 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002085 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002086 * <p class="note">This is a protected intent that can only be sent
2087 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002088 */
2089 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2090 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2091 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002092 * @hide
2093 * Broadcast Action: Ask system services if there is any reason to
2094 * restart the given package. The data contains the name of the
2095 * package.
2096 * <ul>
2097 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2098 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2099 * </ul>
2100 *
2101 * <p class="note">This is a protected intent that can only be sent
2102 * by the system.
2103 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002104 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002105 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2106 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2107 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002108 * Broadcast Action: The user has restarted a package, and all of its
2109 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002110 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002111 * be removed. Note that the restarted package does <em>not</em>
2112 * receive this broadcast.
2113 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002114 * <ul>
2115 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2116 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002117 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002118 * <p class="note">This is a protected intent that can only be sent
2119 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2123 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002124 * Broadcast Action: The user has cleared the data of a package. This should
2125 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002126 * its persistent data is erased and this broadcast sent.
2127 * Note that the cleared package does <em>not</em>
2128 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002129 * <ul>
2130 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2131 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002132 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002133 * <p class="note">This is a protected intent that can only be sent
2134 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2138 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002139 * Broadcast Action: Packages have been suspended.
2140 * <p>Includes the following extras:
2141 * <ul>
2142 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2143 * </ul>
2144 *
2145 * <p class="note">This is a protected intent that can only be sent
2146 * by the system. It is only sent to registered receivers.
2147 */
2148 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2149 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2150 /**
2151 * Broadcast Action: Packages have been unsuspended.
2152 * <p>Includes the following extras:
2153 * <ul>
2154 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2155 * </ul>
2156 *
2157 * <p class="note">This is a protected intent that can only be sent
2158 * by the system. It is only sent to registered receivers.
2159 */
2160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2161 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2162 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002163 * Broadcast Action: A user ID has been removed from the system. The user
2164 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002165 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002166 * <p class="note">This is a protected intent that can only be sent
2167 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002171
2172 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002173 * Broadcast Action: Sent to the installer package of an application when
2174 * that application is first launched (that is the first time it is moved
2175 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002176 *
2177 * <p class="note">This is a protected intent that can only be sent
2178 * by the system.
2179 */
2180 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2181 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2182
2183 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002184 * Broadcast Action: Sent to the system package verifier when a package
2185 * needs to be verified. The data contains the package URI.
2186 * <p class="note">
2187 * This is a protected intent that can only be sent by the system.
2188 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002189 */
2190 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2191 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2192
2193 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002194 * Broadcast Action: Sent to the system package verifier when a package is
2195 * verified. The data contains the package URI.
2196 * <p class="note">
2197 * This is a protected intent that can only be sent by the system.
2198 */
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2201
2202 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002203 * Broadcast Action: Sent to the system intent filter verifier when an
2204 * intent filter needs to be verified. The data contains the filter data
2205 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002206 * <p class="note">
2207 * This is a protected intent that can only be sent by the system.
2208 * </p>
2209 *
2210 * @hide
2211 */
2212 @SystemApi
2213 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2214 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2215
2216 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002217 * Broadcast Action: Resources for a set of packages (which were
2218 * previously unavailable) are currently
2219 * available since the media on which they exist is available.
2220 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2221 * list of packages whose availability changed.
2222 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2223 * list of uids of packages whose availability changed.
2224 * Note that the
2225 * packages in this list do <em>not</em> receive this broadcast.
2226 * The specified set of packages are now available on the system.
2227 * <p>Includes the following extras:
2228 * <ul>
2229 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2230 * whose resources(were previously unavailable) are currently available.
2231 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2232 * packages whose resources(were previously unavailable)
2233 * are currently available.
2234 * </ul>
2235 *
2236 * <p class="note">This is a protected intent that can only be sent
2237 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002238 */
2239 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002240 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2241 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002242
2243 /**
2244 * Broadcast Action: Resources for a set of packages are currently
2245 * unavailable since the media on which they exist is unavailable.
2246 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2247 * list of packages whose availability changed.
2248 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2249 * list of uids of packages whose availability changed.
2250 * The specified set of packages can no longer be
2251 * launched and are practically unavailable on the system.
2252 * <p>Inclues the following extras:
2253 * <ul>
2254 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2255 * whose resources are no longer available.
2256 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2257 * whose resources are no longer available.
2258 * </ul>
2259 *
2260 * <p class="note">This is a protected intent that can only be sent
2261 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002262 */
2263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002264 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002265 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002266
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002267 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002268 * Broadcast Action: preferred activities have changed *explicitly*.
2269 *
2270 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2271 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2272 * be sent.
2273 *
2274 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2275 *
2276 * @hide
2277 */
2278 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2279 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2280 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2281
2282
2283 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002284 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002285 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002286 * This should <em>only</em> be used to determine when the wallpaper
2287 * has changed to show the new wallpaper to the user. You should certainly
2288 * never, in response to this, change the wallpaper or other attributes of
2289 * it such as the suggested size. That would be crazy, right? You'd cause
2290 * all kinds of loops, especially if other apps are doing similar things,
2291 * right? Of course. So please don't do this.
2292 *
2293 * @deprecated Modern applications should use
2294 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2295 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2296 * shown behind their UI, rather than watching for this broadcast and
2297 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002299 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2301 /**
2302 * Broadcast Action: The current device {@link android.content.res.Configuration}
2303 * (orientation, locale, etc) has changed. When such a change happens, the
2304 * UIs (view hierarchy) will need to be rebuilt based on this new
2305 * information; for the most part, applications don't need to worry about
2306 * this, because the system will take care of stopping and restarting the
2307 * application to make sure it sees the new changes. Some system code that
2308 * can not be restarted will need to watch for this action and handle it
2309 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002310 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002311 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002312 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002313 * in manifests, only by explicitly registering for it with
2314 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2315 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002316 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002317 * <p class="note">This is a protected intent that can only be sent
2318 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002319 *
2320 * @see android.content.res.Configuration
2321 */
2322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2323 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2324 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002325 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002326 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002327 * <p class="note">This is a protected intent that can only be sent
2328 * by the system.
2329 */
2330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2331 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2332 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002333 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2334 * charging state, level, and other information about the battery.
2335 * See {@link android.os.BatteryManager} for documentation on the
2336 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002337 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002338 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002339 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002340 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002341 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002342 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2343 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2344 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2345 * broadcasts that are sent and can be received through manifest
2346 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002347 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002348 * <p class="note">This is a protected intent that can only be sent
2349 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002350 */
2351 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2352 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2353 /**
2354 * Broadcast Action: Indicates low battery condition on the device.
2355 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002356 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002357 * <p class="note">This is a protected intent that can only be sent
2358 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002359 */
2360 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2361 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2362 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002363 * Broadcast Action: Indicates the battery is now okay after being low.
2364 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2365 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002366 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002367 * <p class="note">This is a protected intent that can only be sent
2368 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002369 */
2370 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2371 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2372 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002373 * Broadcast Action: External power has been connected to the device.
2374 * This is intended for applications that wish to register specifically to this notification.
2375 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2376 * stay active to receive this notification. This action can be used to implement actions
2377 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002378 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002379 * <p class="note">This is a protected intent that can only be sent
2380 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002381 */
2382 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002383 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002384 /**
2385 * Broadcast Action: External power has been removed from the device.
2386 * This is intended for applications that wish to register specifically to this notification.
2387 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2388 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002389 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002390 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002391 * <p class="note">This is a protected intent that can only be sent
2392 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002393 */
2394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002395 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002396 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002397 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002398 * Broadcast Action: Device is shutting down.
2399 * This is broadcast when the device is being shut down (completely turned
2400 * off, not sleeping). Once the broadcast is complete, the final shutdown
2401 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002402 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002403 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002404 * <p class="note">This is a protected intent that can only be sent
2405 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002406 * <p>May include the following extras:
2407 * <ul>
2408 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2409 * shutdown is only for userspace processes. If not set, assumed to be false.
2410 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002411 */
2412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002413 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002414 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002415 * Activity Action: Start this activity to request system shutdown.
2416 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002417 * to request confirmation from the user before shutting down. The optional boolean
2418 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2419 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002420 *
2421 * <p class="note">This is a protected intent that can only be sent
2422 * by the system.
2423 *
2424 * {@hide}
2425 */
2426 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2427 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002428 * Broadcast Action: A sticky broadcast that indicates low memory
2429 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002430 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002431 * <p class="note">This is a protected intent that can only be sent
2432 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002433 */
2434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2435 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2436 /**
2437 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002438 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002439 * <p class="note">This is a protected intent that can only be sent
2440 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002441 */
2442 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2443 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2444 /**
Jake Hambybb371632010-08-23 18:16:48 -07002445 * Broadcast Action: A sticky broadcast that indicates a memory full
2446 * condition on the device. This is intended for activities that want
2447 * to be able to fill the data partition completely, leaving only
2448 * enough free space to prevent system-wide SQLite failures.
2449 *
2450 * <p class="note">This is a protected intent that can only be sent
2451 * by the system.
2452 *
2453 * {@hide}
2454 */
2455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2456 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2457 /**
2458 * Broadcast Action: Indicates memory full condition on the device
2459 * no longer exists.
2460 *
2461 * <p class="note">This is a protected intent that can only be sent
2462 * by the system.
2463 *
2464 * {@hide}
2465 */
2466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2467 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2468 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002469 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2470 * and package management should be started.
2471 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2472 * notification.
2473 */
2474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2475 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2476 /**
2477 * Broadcast Action: The device has entered USB Mass Storage mode.
2478 * This is used mainly for the USB Settings panel.
2479 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2480 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002481 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002482 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002483 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2485
2486 /**
2487 * Broadcast Action: The device has exited USB Mass Storage mode.
2488 * This is used mainly for the USB Settings panel.
2489 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2490 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002491 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002492 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002493 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002494 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2495
2496 /**
2497 * Broadcast Action: External media has been removed.
2498 * The path to the mount point for the removed media is contained in the Intent.mData field.
2499 */
2500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2501 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2502
2503 /**
2504 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002505 * 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 -07002506 */
2507 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2508 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2509
2510 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002511 * Broadcast Action: External media is present, and being disk-checked
2512 * 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 -08002513 */
2514 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2515 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2516
2517 /**
2518 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2519 * 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 -08002520 */
2521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2522 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2523
2524 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002525 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002526 * 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 -07002527 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2528 * media was mounted read only.
2529 */
2530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2531 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2532
2533 /**
2534 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002535 * 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 -07002536 */
2537 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2538 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2539
2540 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002541 * Broadcast Action: External media is no longer being shared via USB mass storage.
2542 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2543 *
2544 * @hide
2545 */
2546 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2547
2548 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2550 * The path to the mount point for the removed media is contained in the Intent.mData field.
2551 */
2552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2553 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2554
2555 /**
2556 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002557 * 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 -07002558 */
2559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2560 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2561
2562 /**
2563 * Broadcast Action: User has expressed the desire to remove the external storage media.
2564 * Applications should close all files they have open within the mount point when they receive this intent.
2565 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2569
2570 /**
2571 * Broadcast Action: The media scanner has started scanning a directory.
2572 * The path to the directory being scanned is contained in the Intent.mData field.
2573 */
2574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2575 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2576
2577 /**
2578 * Broadcast Action: The media scanner has finished scanning a directory.
2579 * The path to the scanned directory is contained in the Intent.mData field.
2580 */
2581 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2582 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2583
2584 /**
2585 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2586 * The path to the file is contained in the Intent.mData field.
2587 */
2588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2589 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2590
2591 /**
2592 * Broadcast Action: The "Media Button" was pressed. Includes a single
2593 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2594 * caused the broadcast.
2595 */
2596 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2597 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2598
2599 /**
2600 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2601 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2602 * caused the broadcast.
2603 */
2604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2605 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2606
2607 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2608 // location; they are not general-purpose actions.
2609
2610 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002611 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002612 */
2613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2614 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2615 "android.intent.action.GTALK_CONNECTED";
2616
2617 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002618 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002619 */
2620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2621 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2622 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002623
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002624 /**
2625 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002626 */
2627 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2628 public static final String ACTION_INPUT_METHOD_CHANGED =
2629 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002630
2631 /**
2632 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2633 * more radios have been turned off or on. The intent will have the following extra value:</p>
2634 * <ul>
2635 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2636 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2637 * turned off</li>
2638 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002639 *
Peng Xua35b5532016-01-20 00:05:45 -08002640 * <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 -07002641 */
2642 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2643 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2644
2645 /**
2646 * Broadcast Action: Some content providers have parts of their namespace
2647 * where they publish new events or items that the user may be especially
2648 * interested in. For these things, they may broadcast this action when the
2649 * set of interesting items change.
2650 *
2651 * For example, GmailProvider sends this notification when the set of unread
2652 * mail in the inbox changes.
2653 *
2654 * <p>The data of the intent identifies which part of which provider
2655 * changed. When queried through the content resolver, the data URI will
2656 * return the data set in question.
2657 *
2658 * <p>The intent will have the following extra values:
2659 * <ul>
2660 * <li><em>count</em> - The number of items in the data set. This is the
2661 * same as the number of items in the cursor returned by querying the
2662 * data URI. </li>
2663 * </ul>
2664 *
2665 * This intent will be sent at boot (if the count is non-zero) and when the
2666 * data set changes. It is possible for the data set to change without the
2667 * count changing (for example, if a new unread message arrives in the same
2668 * sync operation in which a message is archived). The phone should still
2669 * ring/vibrate/etc as normal in this case.
2670 */
2671 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2672 public static final String ACTION_PROVIDER_CHANGED =
2673 "android.intent.action.PROVIDER_CHANGED";
2674
2675 /**
2676 * Broadcast Action: Wired Headset plugged in or unplugged.
2677 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002678 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2679 * and documentation.
2680 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002681 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002682 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002683 */
2684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002685 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002686
2687 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002688 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2689 * <ul>
2690 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2691 * </ul>
2692 *
2693 * <p class="note">This is a protected intent that can only be sent
2694 * by the system.
2695 *
2696 * @hide
2697 */
2698 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2699 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2700 = "android.intent.action.ADVANCED_SETTINGS";
2701
2702 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002703 * Broadcast Action: Sent after application restrictions are changed.
2704 *
2705 * <p class="note">This is a protected intent that can only be sent
2706 * by the system.</p>
2707 */
2708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2709 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2710 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2711
2712 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 * Broadcast Action: An outgoing call is about to be placed.
2714 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002715 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002716 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002717 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002718 * the phone number originally intended to be dialed.</li>
2719 * </ul>
2720 * <p>Once the broadcast is finished, the resultData is used as the actual
2721 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002722 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002723 * outgoing call in turn: for example, a parental control application
2724 * might verify that the user is authorized to place the call at that
2725 * time, then a number-rewriting application might add an area code if
2726 * one was not specified.</p>
2727 * <p>For consistency, any receiver whose purpose is to prohibit phone
2728 * calls should have a priority of 0, to ensure it will see the final
2729 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002730 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 * should have a positive priority.
2732 * Negative priorities are reserved for the system for this broadcast;
2733 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002734 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2735 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002736 * <p>Emergency calls cannot be intercepted using this mechanism, and
2737 * other calls cannot be modified to call emergency numbers using this
2738 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002739 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2740 * call to use their own service instead. Those apps should first prevent
2741 * the call from being placed by setting resultData to <code>null</code>
2742 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002743 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002744 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2745 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002746 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002747 * <p class="note">This is a protected intent that can only be sent
2748 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002749 */
2750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2751 public static final String ACTION_NEW_OUTGOING_CALL =
2752 "android.intent.action.NEW_OUTGOING_CALL";
2753
2754 /**
2755 * Broadcast Action: Have the device reboot. This is only for use by
2756 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002757 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002758 * <p class="note">This is a protected intent that can only be sent
2759 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002760 */
2761 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2762 public static final String ACTION_REBOOT =
2763 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002764
Wei Huang97ecc9c2009-05-11 17:44:20 -07002765 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002766 * Broadcast Action: A sticky broadcast for changes in the physical
2767 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002768 *
2769 * <p>The intent will have the following extra values:
2770 * <ul>
2771 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002772 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002773 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002774 * <p>This is intended for monitoring the current physical dock state.
2775 * See {@link android.app.UiModeManager} for the normal API dealing with
2776 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002777 */
2778 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2779 public static final String ACTION_DOCK_EVENT =
2780 "android.intent.action.DOCK_EVENT";
2781
2782 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002783 * Broadcast Action: A broadcast when idle maintenance can be started.
2784 * This means that the user is not interacting with the device and is
2785 * not expected to do so soon. Typical use of the idle maintenance is
2786 * to perform somehow expensive tasks that can be postponed at a moment
2787 * when they will not degrade user experience.
2788 * <p>
2789 * <p class="note">In order to keep the device responsive in case of an
2790 * unexpected user interaction, implementations of a maintenance task
2791 * should be interruptible. In such a scenario a broadcast with action
2792 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2793 * should not do the maintenance work in
2794 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2795 * maintenance service by {@link Context#startService(Intent)}. Also
2796 * you should hold a wake lock while your maintenance service is running
2797 * to prevent the device going to sleep.
2798 * </p>
2799 * <p>
2800 * <p class="note">This is a protected intent that can only be sent by
2801 * the system.
2802 * </p>
2803 *
2804 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002805 *
2806 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002807 */
2808 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2809 public static final String ACTION_IDLE_MAINTENANCE_START =
2810 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2811
2812 /**
2813 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2814 * This means that the user was not interacting with the device as a result
2815 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2816 * was sent and now the user started interacting with the device. Typical
2817 * use of the idle maintenance is to perform somehow expensive tasks that
2818 * can be postponed at a moment when they will not degrade user experience.
2819 * <p>
2820 * <p class="note">In order to keep the device responsive in case of an
2821 * unexpected user interaction, implementations of a maintenance task
2822 * should be interruptible. Hence, on receiving a broadcast with this
2823 * action, the maintenance task should be interrupted as soon as possible.
2824 * In other words, you should not do the maintenance work in
2825 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2826 * maintenance service that was started on receiving of
2827 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2828 * lock you acquired when your maintenance service started.
2829 * </p>
2830 * <p class="note">This is a protected intent that can only be sent
2831 * by the system.
2832 *
2833 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002834 *
2835 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002836 */
2837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2838 public static final String ACTION_IDLE_MAINTENANCE_END =
2839 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2840
2841 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002842 * Broadcast Action: a remote intent is to be broadcasted.
2843 *
2844 * A remote intent is used for remote RPC between devices. The remote intent
2845 * is serialized and sent from one device to another device. The receiving
2846 * device parses the remote intent and broadcasts it. Note that anyone can
2847 * broadcast a remote intent. However, if the intent receiver of the remote intent
2848 * does not trust intent broadcasts from arbitrary intent senders, it should require
2849 * the sender to hold certain permissions so only trusted sender's broadcast will be
2850 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002851 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002852 */
2853 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002854 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002855
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002856 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002857 * Broadcast Action: This is broadcast once when the user is booting after a
2858 * system update. It can be used to perform cleanup or upgrades after a
2859 * system update.
2860 * <p>
2861 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2862 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2863 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2864 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002865 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002866 * @hide
2867 */
2868 public static final String ACTION_PRE_BOOT_COMPLETED =
2869 "android.intent.action.PRE_BOOT_COMPLETED";
2870
Amith Yamasani13593602012-03-22 16:16:17 -07002871 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002872 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002873 * on restricted users. The broadcast intent contains an extra
2874 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2875 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2876 * String[] depending on the restriction type.<p/>
2877 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002878 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2879 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2880 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002881 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2882 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002883 * @see RestrictionEntry
2884 */
2885 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2886 "android.intent.action.GET_RESTRICTION_ENTRIES";
2887
2888 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002889 * Sent the first time a user is starting, to allow system apps to
2890 * perform one time initialization. (This will not be seen by third
2891 * party applications because a newly initialized user does not have any
2892 * third party applications installed for it.) This is sent early in
2893 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002894 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2895 * broadcast, since it is part of a visible user interaction; be as quick
2896 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002897 */
2898 public static final String ACTION_USER_INITIALIZE =
2899 "android.intent.action.USER_INITIALIZE";
2900
2901 /**
2902 * Sent when a user switch is happening, causing the process's user to be
2903 * brought to the foreground. This is only sent to receivers registered
2904 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2905 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002906 * foreground. This is sent as a foreground
2907 * broadcast, since it is part of a visible user interaction; be as quick
2908 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002909 */
2910 public static final String ACTION_USER_FOREGROUND =
2911 "android.intent.action.USER_FOREGROUND";
2912
2913 /**
2914 * Sent when a user switch is happening, causing the process's user to be
2915 * sent to the background. This is only sent to receivers registered
2916 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2917 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002918 * background. This is sent as a foreground
2919 * broadcast, since it is part of a visible user interaction; be as quick
2920 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002921 */
2922 public static final String ACTION_USER_BACKGROUND =
2923 "android.intent.action.USER_BACKGROUND";
2924
2925 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002926 * Broadcast sent to the system when a user is added. Carries an extra
2927 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2928 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002929 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002930 * @hide
2931 */
2932 public static final String ACTION_USER_ADDED =
2933 "android.intent.action.USER_ADDED";
2934
2935 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002936 * Broadcast sent by the system when a user is started. Carries an extra
2937 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002938 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002939 * that has been started. This is sent as a foreground
2940 * broadcast, since it is part of a visible user interaction; be as quick
2941 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002942 * @hide
2943 */
2944 public static final String ACTION_USER_STARTED =
2945 "android.intent.action.USER_STARTED";
2946
2947 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002948 * Broadcast sent when a user is in the process of starting. Carries an extra
2949 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2950 * sent to registered receivers, not manifest receivers. It is sent to all
2951 * users (including the one that is being started). You must hold
2952 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2953 * this broadcast. This is sent as a background broadcast, since
2954 * its result is not part of the primary UX flow; to safely keep track of
2955 * started/stopped state of a user you can use this in conjunction with
2956 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2957 * other user state broadcasts since those are foreground broadcasts so can
2958 * execute in a different order.
2959 * @hide
2960 */
2961 public static final String ACTION_USER_STARTING =
2962 "android.intent.action.USER_STARTING";
2963
2964 /**
2965 * Broadcast sent when a user is going to be stopped. Carries an extra
2966 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2967 * sent to registered receivers, not manifest receivers. It is sent to all
2968 * users (including the one that is being stopped). You must hold
2969 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2970 * this broadcast. The user will not stop until all receivers have
2971 * handled the broadcast. This is sent as a background broadcast, since
2972 * its result is not part of the primary UX flow; to safely keep track of
2973 * started/stopped state of a user you can use this in conjunction with
2974 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2975 * other user state broadcasts since those are foreground broadcasts so can
2976 * execute in a different order.
2977 * @hide
2978 */
2979 public static final String ACTION_USER_STOPPING =
2980 "android.intent.action.USER_STOPPING";
2981
2982 /**
2983 * Broadcast sent to the system when a user is stopped. Carries an extra
2984 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2985 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2986 * specific package. This is only sent to registered receivers, not manifest
2987 * receivers. It is sent to all running users <em>except</em> the one that
2988 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002989 * @hide
2990 */
2991 public static final String ACTION_USER_STOPPED =
2992 "android.intent.action.USER_STOPPED";
2993
2994 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002995 * 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 -07002996 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002997 * one that has been removed. The user will not be completely removed until all receivers have
2998 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002999 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003000 * @hide
3001 */
3002 public static final String ACTION_USER_REMOVED =
3003 "android.intent.action.USER_REMOVED";
3004
3005 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003006 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003007 * the userHandle of the user to become the current one. This is only sent to
3008 * registered receivers, not manifest receivers. It is sent to all running users.
3009 * You must hold
3010 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003011 * @hide
3012 */
3013 public static final String ACTION_USER_SWITCHED =
3014 "android.intent.action.USER_SWITCHED";
3015
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003016 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003017 * Broadcast Action: Sent when the credential-encrypted private storage has
3018 * become unlocked for the target user. This is only sent to registered
3019 * receivers, not manifest receivers.
3020 */
3021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3022 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3023
3024 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003025 * Broadcast sent to the system when a user's information changes. Carries an extra
3026 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003027 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003028 * @hide
3029 */
3030 public static final String ACTION_USER_INFO_CHANGED =
3031 "android.intent.action.USER_INFO_CHANGED";
3032
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003033 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003034 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3035 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003036 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3037 * that need to display merged content across both primary and managed profiles need to
3038 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003039 * not manifest receivers.
3040 */
3041 public static final String ACTION_MANAGED_PROFILE_ADDED =
3042 "android.intent.action.MANAGED_PROFILE_ADDED";
3043
3044 /**
3045 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003046 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3047 * Only applications (for example Launchers) that need to display merged content across both
3048 * primary and managed profiles need to worry about this broadcast. This is only sent to
3049 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003050 */
3051 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3052 "android.intent.action.MANAGED_PROFILE_REMOVED";
3053
3054 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003055 * Broadcast sent to the primary user when the credential-encrypted private storage for
3056 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3057 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3058 * Launchers) that need to display merged content across both primary and managed profiles
3059 * need to worry about this broadcast. This is only sent to registered receivers,
3060 * not manifest receivers.
3061 */
3062 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3063 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3064
3065 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003066 * Broadcast sent to the primary user when an associated managed profile has become available.
3067 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003068 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3069 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3070 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003071 */
Rubin Xue95057a2016-04-01 16:49:25 +01003072 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3073 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3074
3075 /**
3076 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3077 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3078 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3079 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3080 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3081 */
3082 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3083 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003084
3085 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003086 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3087 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3088 * the device was locked or unlocked.
3089 *
3090 * This is only sent to registered receivers.
3091 *
3092 * @hide
3093 */
3094 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3095 "android.intent.action.DEVICE_LOCKED_CHANGED";
3096
3097 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003098 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3099 */
3100 public static final String ACTION_QUICK_CLOCK =
3101 "android.intent.action.QUICK_CLOCK";
3102
Michael Wright0087a142013-02-05 16:29:39 -08003103 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003104 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003105 * @hide
3106 */
3107 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3108 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3109
Justin Kohd378ad72013-04-01 12:18:26 -07003110 /**
3111 * Broadcast Action: A global button was pressed. Includes a single
3112 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3113 * caused the broadcast.
3114 * @hide
3115 */
3116 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3117
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003118 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003119 * Broadcast Action: Sent when media resource is granted.
3120 * <p>
3121 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3122 * granted.
3123 * </p>
3124 * <p class="note">
3125 * This is a protected intent that can only be sent by the system.
3126 * </p>
3127 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003128 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003129 * </p>
3130 *
3131 * @hide
3132 */
3133 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3134 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3135
3136 /**
MÃ¥rten Kongstadeabc9e92015-12-15 16:40:23 +01003137 * Broadcast Action: An overlay package has been installed. The data
3138 * contains the name of the added overlay package.
3139 * @hide
3140 */
3141 public static final String ACTION_OVERLAY_ADDED = "android.intent.action.OVERLAY_ADDED";
3142
3143 /**
3144 * Broadcast Action: An overlay package has changed. The data contains the
3145 * name of the overlay package which has changed. This is broadcast on all
3146 * changes to the OverlayInfo returned by {@link
3147 * android.content.om.IOverlayManager#getOverlayInfo(String, int)}. The
3148 * most common change is a state change that will change whether the
3149 * overlay is enabled or not.
3150 * @hide
3151 */
3152 public static final String ACTION_OVERLAY_CHANGED = "android.intent.action.OVERLAY_CHANGED";
3153
3154 /**
3155 * Broadcast Action: An overlay package has been removed. The data contains
3156 * the name of the overlay package which has been removed.
3157 * @hide
3158 */
3159 public static final String ACTION_OVERLAY_REMOVED = "android.intent.action.OVERLAY_REMOVED";
3160
3161 /**
3162 * Broadcast Action: The order of a package's list of overlay packages has
3163 * changed. The data contains the package name of the overlay package that
3164 * had its position in the list adjusted.
3165 * @hide
3166 */
3167 public static final String
3168 ACTION_OVERLAY_PRIORITY_CHANGED = "android.intent.action.OVERLAY_PRIORITY_CHANGED";
3169
3170 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003171 * Activity Action: Allow the user to select and return one or more existing
3172 * documents. When invoked, the system will display the various
3173 * {@link DocumentsProvider} instances installed on the device, letting the
3174 * user interactively navigate through them. These documents include local
3175 * media, such as photos and video, and documents provided by installed
3176 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003177 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003178 * Each document is represented as a {@code content://} URI backed by a
3179 * {@link DocumentsProvider}, which can be opened as a stream with
3180 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3181 * {@link android.provider.DocumentsContract.Document} metadata.
3182 * <p>
3183 * All selected documents are returned to the calling application with
3184 * persistable read and write permission grants. If you want to maintain
3185 * access to the documents across device reboots, you need to explicitly
3186 * take the persistable permissions using
3187 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3188 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003189 * Callers must indicate the acceptable document MIME types through
3190 * {@link #setType(String)}. For example, to select photos, use
3191 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3192 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3193 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003194 * <p>
3195 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003196 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3197 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003198 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003199 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3200 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003201 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003202 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003203 * Callers can set a document URI through
3204 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3205 * location of documents navigator. System will do its best to launch the
3206 * navigator in the specified document if it's a folder, or the folder that
3207 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003208 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003209 * Output: The URI of the item that was picked, returned in
3210 * {@link #getData()}. This must be a {@code content://} URI so that any
3211 * receiver can access it. If multiple documents were selected, they are
3212 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003213 *
3214 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003215 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003216 * @see #ACTION_CREATE_DOCUMENT
3217 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003218 */
3219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3220 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3221
3222 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003223 * Activity Action: Allow the user to create a new document. When invoked,
3224 * the system will display the various {@link DocumentsProvider} instances
3225 * installed on the device, letting the user navigate through them. The
3226 * returned document may be a newly created document with no content, or it
3227 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003228 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003229 * Each document is represented as a {@code content://} URI backed by a
3230 * {@link DocumentsProvider}, which can be opened as a stream with
3231 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3232 * {@link android.provider.DocumentsContract.Document} metadata.
3233 * <p>
3234 * Callers must indicate the concrete MIME type of the document being
3235 * created by setting {@link #setType(String)}. This MIME type cannot be
3236 * changed after the document is created.
3237 * <p>
3238 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3239 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003240 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003241 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3242 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003243 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003244 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003245 * Callers can set a document URI through
3246 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3247 * location of documents navigator. System will do its best to launch the
3248 * navigator in the specified document if it's a folder, or the folder that
3249 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003250 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003251 * Output: The URI of the item that was created. This must be a
3252 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003253 *
3254 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003255 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003256 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003257 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003258 */
3259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3260 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3261
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003262 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003263 * Activity Action: Allow the user to pick a directory subtree. When
3264 * invoked, the system will display the various {@link DocumentsProvider}
3265 * instances installed on the device, letting the user navigate through
3266 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003267 * <p>
3268 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003269 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3270 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3271 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003272 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003273 * Callers can set a document URI through
3274 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3275 * location of documents navigator. System will do its best to launch the
3276 * navigator in the specified document if it's a folder, or the folder that
3277 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003278 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003279 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003280 *
3281 * @see DocumentsContract
3282 */
3283 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003284 public static final String
3285 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003286
Felipe Lemec7b1f892016-01-15 15:02:31 -08003287 /**
Peng Xua35b5532016-01-20 00:05:45 -08003288 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3289 * exisiting sensor being disconnected.
3290 *
3291 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3292 *
3293 * {@hide}
3294 */
3295 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3296 public static final String
3297 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3298
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003299 /**
3300 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3301 *
3302 * {@hide}
3303 */
3304 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003305 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3306
Christopher Tate6597e342015-02-17 12:15:25 -08003307 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003308 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3309 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3310 *
3311 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3312 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003313 * @hide
3314 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003315 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003316 public static final String EXTRA_FORCE_MASTER_CLEAR =
3317 "android.intent.extra.FORCE_MASTER_CLEAR";
3318
3319 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003320 * A broadcast action to trigger a factory reset.
3321 *
3322 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3323 *
3324 * <p>Not for use by third-party applications.
3325 *
3326 * @see #EXTRA_FORCE_MASTER_CLEAR
3327 *
3328 * {@hide}
3329 */
3330 @SystemApi
3331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3332 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3333
3334 /**
3335 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3336 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3337 *
3338 * <p>Not for use by third-party applications.
3339 *
3340 * @hide
3341 */
3342 @SystemApi
3343 public static final String EXTRA_FORCE_FACTORY_RESET =
3344 "android.intent.extra.FORCE_FACTORY_RESET";
3345
3346 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003347 * Broadcast action: report that a settings element is being restored from backup. The intent
3348 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3349 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3350 * is the value of that settings entry prior to the restore operation. All of these values are
3351 * represented as strings.
3352 *
3353 * <p>This broadcast is sent only for settings provider entries known to require special handling
3354 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3355 * the provider's backup agent implementation.
3356 *
3357 * @see #EXTRA_SETTING_NAME
3358 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3359 * @see #EXTRA_SETTING_NEW_VALUE
3360 * {@hide}
3361 */
3362 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3363
3364 /** {@hide} */
3365 public static final String EXTRA_SETTING_NAME = "setting_name";
3366 /** {@hide} */
3367 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3368 /** {@hide} */
3369 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3370
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003371 /**
3372 * Activity Action: Process a piece of text.
3373 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3374 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3375 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3376 */
3377 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3378 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3379 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003380 * The name of the extra used to define the text to be processed, as a
3381 * CharSequence. Note that this may be a styled CharSequence, so you must use
3382 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003383 */
3384 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3385 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003386 * 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 +00003387 */
3388 public static final String EXTRA_PROCESS_TEXT_READONLY =
3389 "android.intent.extra.PROCESS_TEXT_READONLY";
3390
Bryce Leebc58f592015-09-25 16:43:01 -07003391 /**
3392 * Broadcast action: reports when a new thermal event has been reached. When the device
3393 * is reaching its maximum temperatue, the thermal level reported
3394 * {@hide}
3395 */
3396 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3397 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3398
3399 /** {@hide} */
3400 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3401
3402 /**
3403 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003404 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003405 * {@hide}
3406 */
3407 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3408
3409 /**
3410 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003411 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003412 * {@hide}
3413 */
3414 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3415
3416 /**
3417 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003418 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003419 * {@hide}
3420 */
3421 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3422
3423
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 // ---------------------------------------------------------------------
3425 // ---------------------------------------------------------------------
3426 // Standard intent categories (see addCategory()).
3427
3428 /**
3429 * Set if the activity should be an option for the default action
3430 * (center press) to perform on a piece of data. Setting this will
3431 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003432 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003433 * Intent when initiating an action -- it is for use in intent filters
3434 * specified in packages.
3435 */
3436 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3437 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3438 /**
3439 * Activities that can be safely invoked from a browser must support this
3440 * category. For example, if the user is viewing a web page or an e-mail
3441 * and clicks on a link in the text, the Intent generated execute that
3442 * link will require the BROWSABLE category, so that only activities
3443 * supporting this category will be considered as possible actions. By
3444 * supporting this category, you are promising that there is nothing
3445 * damaging (without user intervention) that can happen by invoking any
3446 * matching Intent.
3447 */
3448 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3449 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3450 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003451 * Categories for activities that can participate in voice interaction.
3452 * An activity that supports this category must be prepared to run with
3453 * no UI shown at all (though in some case it may have a UI shown), and
3454 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3455 */
3456 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3457 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3458 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003459 * Set if the activity should be considered as an alternative action to
3460 * the data the user is currently viewing. See also
3461 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3462 * applies to the selection in a list of items.
3463 *
3464 * <p>Supporting this category means that you would like your activity to be
3465 * displayed in the set of alternative things the user can do, usually as
3466 * part of the current activity's options menu. You will usually want to
3467 * include a specific label in the &lt;intent-filter&gt; of this action
3468 * describing to the user what it does.
3469 *
3470 * <p>The action of IntentFilter with this category is important in that it
3471 * describes the specific action the target will perform. This generally
3472 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3473 * a specific name such as "com.android.camera.action.CROP. Only one
3474 * alternative of any particular action will be shown to the user, so using
3475 * a specific action like this makes sure that your alternative will be
3476 * displayed while also allowing other applications to provide their own
3477 * overrides of that particular action.
3478 */
3479 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3480 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3481 /**
3482 * Set if the activity should be considered as an alternative selection
3483 * action to the data the user has currently selected. This is like
3484 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3485 * of items from which the user can select, giving them alternatives to the
3486 * default action that will be performed on it.
3487 */
3488 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3489 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3490 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003491 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003492 */
3493 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3494 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3495 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003496 * Should be displayed in the top-level launcher.
3497 */
3498 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3499 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3500 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003501 * Indicates an activity optimized for Leanback mode, and that should
3502 * be displayed in the Leanback launcher.
3503 */
3504 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3505 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3506 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003507 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3508 * @hide
3509 */
3510 @SystemApi
3511 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3512 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003513 * Provides information about the package it is in; typically used if
3514 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3515 * a front-door to the user without having to be shown in the all apps list.
3516 */
3517 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3518 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3519 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003520 * This is the home activity, that is the first activity that is displayed
3521 * when the device boots.
3522 */
3523 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3524 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3525 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003526 * This is the home activity that is displayed when the device is finished setting up and ready
3527 * for use.
3528 * @hide
3529 */
3530 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3531 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3532 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003533 * This is the setup wizard activity, that is the first activity that is displayed
3534 * when the user sets up the device for the first time.
3535 * @hide
3536 */
3537 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3538 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3539 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540 * This activity is a preference panel.
3541 */
3542 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3543 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3544 /**
3545 * This activity is a development preference panel.
3546 */
3547 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3548 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3549 /**
3550 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003551 */
3552 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3553 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3554 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003555 * This activity allows the user to browse and download new applications.
3556 */
3557 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3558 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3559 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003560 * This activity may be exercised by the monkey or other automated test tools.
3561 */
3562 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3563 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3564 /**
3565 * To be used as a test (not part of the normal user experience).
3566 */
3567 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3568 /**
3569 * To be used as a unit test (run through the Test Harness).
3570 */
3571 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3572 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003573 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003574 * experience).
3575 */
3576 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003577
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003578 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003579 * Used to indicate that an intent only wants URIs that can be opened with
3580 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3581 * must support at least the columns defined in {@link OpenableColumns} when
3582 * queried.
3583 *
3584 * @see #ACTION_GET_CONTENT
3585 * @see #ACTION_OPEN_DOCUMENT
3586 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003587 */
3588 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3589 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3590
3591 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003592 * Used to indicate that an intent filter can accept files which are not necessarily
3593 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3594 * at least streamable via
3595 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3596 * using one of the stream types exposed via
3597 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3598 *
3599 * @see #ACTION_SEND
3600 * @see #ACTION_SEND_MULTIPLE
3601 */
3602 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3603 public static final String CATEGORY_TYPED_OPENABLE =
3604 "android.intent.category.TYPED_OPENABLE";
3605
3606 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003607 * To be used as code under test for framework instrumentation tests.
3608 */
3609 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3610 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003611 /**
3612 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003613 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3614 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003615 */
3616 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3617 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3618 /**
3619 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003620 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3621 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003622 */
3623 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3624 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003625 /**
3626 * An activity to run when device is inserted into a analog (low end) dock.
3627 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3628 * information, see {@link android.app.UiModeManager}.
3629 */
3630 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3631 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3632
3633 /**
3634 * An activity to run when device is inserted into a digital (high end) dock.
3635 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3636 * information, see {@link android.app.UiModeManager}.
3637 */
3638 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3639 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003640
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003641 /**
3642 * Used to indicate that the activity can be used in a car environment.
3643 */
3644 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3645 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3646
Zak Cohendb6ca492017-01-26 14:09:00 -08003647 /**
3648 * An activity to use for the launcher when the device is placed in a VR Headset viewer.
3649 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3650 * information, see {@link android.app.UiModeManager}.
3651 */
3652 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3653 public static final String CATEGORY_VR_HOME = "android.intent.category.VR_HOME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003654 // ---------------------------------------------------------------------
3655 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003656 // Application launch intent categories (see addCategory()).
3657
3658 /**
3659 * Used with {@link #ACTION_MAIN} to launch the browser application.
3660 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003661 * <p>NOTE: This should not be used as the primary key of an Intent,
3662 * since it will not result in the app launching with the correct
3663 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003664 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003665 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003666 */
3667 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3668 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3669
3670 /**
3671 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3672 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003673 * <p>NOTE: This should not be used as the primary key of an Intent,
3674 * since it will not result in the app launching with the correct
3675 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003676 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003677 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003678 */
3679 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3680 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3681
3682 /**
3683 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3684 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003685 * <p>NOTE: This should not be used as the primary key of an Intent,
3686 * since it will not result in the app launching with the correct
3687 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003688 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003689 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003690 */
3691 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3692 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3693
3694 /**
3695 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3696 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003697 * <p>NOTE: This should not be used as the primary key of an Intent,
3698 * since it will not result in the app launching with the correct
3699 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003700 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003701 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003702 */
3703 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3704 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3705
3706 /**
3707 * Used with {@link #ACTION_MAIN} to launch the email application.
3708 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003709 * <p>NOTE: This should not be used as the primary key of an Intent,
3710 * since it will not result in the app launching with the correct
3711 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003712 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003713 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003714 */
3715 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3716 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3717
3718 /**
3719 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3720 * The activity should be able to view and manipulate image and video files
3721 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003722 * <p>NOTE: This should not be used as the primary key of an Intent,
3723 * since it will not result in the app launching with the correct
3724 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003725 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003726 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003727 */
3728 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3729 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3730
3731 /**
3732 * Used with {@link #ACTION_MAIN} to launch the maps application.
3733 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003734 * <p>NOTE: This should not be used as the primary key of an Intent,
3735 * since it will not result in the app launching with the correct
3736 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003737 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003738 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003739 */
3740 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3741 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3742
3743 /**
3744 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3745 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003746 * <p>NOTE: This should not be used as the primary key of an Intent,
3747 * since it will not result in the app launching with the correct
3748 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003749 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003750 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003751 */
3752 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3753 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3754
3755 /**
3756 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003757 * The activity should be able to play, browse, or manipulate music files
3758 * stored on the device.
3759 * <p>NOTE: This should not be used as the primary key of an Intent,
3760 * since it will not result in the app launching with the correct
3761 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003762 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003763 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003764 */
3765 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3766 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3767
3768 // ---------------------------------------------------------------------
3769 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003770 // Standard extra data keys.
3771
3772 /**
3773 * The initial data to place in a newly created record. Use with
3774 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3775 * fields as would be given to the underlying ContentProvider.insert()
3776 * call.
3777 */
3778 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3779
3780 /**
3781 * A constant CharSequence that is associated with the Intent, used with
3782 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3783 * this may be a styled CharSequence, so you must use
3784 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3785 * retrieve it.
3786 */
3787 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3788
3789 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003790 * A constant String that is associated with the Intent, used with
3791 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3792 * as HTML formatted text. Note that you <em>must</em> also supply
3793 * {@link #EXTRA_TEXT}.
3794 */
3795 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3796
3797 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003798 * A content: URI holding a stream of data associated with the Intent,
3799 * used with {@link #ACTION_SEND} to supply the data being sent.
3800 */
3801 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3802
3803 /**
3804 * A String[] holding e-mail addresses that should be delivered to.
3805 */
3806 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3807
3808 /**
3809 * A String[] holding e-mail addresses that should be carbon copied.
3810 */
3811 public static final String EXTRA_CC = "android.intent.extra.CC";
3812
3813 /**
3814 * A String[] holding e-mail addresses that should be blind carbon copied.
3815 */
3816 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3817
3818 /**
3819 * A constant string holding the desired subject line of a message.
3820 */
3821 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3822
3823 /**
3824 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003825 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003826 */
3827 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3828
3829 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003830 * An int representing the user id to be used.
3831 *
3832 * @hide
3833 */
3834 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3835
3836 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003837 * An int representing the task id to be retrieved. This is used when a launch from recents is
3838 * intercepted by another action such as credentials confirmation to remember which task should
3839 * be resumed when complete.
3840 *
3841 * @hide
3842 */
3843 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3844
3845 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003846 * An Intent[] describing additional, alternate choices you would like shown with
3847 * {@link #ACTION_CHOOSER}.
3848 *
3849 * <p>An app may be capable of providing several different payload types to complete a
3850 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3851 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3852 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3853 * photo data or a hosted link where the photos can be viewed.</p>
3854 *
3855 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3856 * first/primary/preferred intent in the set. Additional intents specified in
3857 * this extra are ordered; by default intents that appear earlier in the array will be
3858 * preferred over intents that appear later in the array as matches for the same
3859 * target component. To alter this preference, a calling app may also supply
3860 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3861 */
3862 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3863
3864 /**
Adam Powell52c39212016-04-07 15:14:18 -07003865 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3866 * and omitted from a list of components presented to the user.
3867 *
3868 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3869 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3870 * from your own package or other apps from your organization if the idea of sending to those
3871 * targets would be redundant with other app functionality. Filtered components will not
3872 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3873 */
3874 public static final String EXTRA_EXCLUDE_COMPONENTS
3875 = "android.intent.extra.EXCLUDE_COMPONENTS";
3876
3877 /**
3878 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3879 * describing additional high-priority deep-link targets for the chooser to present to the user.
3880 *
3881 * <p>Targets provided in this way will be presented inline with all other targets provided
3882 * by services from other apps. They will be prioritized before other service targets, but
3883 * after those targets provided by sources that the user has manually pinned to the front.</p>
3884 *
3885 * @see #ACTION_CHOOSER
3886 */
3887 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3888
3889 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003890 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3891 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3892 *
3893 * <p>An app preparing an action for another app to complete may wish to allow the user to
3894 * disambiguate between several options for completing the action based on the chosen target
3895 * or otherwise refine the action before it is invoked.
3896 * </p>
3897 *
3898 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3899 * <ul>
3900 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3901 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3902 * chosen target beyond the first</li>
3903 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3904 * should fill in and send once the disambiguation is complete</li>
3905 * </ul>
3906 */
3907 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3908 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3909
3910 /**
Kang Li9fa2a2c2017-01-06 13:33:24 -08003911 * An {@code ArrayList} of {@code String} annotations describing content for
3912 * {@link #ACTION_CHOOSER}.
3913 *
3914 * <p>If {@link #EXTRA_CONTENT_ANNOTATIONS} is present in an intent used to start a
3915 * {@link #ACTION_CHOOSER} activity, the first three annotations will be used to rank apps.</p>
3916 *
3917 * <p>Annotations should describe the major components or topics of the content. It is up to
3918 * apps initiating {@link #ACTION_CHOOSER} to learn and add annotations. Annotations should be
3919 * learned in advance, e.g., when creating or saving content, to avoid increasing latency to
3920 * start {@link #ACTION_CHOOSER}. Performance on customized annotations can suffer, if they are
3921 * rarely used for {@link #ACTION_CHOOSER} in the past 14 days. Therefore, it is recommended to
3922 * use the following annotations when applicable:</p>
3923 * <ul>
3924 * <li>"product": represents that the topic of the content is mainly about products, e.g.,
3925 * health & beauty, and office supplies.</li>
3926 * <li>"emotion": represents that the topic of the content is mainly about emotions, e.g.,
3927 * happy, and sad.</li>
3928 * <li>"person": represents that the topic of the content is mainly about persons, e.g.,
3929 * face, finger, standing, and walking.</li>
3930 * <li>"child": represents that the topic of the content is mainly about children, e.g.,
3931 * child, and baby.</li>
3932 * <li>"selfie": represents that the topic of the content is mainly about selfies.</li>
3933 * <li>"crowd": represents that the topic of the content is mainly about crowds.</li>
3934 * <li>"party": represents that the topic of the content is mainly about parties.</li>
3935 * <li>"animal": represent that the topic of the content is mainly about animals.</li>
3936 * <li>"plant": represents that the topic of the content is mainly about plants, e.g.,
3937 * flowers.</li>
3938 * <li>"vacation": represents that the topic of the content is mainly about vacations.</li>
3939 * <li>"fashion": represents that the topic of the content is mainly about fashion, e.g.
3940 * sunglasses, jewelry, handbags and clothing.</li>
3941 * <li>"material": represents that the topic of the content is mainly about materials, e.g.,
3942 * paper, and silk.</li>
3943 * <li>"vehicle": represents that the topic of the content is mainly about vehicles, like
3944 * cars, and boats.</li>
3945 * <li>"document": represents that the topic of the content is mainly about documents, e.g.
3946 * posters.</li>
3947 * <li>"design": represents that the topic of the content is mainly about design, e.g. arts
3948 * and designs of houses.</li>
3949 * <li>"holiday": represents that the topic of the content is mainly about holidays, e.g.,
3950 * Christmas and Thanksgiving.</li>
3951 * </ul>
3952 */
3953 public static final String EXTRA_CONTENT_ANNOTATIONS
3954 = "android.intent.extra.CONTENT_ANNOTATIONS";
3955
3956 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003957 * A {@link ResultReceiver} used to return data back to the sender.
3958 *
3959 * <p>Used to complete an app-specific
3960 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3961 *
3962 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3963 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3964 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3965 * when the user selects a target component from the chooser. It is up to the recipient
3966 * to send a result to this ResultReceiver to signal that disambiguation is complete
3967 * and that the chooser should invoke the user's choice.</p>
3968 *
3969 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3970 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3971 * to match and fill in the final Intent or ChooserTarget before starting it.
3972 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3973 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3974 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3975 *
3976 * <p>The result code passed to the ResultReceiver should be
3977 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3978 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3979 * the chooser should finish without starting a target.</p>
3980 */
3981 public static final String EXTRA_RESULT_RECEIVER
3982 = "android.intent.extra.RESULT_RECEIVER";
3983
3984 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003985 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003986 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003987 */
3988 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3989
3990 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003991 * A Parcelable[] of {@link Intent} or
3992 * {@link android.content.pm.LabeledIntent} objects as set with
3993 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3994 * a the front of the list of choices, when shown to the user with a
3995 * {@link #ACTION_CHOOSER}.
3996 */
3997 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3998
3999 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08004000 * A {@link IntentSender} to start after ephemeral installation success.
4001 * @hide
4002 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004003 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
4004
4005 /**
4006 * A {@link IntentSender} to start after ephemeral installation failure.
4007 * @hide
4008 */
Todd Kennedy7440f172015-12-09 14:31:22 -08004009 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
4010
4011 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08004012 * The host name that triggered an ephemeral resolution.
4013 * @hide
4014 */
4015 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
4016
4017 /**
4018 * An opaque token to track ephemeral resolution.
4019 * @hide
4020 */
4021 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
4022
4023 /**
Todd Kennedy316c2f22017-01-23 15:40:07 -08004024 * The version code of the app to install components from.
4025 * @hide
4026 */
4027 public static final String EXTRA_VERSION_CODE = "android.intent.extra.VERSION_CODE";
4028
4029 /**
Adam Powelle49d9392014-07-17 18:45:19 -07004030 * A Bundle forming a mapping of potential target package names to different extras Bundles
4031 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
4032 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
4033 * be currently installed on the device.
4034 *
4035 * <p>An application may choose to provide alternate extras for the case where a user
4036 * selects an activity from a predetermined set of target packages. If the activity
4037 * the user selects from the chooser belongs to a package with its package name as
4038 * a key in this bundle, the corresponding extras for that package will be merged with
4039 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
4040 * extra has the same key as an extra already present in the intent it will overwrite
4041 * the extra from the intent.</p>
4042 *
4043 * <p><em>Examples:</em>
4044 * <ul>
4045 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
4046 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
4047 * parameters for that target.</li>
4048 * <li>An application may offer additional metadata for known targets of a given intent
4049 * to pass along information only relevant to that target such as account or content
4050 * identifiers already known to that application.</li>
4051 * </ul></p>
4052 */
4053 public static final String EXTRA_REPLACEMENT_EXTRAS =
4054 "android.intent.extra.REPLACEMENT_EXTRAS";
4055
4056 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07004057 * An {@link IntentSender} that will be notified if a user successfully chooses a target
4058 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
4059 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
4060 * {@link ComponentName} of the chosen component.
4061 *
4062 * <p>In some situations this callback may never come, for example if the user abandons
4063 * the chooser, switches to another task or any number of other reasons. Apps should not
4064 * be written assuming that this callback will always occur.</p>
4065 */
4066 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
4067 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
4068
4069 /**
4070 * The {@link ComponentName} chosen by the user to complete an action.
4071 *
4072 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
4073 */
4074 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
4075
4076 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004077 * A {@link android.view.KeyEvent} object containing the event that
4078 * triggered the creation of the Intent it is in.
4079 */
4080 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
4081
4082 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07004083 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
4084 * before shutting down.
4085 *
4086 * {@hide}
4087 */
4088 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
4089
4090 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07004091 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
4092 * requested by the user.
4093 *
4094 * {@hide}
4095 */
4096 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
4097 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
4098
4099 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004100 * 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 -07004101 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
4102 * of restarting the application.
4103 */
4104 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
4105
4106 /**
4107 * A String holding the phone number originally entered in
4108 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
4109 * number to call in a {@link android.content.Intent#ACTION_CALL}.
4110 */
4111 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02004112
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004113 /**
4114 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
4115 * intents to supply the uid the package had been assigned. Also an optional
4116 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
4117 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
4118 * purpose.
4119 */
4120 public static final String EXTRA_UID = "android.intent.extra.UID";
4121
4122 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004123 * @hide String array of package names.
4124 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08004125 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08004126 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
4127
4128 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004129 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4130 * intents to indicate whether this represents a full uninstall (removing
4131 * both the code and its data) or a partial uninstall (leaving its data,
4132 * implying that this is an update).
4133 */
4134 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004135
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004136 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004137 * @hide
4138 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4139 * intents to indicate that at this point the package has been removed for
4140 * all users on the device.
4141 */
4142 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4143 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4144
4145 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004146 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4147 * intents to indicate that this is a replacement of the package, so this
4148 * broadcast will immediately be followed by an add broadcast for a
4149 * different version of the same package.
4150 */
4151 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004152
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004153 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 * Used as an int extra field in {@link android.app.AlarmManager} intents
4155 * to tell the application being invoked how many pending alarms are being
4156 * delievered with the intent. For one-shot alarms this will always be 1.
4157 * For recurring alarms, this might be greater than 1 if the device was
4158 * asleep or powered off at the time an earlier alarm would have been
4159 * delivered.
4160 */
4161 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004162
Jacek Surazski86b6c532009-05-13 14:38:28 +02004163 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004164 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4165 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004166 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4167 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004168 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4169 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4170 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004171 */
4172 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4173
4174 /**
4175 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4176 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004177 */
4178 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4179
4180 /**
4181 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4182 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004183 */
4184 public static final int EXTRA_DOCK_STATE_DESK = 1;
4185
4186 /**
4187 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4188 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004189 */
4190 public static final int EXTRA_DOCK_STATE_CAR = 2;
4191
4192 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004193 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4194 * to represent that the phone is in a analog (low end) dock.
4195 */
4196 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4197
4198 /**
4199 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4200 * to represent that the phone is in a digital (high end) dock.
4201 */
4202 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4203
4204 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004205 * Boolean that can be supplied as meta-data with a dock activity, to
4206 * indicate that the dock should take over the home key when it is active.
4207 */
4208 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004209
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004210 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004211 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4212 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004213 */
4214 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4215
4216 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004217 * Used in the extra field in the remote intent. It's astring token passed with the
4218 * remote intent.
4219 */
4220 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4221 "android.intent.extra.remote_intent_token";
4222
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004223 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004224 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004225 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004226 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004227 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004228 "android.intent.extra.changed_component_name";
4229
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004230 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004231 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004232 * and contains a string array of all of the components that have changed. If
4233 * the state of the overall package has changed, then it will contain an entry
4234 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004235 */
4236 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4237 "android.intent.extra.changed_component_name_list";
4238
4239 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004240 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004241 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004242 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4243 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4244 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004245 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004246 */
4247 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4248 "android.intent.extra.changed_package_list";
4249
4250 /**
4251 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004252 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4253 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004254 * and contains an integer array of uids of all of the components
4255 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004256 */
4257 public static final String EXTRA_CHANGED_UID_LIST =
4258 "android.intent.extra.changed_uid_list";
4259
4260 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004261 * @hide
4262 * Magic extra system code can use when binding, to give a label for
4263 * who it is that has bound to a service. This is an integer giving
4264 * a framework string resource that can be displayed to the user.
4265 */
4266 public static final String EXTRA_CLIENT_LABEL =
4267 "android.intent.extra.client_label";
4268
4269 /**
4270 * @hide
4271 * Magic extra system code can use when binding, to give a PendingIntent object
4272 * that can be launched for the user to disable the system's use of this
4273 * service.
4274 */
4275 public static final String EXTRA_CLIENT_INTENT =
4276 "android.intent.extra.client_intent";
4277
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004278 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004279 * Extra used to indicate that an intent should only return data that is on
4280 * the local device. This is a boolean extra; the default is false. If true,
4281 * an implementation should only allow the user to select data that is
4282 * already on the device, not requiring it be downloaded from a remote
4283 * service when opened.
4284 *
4285 * @see #ACTION_GET_CONTENT
4286 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004287 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004288 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004289 */
4290 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004291 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004292
Amith Yamasani13593602012-03-22 16:16:17 -07004293 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004294 * Extra used to indicate that an intent can allow the user to select and
4295 * return multiple items. This is a boolean extra; the default is false. If
4296 * true, an implementation is allowed to present the user with a UI where
4297 * they can pick multiple items that are all returned to the caller. When
4298 * this happens, they should be returned as the {@link #getClipData()} part
4299 * of the result Intent.
4300 *
4301 * @see #ACTION_GET_CONTENT
4302 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004303 */
4304 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004305 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004306
4307 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004308 * The integer userHandle carried with broadcast intents related to addition, removal and
4309 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4310 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4311 *
Amith Yamasani13593602012-03-22 16:16:17 -07004312 * @hide
4313 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004314 public static final String EXTRA_USER_HANDLE =
4315 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004316
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004317 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004318 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4319 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4320 */
4321 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004322 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004323
4324 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004325 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004326 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4327 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004328 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004329 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4330
4331 /**
4332 * Extra sent in the intent to the BroadcastReceiver that handles
4333 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4334 * the restrictions as key/value pairs.
4335 */
4336 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4337 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004338
Amith Yamasani86118ba2013-03-28 14:33:16 -07004339 /**
4340 * Extra used in the response from a BroadcastReceiver that handles
4341 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4342 */
4343 public static final String EXTRA_RESTRICTIONS_INTENT =
4344 "android.intent.extra.restrictions_intent";
4345
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004346 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004347 * Extra used to communicate a set of acceptable MIME types. The type of the
4348 * extra is {@code String[]}. Values may be a combination of concrete MIME
4349 * types (such as "image/png") and/or partial MIME types (such as
4350 * "audio/*").
4351 *
4352 * @see #ACTION_GET_CONTENT
4353 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004354 */
4355 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4356
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004357 /**
4358 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4359 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004360 * When this is true, hardware devices can use this information to determine that
4361 * they shouldn't do a complete shutdown of their device since this is not a
4362 * complete shutdown down to the kernel, but only user space restarting.
4363 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004364 */
4365 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4366 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4367
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004368 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004369 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4370 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4371 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4372 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004373 *
4374 * @hide for internal use only.
4375 */
4376 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4377 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004378 /** @hide */
4379 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4380 /** @hide */
4381 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4382 /** @hide */
4383 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004384
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004385 /** {@hide} */
4386 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4387
Rubin Xue8490f12015-06-25 12:17:48 +01004388 /** {@hide} */
4389 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4390
Santos Cordon15a13782015-03-31 18:32:31 -07004391 /**
4392 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4393 * activation request.
4394 * TODO: Add information about the structure and response data used with the pending intent.
4395 * @hide
4396 */
4397 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4398 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4399
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004400 /**
4401 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004402 *
4403 * <p>The value must be an integer greater or equal to 0.
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 /**
4408 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004409 * When a profile goes into quiet mode, all apps in the profile are killed and the
4410 * profile user is stopped. Widgets originating from the profile are masked, and app
4411 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004412 */
4413 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004414
4415 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004416 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004417 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004418 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4419 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004420 *
4421 * @hide
4422 */
4423 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4424 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4425
4426 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004427 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4428 * whether to show the chooser or not when there is only one application available
4429 * to choose from.
4430 *
4431 * @hide
4432 */
4433 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4434 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4435
4436 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004437 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004438 * to represent that a video codec is allowed to use.
4439 *
4440 * @hide
4441 */
4442 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4443
4444 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004445 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004446 * to represent that a audio codec is allowed to use.
4447 *
4448 * @hide
4449 */
4450 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4451
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004452 // ---------------------------------------------------------------------
4453 // ---------------------------------------------------------------------
4454 // Intent flags (see mFlags variable).
4455
Tor Norbyed9273d62013-05-30 15:59:53 -07004456 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004457 @IntDef(flag = true, value = {
4458 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4459 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004460 @Retention(RetentionPolicy.SOURCE)
4461 public @interface GrantUriMode {}
4462
Jeff Sharkey846318a2014-04-04 12:12:41 -07004463 /** @hide */
4464 @IntDef(flag = true, value = {
4465 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4466 @Retention(RetentionPolicy.SOURCE)
4467 public @interface AccessUriMode {}
4468
4469 /**
4470 * Test if given mode flags specify an access mode, which must be at least
4471 * read and/or write.
4472 *
4473 * @hide
4474 */
4475 public static boolean isAccessUriMode(int modeFlags) {
4476 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4477 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4478 }
4479
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004480 /**
4481 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004482 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004483 * specified in its ClipData. When applying to an Intent's ClipData,
4484 * all URIs as well as recursive traversals through data or other ClipData
4485 * in Intent items will be granted; only the grant flags of the top-level
4486 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004487 */
4488 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4489 /**
4490 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004491 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004492 * specified in its ClipData. When applying to an Intent's ClipData,
4493 * all URIs as well as recursive traversals through data or other ClipData
4494 * in Intent items will be granted; only the grant flags of the top-level
4495 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004496 */
4497 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4498 /**
4499 * Can be set by the caller to indicate that this Intent is coming from
4500 * a background operation, not from direct user interaction.
4501 */
4502 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4503 /**
4504 * A flag you can enable for debugging: when set, log messages will be
4505 * printed during the resolution of this intent to show you what has
4506 * been found to create the final resolved list.
4507 */
4508 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004509 /**
4510 * If set, this intent will not match any components in packages that
4511 * are currently stopped. If this is not set, then the default behavior
4512 * is to include such applications in the result.
4513 */
4514 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4515 /**
4516 * If set, this intent will always match any components in packages that
4517 * are currently stopped. This is the default behavior when
4518 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4519 * flags are set, this one wins (it allows overriding of exclude for
4520 * places where the framework may automatically set the exclude flag).
4521 */
4522 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004523
4524 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004525 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004526 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004527 * persisted across device reboots until explicitly revoked with
4528 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4529 * grant for possible persisting; the receiving application must call
4530 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4531 * actually persist.
4532 *
4533 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4534 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4535 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004536 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004537 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004538 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004539
4540 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004541 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4542 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4543 * applies to any URI that is a prefix match against the original granted
4544 * URI. (Without this flag, the URI must match exactly for access to be
4545 * granted.) Another URI is considered a prefix match only when scheme,
4546 * authority, and all path segments defined by the prefix are an exact
4547 * match.
4548 */
4549 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4550
4551 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004552 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004553 * homework and verified that they correctly handle packages and components
4554 * that come and go over time. In particular:
4555 * <ul>
4556 * <li>Apps installed on external storage, which will appear to be
4557 * uninstalled while the the device is ejected.
4558 * <li>Apps with encryption unaware components, which will appear to not
4559 * exist while the device is locked.
4560 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004561 *
4562 * @hide
4563 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004564 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004565
4566 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004567 * Internal flag used to indicate ephemeral applications should not be
4568 * considered when resolving the intent.
4569 *
4570 * @hide
4571 */
4572 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4573
4574 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004575 * If set, the new activity is not kept in the history stack. As soon as
4576 * the user navigates away from it, the activity is finished. This may also
4577 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4578 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004579 *
4580 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4581 * is never invoked when the current activity starts a new activity which
4582 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004583 */
4584 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4585 /**
4586 * If set, the activity will not be launched if it is already running
4587 * at the top of the history stack.
4588 */
4589 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4590 /**
4591 * If set, this activity will become the start of a new task on this
4592 * history stack. A task (from the activity that started it to the
4593 * next task activity) defines an atomic group of activities that the
4594 * user can move to. Tasks can be moved to the foreground and background;
4595 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004596 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004597 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4598 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004599 *
4600 * <p>This flag is generally used by activities that want
4601 * to present a "launcher" style behavior: they give the user a list of
4602 * separate things that can be done, which otherwise run completely
4603 * independently of the activity launching them.
4604 *
4605 * <p>When using this flag, if a task is already running for the activity
4606 * you are now starting, then a new activity will not be started; instead,
4607 * the current task will simply be brought to the front of the screen with
4608 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4609 * to disable this behavior.
4610 *
4611 * <p>This flag can not be used when the caller is requesting a result from
4612 * the activity being launched.
4613 */
4614 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4615 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004616 * This flag is used to create a new task and launch an activity into it.
4617 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4618 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4619 * search through existing tasks for ones matching this Intent. Only if no such
4620 * task is found would a new task be created. When paired with
4621 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4622 * the search for a matching task and unconditionally start a new task.
4623 *
4624 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4625 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004626 * top-level application launcher.</strong> Used in conjunction with
4627 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4628 * behavior of bringing an existing task to the foreground. When set,
4629 * a new task is <em>always</em> started to host the Activity for the
4630 * Intent, regardless of whether there is already an existing task running
4631 * the same thing.
4632 *
4633 * <p><strong>Because the default system does not include graphical task management,
4634 * you should not use this flag unless you provide some way for a user to
4635 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004636 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004637 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4638 * creating new document tasks.
4639 *
4640 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004641 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642 *
Scott Main7aee61f2011-02-08 11:25:01 -08004643 * <p>See
4644 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4645 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004646 *
4647 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4648 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004649 */
4650 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4651 /**
4652 * If set, and the activity being launched is already running in the
4653 * current task, then instead of launching a new instance of that activity,
4654 * all of the other activities on top of it will be closed and this Intent
4655 * will be delivered to the (now on top) old activity as a new Intent.
4656 *
4657 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4658 * If D calls startActivity() with an Intent that resolves to the component
4659 * of activity B, then C and D will be finished and B receive the given
4660 * Intent, resulting in the stack now being: A, B.
4661 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004662 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004663 * either receive the new intent you are starting here in its
4664 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004665 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004666 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4667 * the same intent, then it will be finished and re-created; for all other
4668 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4669 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004670 *
4671 * <p>This launch mode can also be used to good effect in conjunction with
4672 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4673 * of a task, it will bring any currently running instance of that task
4674 * to the foreground, and then clear it to its root state. This is
4675 * especially useful, for example, when launching an activity from the
4676 * notification manager.
4677 *
Scott Main7aee61f2011-02-08 11:25:01 -08004678 * <p>See
4679 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4680 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004681 */
4682 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4683 /**
4684 * If set and this intent is being used to launch a new activity from an
4685 * existing one, then the reply target of the existing activity will be
4686 * transfered to the new activity. This way the new activity can call
4687 * {@link android.app.Activity#setResult} and have that result sent back to
4688 * the reply target of the original activity.
4689 */
4690 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4691 /**
4692 * If set and this intent is being used to launch a new activity from an
4693 * existing one, the current activity will not be counted as the top
4694 * activity for deciding whether the new intent should be delivered to
4695 * the top instead of starting a new one. The previous activity will
4696 * be used as the top, with the assumption being that the current activity
4697 * will finish itself immediately.
4698 */
4699 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4700 /**
4701 * If set, the new activity is not kept in the list of recently launched
4702 * activities.
4703 */
4704 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4705 /**
4706 * This flag is not normally set by application code, but set for you by
4707 * the system as described in the
4708 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4709 * launchMode} documentation for the singleTask mode.
4710 */
4711 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4712 /**
4713 * If set, and this activity is either being started in a new task or
4714 * bringing to the top an existing task, then it will be launched as
4715 * the front door of the task. This will result in the application of
4716 * any affinities needed to have that task in the proper state (either
4717 * moving activities to or from it), or simply resetting that task to
4718 * its initial state if needed.
4719 */
4720 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4721 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004722 * This flag is not normally set by application code, but set for you by
4723 * the system if this activity is being launched from history
4724 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004725 */
4726 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004727 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004728 * @deprecated As of API 21 this performs identically to
4729 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004730 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004731 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004732 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004733 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004734 * This flag is used to open a document into a new task rooted at the activity launched
4735 * by this Intent. Through the use of this flag, or its equivalent attribute,
4736 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004737 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004738 *
Craig Mautner026596b2014-05-21 15:35:44 -07004739 * <p>The use of the activity attribute form of this,
4740 * {@link android.R.attr#documentLaunchMode}, is
4741 * preferred over the Intent flag described here. The attribute form allows the
4742 * Activity to specify multiple document behavior for all launchers of the Activity
4743 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004744 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004745 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4746 * it is kept after the activity is finished is different than the use of
4747 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4748 * this flag is being used to create a new recents entry, then by default that entry
4749 * will be removed once the activity is finished. You can modify this behavior with
4750 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4751 *
Craig Mautner026596b2014-05-21 15:35:44 -07004752 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4753 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4754 * equivalent of the Activity manifest specifying {@link
4755 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4756 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4757 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004758 *
Craig Mautner026596b2014-05-21 15:35:44 -07004759 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004760 *
Craig Mautner026596b2014-05-21 15:35:44 -07004761 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004762 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4763 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004764 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004765 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004766 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004767 * callback from occurring on the current frontmost activity before it is
4768 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004769 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004770 * <p>Typically, an activity can rely on that callback to indicate that an
4771 * explicit user action has caused their activity to be moved out of the
4772 * foreground. The callback marks an appropriate point in the activity's
4773 * lifecycle for it to dismiss any notifications that it intends to display
4774 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004775 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004776 * <p>If an activity is ever started via any non-user-driven events such as
4777 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4778 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004779 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004780 */
4781 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004782 /**
4783 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4784 * this flag will cause the launched activity to be brought to the front of its
4785 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004786 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004787 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4788 * If D calls startActivity() with an Intent that resolves to the component
4789 * of activity B, then B will be brought to the front of the history stack,
4790 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004791 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004792 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004793 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004794 */
4795 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004796 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004797 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4798 * this flag will prevent the system from applying an activity transition
4799 * animation to go to the next activity state. This doesn't mean an
4800 * animation will never run -- if another activity change happens that doesn't
4801 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004802 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004803 * when you are going to do a series of activity operations but the
4804 * animation seen by the user shouldn't be driven by the first activity
4805 * change but rather a later one.
4806 */
4807 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4808 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004809 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4810 * this flag will cause any existing task that would be associated with the
4811 * activity to be cleared before the activity is started. That is, the activity
4812 * becomes the new root of an otherwise empty task, and any old activities
4813 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4814 */
4815 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4816 /**
4817 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4818 * this flag will cause a newly launching task to be placed on top of the current
4819 * home activity task (if there is one). That is, pressing back from the task
4820 * will always return the user to home even if that was not the last activity they
4821 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4822 */
4823 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4824 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004825 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4826 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004827 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004828 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004829 * this flag. When set and the task's activity is finished, the recents
4830 * entry will remain in the interface for the user to re-launch it, like a
4831 * recents entry for a top-level application.
4832 * <p>
4833 * The receiving activity can override this request with
4834 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4835 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004836 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004837 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004838 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004839
4840 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004841 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4842 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004843 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4844 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004845 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004846 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004847
4848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004849 * If set, when sending a broadcast only registered receivers will be
4850 * called -- no BroadcastReceiver components will be launched.
4851 */
4852 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004853 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004854 * If set, when sending a broadcast the new broadcast will replace
4855 * any existing pending broadcast that matches it. Matching is defined
4856 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4857 * true for the intents of the two broadcasts. When a match is found,
4858 * the new broadcast (and receivers associated with it) will replace the
4859 * existing one in the pending broadcast list, remaining at the same
4860 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004861 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004862 * <p>This flag is most typically used with sticky broadcasts, which
4863 * only care about delivering the most recent values of the broadcast
4864 * to their receivers.
4865 */
4866 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4867 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004868 * If set, when sending a broadcast the recipient is allowed to run at
4869 * foreground priority, with a shorter timeout interval. During normal
4870 * broadcasts the receivers are not automatically hoisted out of the
4871 * background priority class.
4872 */
4873 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4874 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004875 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4876 * They can still propagate results through to later receivers, but they can not prevent
4877 * later receivers from seeing the broadcast.
4878 */
4879 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4880 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004881 * If set, when sending a broadcast <i>before boot has completed</i> only
4882 * registered receivers will be called -- no BroadcastReceiver components
4883 * will be launched. Sticky intent state will be recorded properly even
4884 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4885 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004886 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004887 * <p>This flag is only for use by system sevices as a convenience to
4888 * avoid having to implement a more complex mechanism around detection
4889 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004890 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004891 * @hide
4892 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004893 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004894 /**
4895 * Set when this broadcast is for a boot upgrade, a special mode that
4896 * allows the broadcast to be sent before the system is ready and launches
4897 * the app process with no providers running in it.
4898 * @hide
4899 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004900 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004901 /**
4902 * If set, the broadcast will always go to manifest receivers in background (cached
4903 * or not running) apps, regardless of whether that would be done by default. By
4904 * default they will only receive broadcasts if the broadcast has specified an
4905 * explicit component or package name.
Christopher Tatebdc39412017-01-23 12:21:13 -08004906 *
4907 * NOTE: dumpstate uses this flag numerically, so when its value is changed
4908 * the broadcast code there must also be changed to match.
4909 *
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004910 * @hide
4911 */
4912 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4913 /**
4914 * If set, the broadcast will never go to manifest receivers in background (cached
4915 * or not running) apps, regardless of whether that would be done by default. By
4916 * default they will receive broadcasts if the broadcast has specified an
4917 * explicit component or package name.
4918 * @hide
4919 */
4920 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
Jeff Sharkey6a34e562016-12-21 09:56:00 -07004921 /**
4922 * If set, this broadcast is being sent from the shell.
4923 * @hide
4924 */
4925 public static final int FLAG_RECEIVER_FROM_SHELL = 0x00400000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004926
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004927 /**
4928 * @hide Flags that can't be changed with PendingIntent.
4929 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004930 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4931 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4932 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004933
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004934 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004935 // ---------------------------------------------------------------------
4936 // toUri() and parseUri() options.
4937
4938 /**
4939 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4940 * always has the "intent:" scheme. This syntax can be used when you want
4941 * to later disambiguate between URIs that are intended to describe an
4942 * Intent vs. all others that should be treated as raw URIs. When used
4943 * with {@link #parseUri}, any other scheme will result in a generic
4944 * VIEW action for that raw URI.
4945 */
4946 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004947
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004948 /**
4949 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4950 * always has the "android-app:" scheme. This is a variation of
4951 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4952 * http/https URI being delivered to a specific package name. The format
4953 * is:
4954 *
4955 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004956 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004957 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004958 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4959 * you must also include a scheme; including a path also requires both a host and a scheme.
4960 * The final #Intent; fragment can be used without a scheme, host, or path.
4961 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004962 * used with intents that have a {@link #setSelector}, since the base intent
4963 * will always have an explicit package name.</p>
4964 *
4965 * <p>Some examples of how this scheme maps to Intent objects:</p>
4966 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4967 * <colgroup align="left" />
4968 * <colgroup align="left" />
4969 * <thead>
4970 * <tr><th>URI</th> <th>Intent</th></tr>
4971 * </thead>
4972 *
4973 * <tbody>
4974 * <tr><td><code>android-app://com.example.app</code></td>
4975 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4976 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4977 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4978 * </table></td>
4979 * </tr>
4980 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4981 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4982 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4983 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4984 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4985 * </table></td>
4986 * </tr>
4987 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4988 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4989 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4990 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4991 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4992 * </table></td>
4993 * </tr>
4994 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4995 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4996 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4997 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4998 * </table></td>
4999 * </tr>
5000 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
5001 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
5002 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5003 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
5004 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5005 * </table></td>
5006 * </tr>
5007 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;<br />i.some_int=100;S.some_str=hello;end</code></td>
5008 * <td><table border="" style="margin:0" >
5009 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
5010 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
5011 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
5012 * </table></td>
5013 * </tr>
5014 * </tbody>
5015 * </table>
5016 */
5017 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
5018
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005019 /**
5020 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
5021 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
5022 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
5023 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
5024 * generated Intent can not cause unexpected data access to happen.
5025 *
5026 * <p>If you do not trust the source of the URI being parsed, you should still do further
5027 * processing to protect yourself from it. In particular, when using it to start an
5028 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
5029 * that can handle it.</p>
5030 */
5031 public static final int URI_ALLOW_UNSAFE = 1<<2;
5032
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005033 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034
5035 private String mAction;
5036 private Uri mData;
5037 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005038 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005039 private ComponentName mComponent;
5040 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005041 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005042 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005043 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005044 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005045 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005046 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005047
5048 // ---------------------------------------------------------------------
5049
5050 /**
5051 * Create an empty intent.
5052 */
5053 public Intent() {
5054 }
5055
5056 /**
5057 * Copy constructor.
5058 */
5059 public Intent(Intent o) {
5060 this.mAction = o.mAction;
5061 this.mData = o.mData;
5062 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005063 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064 this.mComponent = o.mComponent;
5065 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005066 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005067 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005068 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005069 }
5070 if (o.mExtras != null) {
5071 this.mExtras = new Bundle(o.mExtras);
5072 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005073 if (o.mSourceBounds != null) {
5074 this.mSourceBounds = new Rect(o.mSourceBounds);
5075 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005076 if (o.mSelector != null) {
5077 this.mSelector = new Intent(o.mSelector);
5078 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005079 if (o.mClipData != null) {
5080 this.mClipData = new ClipData(o.mClipData);
5081 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005082 }
5083
5084 @Override
5085 public Object clone() {
5086 return new Intent(this);
5087 }
5088
5089 private Intent(Intent o, boolean all) {
5090 this.mAction = o.mAction;
5091 this.mData = o.mData;
5092 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005093 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005094 this.mComponent = o.mComponent;
5095 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005096 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005097 }
5098 }
5099
5100 /**
5101 * Make a clone of only the parts of the Intent that are relevant for
5102 * filter matching: the action, data, type, component, and categories.
5103 */
5104 public Intent cloneFilter() {
5105 return new Intent(this, false);
5106 }
5107
5108 /**
5109 * Create an intent with a given action. All other fields (data, type,
5110 * class) are null. Note that the action <em>must</em> be in a
5111 * namespace because Intents are used globally in the system -- for
5112 * example the system VIEW action is android.intent.action.VIEW; an
5113 * application's custom action would be something like
5114 * com.google.app.myapp.CUSTOM_ACTION.
5115 *
5116 * @param action The Intent action, such as ACTION_VIEW.
5117 */
5118 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005119 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005120 }
5121
5122 /**
5123 * Create an intent with a given action and for a given data url. Note
5124 * that the action <em>must</em> be in a namespace because Intents are
5125 * used globally in the system -- for example the system VIEW action is
5126 * android.intent.action.VIEW; an application's custom action would be
5127 * something like com.google.app.myapp.CUSTOM_ACTION.
5128 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005129 * <p><em>Note: scheme and host name matching in the Android framework is
5130 * case-sensitive, unlike the formal RFC. As a result,
5131 * you should always ensure that you write your Uri with these elements
5132 * using lower case letters, and normalize any Uris you receive from
5133 * outside of Android to ensure the scheme and host is lower case.</em></p>
5134 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005135 * @param action The Intent action, such as ACTION_VIEW.
5136 * @param uri The Intent data URI.
5137 */
5138 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005139 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005140 mData = uri;
5141 }
5142
5143 /**
5144 * Create an intent for a specific component. All other fields (action, data,
5145 * type, class) are null, though they can be modified later with explicit
5146 * calls. This provides a convenient way to create an intent that is
5147 * intended to execute a hard-coded class name, rather than relying on the
5148 * system to find an appropriate class for you; see {@link #setComponent}
5149 * for more information on the repercussions of this.
5150 *
5151 * @param packageContext A Context of the application package implementing
5152 * this class.
5153 * @param cls The component class that is to be used for the intent.
5154 *
5155 * @see #setClass
5156 * @see #setComponent
5157 * @see #Intent(String, android.net.Uri , Context, Class)
5158 */
5159 public Intent(Context packageContext, Class<?> cls) {
5160 mComponent = new ComponentName(packageContext, cls);
5161 }
5162
5163 /**
5164 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005165 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005166 * construct the Intent and then calling {@link #setClass} to set its
5167 * class.
5168 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005169 * <p><em>Note: scheme and host name matching in the Android framework is
5170 * case-sensitive, unlike the formal RFC. As a result,
5171 * you should always ensure that you write your Uri with these elements
5172 * using lower case letters, and normalize any Uris you receive from
5173 * outside of Android to ensure the scheme and host is lower case.</em></p>
5174 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 * @param action The Intent action, such as ACTION_VIEW.
5176 * @param uri The Intent data URI.
5177 * @param packageContext A Context of the application package implementing
5178 * this class.
5179 * @param cls The component class that is to be used for the intent.
5180 *
5181 * @see #Intent(String, android.net.Uri)
5182 * @see #Intent(Context, Class)
5183 * @see #setClass
5184 * @see #setComponent
5185 */
5186 public Intent(String action, Uri uri,
5187 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005188 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005189 mData = uri;
5190 mComponent = new ComponentName(packageContext, cls);
5191 }
5192
5193 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005194 * Create an intent to launch the main (root) activity of a task. This
5195 * is the Intent that is started when the application's is launched from
5196 * Home. For anything else that wants to launch an application in the
5197 * same way, it is important that they use an Intent structured the same
5198 * way, and can use this function to ensure this is the case.
5199 *
5200 * <p>The returned Intent has the given Activity component as its explicit
5201 * component, {@link #ACTION_MAIN} as its action, and includes the
5202 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5203 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5204 * to do that through {@link #addFlags(int)} on the returned Intent.
5205 *
5206 * @param mainActivity The main activity component that this Intent will
5207 * launch.
5208 * @return Returns a newly created Intent that can be used to launch the
5209 * activity as a main application entry.
5210 *
5211 * @see #setClass
5212 * @see #setComponent
5213 */
5214 public static Intent makeMainActivity(ComponentName mainActivity) {
5215 Intent intent = new Intent(ACTION_MAIN);
5216 intent.setComponent(mainActivity);
5217 intent.addCategory(CATEGORY_LAUNCHER);
5218 return intent;
5219 }
5220
5221 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005222 * Make an Intent for the main activity of an application, without
5223 * specifying a specific activity to run but giving a selector to find
5224 * the activity. This results in a final Intent that is structured
5225 * the same as when the application is launched from
5226 * Home. For anything else that wants to launch an application in the
5227 * same way, it is important that they use an Intent structured the same
5228 * way, and can use this function to ensure this is the case.
5229 *
5230 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5231 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5232 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5233 * to do that through {@link #addFlags(int)} on the returned Intent.
5234 *
5235 * @param selectorAction The action name of the Intent's selector.
5236 * @param selectorCategory The name of a category to add to the Intent's
5237 * selector.
5238 * @return Returns a newly created Intent that can be used to launch the
5239 * activity as a main application entry.
5240 *
5241 * @see #setSelector(Intent)
5242 */
5243 public static Intent makeMainSelectorActivity(String selectorAction,
5244 String selectorCategory) {
5245 Intent intent = new Intent(ACTION_MAIN);
5246 intent.addCategory(CATEGORY_LAUNCHER);
5247 Intent selector = new Intent();
5248 selector.setAction(selectorAction);
5249 selector.addCategory(selectorCategory);
5250 intent.setSelector(selector);
5251 return intent;
5252 }
5253
5254 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005255 * Make an Intent that can be used to re-launch an application's task
5256 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5257 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5258 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5259 *
5260 * @param mainActivity The activity component that is the root of the
5261 * task; this is the activity that has been published in the application's
5262 * manifest as the main launcher icon.
5263 *
5264 * @return Returns a newly created Intent that can be used to relaunch the
5265 * activity's task in its root state.
5266 */
5267 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5268 Intent intent = makeMainActivity(mainActivity);
5269 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5270 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5271 return intent;
5272 }
5273
5274 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005275 * Call {@link #parseUri} with 0 flags.
5276 * @deprecated Use {@link #parseUri} instead.
5277 */
5278 @Deprecated
5279 public static Intent getIntent(String uri) throws URISyntaxException {
5280 return parseUri(uri, 0);
5281 }
Tom Taylord4a47292009-12-21 13:59:18 -08005282
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005283 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005284 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005285 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005286 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005287 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005288 *
5289 * <p>The URI given here must not be relative -- that is, it must include
5290 * the scheme and full path.
5291 *
5292 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005293 * @param flags Additional processing flags. Either 0,
5294 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005295 *
5296 * @return Intent The newly created Intent object.
5297 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005298 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5299 * it bad (as parsed by the Uri class) or the Intent data within the
5300 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005301 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005302 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005303 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005304 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005305 int i = 0;
5306 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005307 final boolean androidApp = uri.startsWith("android-app:");
5308
5309 // Validate intent scheme if requested.
5310 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5311 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005312 Intent intent = new Intent(ACTION_VIEW);
5313 try {
5314 intent.setData(Uri.parse(uri));
5315 } catch (IllegalArgumentException e) {
5316 throw new URISyntaxException(uri, e.getMessage());
5317 }
5318 return intent;
5319 }
5320 }
Tom Taylord4a47292009-12-21 13:59:18 -08005321
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005322 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005323 // simple case
5324 if (i == -1) {
5325 if (!androidApp) {
5326 return new Intent(ACTION_VIEW, Uri.parse(uri));
5327 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005328
5329 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005330 } else if (!uri.startsWith("#Intent;", i)) {
5331 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005332 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005333 } else {
5334 i = -1;
5335 }
5336 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005337
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005338 // new format
5339 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005340 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005341 boolean explicitAction = false;
5342 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005343
5344 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005345 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005346 String data;
5347 if (i >= 0) {
5348 data = uri.substring(0, i);
5349 i += 8; // length of "#Intent;"
5350 } else {
5351 data = uri;
5352 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005353
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005354 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005355 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005356 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005357 if (eq < 0) eq = i-1;
5358 int semi = uri.indexOf(';', i);
5359 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005360
5361 // action
5362 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005363 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005364 if (!inSelector) {
5365 explicitAction = true;
5366 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005367 }
5368
5369 // categories
5370 else if (uri.startsWith("category=", i)) {
5371 intent.addCategory(value);
5372 }
5373
5374 // type
5375 else if (uri.startsWith("type=", i)) {
5376 intent.mType = value;
5377 }
5378
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005379 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005380 else if (uri.startsWith("launchFlags=", i)) {
5381 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005382 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5383 intent.mFlags &= ~IMMUTABLE_FLAGS;
5384 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005385 }
5386
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005387 // package
5388 else if (uri.startsWith("package=", i)) {
5389 intent.mPackage = value;
5390 }
5391
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005392 // component
5393 else if (uri.startsWith("component=", i)) {
5394 intent.mComponent = ComponentName.unflattenFromString(value);
5395 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005396
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005397 // scheme
5398 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005399 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005400 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005401 } else {
5402 scheme = value;
5403 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005404 }
5405
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005406 // source bounds
5407 else if (uri.startsWith("sourceBounds=", i)) {
5408 intent.mSourceBounds = Rect.unflattenFromString(value);
5409 }
5410
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005411 // selector
5412 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5413 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005414 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005415 }
5416
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005417 // extra
5418 else {
5419 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005420 // create Bundle if it doesn't already exist
5421 if (intent.mExtras == null) intent.mExtras = new Bundle();
5422 Bundle b = intent.mExtras;
5423 // add EXTRA
5424 if (uri.startsWith("S.", i)) b.putString(key, value);
5425 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5426 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5427 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5428 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5429 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5430 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5431 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5432 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5433 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5434 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005435
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005436 // move to the next item
5437 i = semi + 1;
5438 }
5439
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005440 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005441 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005442 if (baseIntent.mPackage == null) {
5443 baseIntent.setSelector(intent);
5444 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005445 intent = baseIntent;
5446 }
5447
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005448 if (data != null) {
5449 if (data.startsWith("intent:")) {
5450 data = data.substring(7);
5451 if (scheme != null) {
5452 data = scheme + ':' + data;
5453 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005454 } else if (data.startsWith("android-app:")) {
5455 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5456 // Correctly formed android-app, first part is package name.
5457 int end = data.indexOf('/', 14);
5458 if (end < 0) {
5459 // All we have is a package name.
5460 intent.mPackage = data.substring(14);
5461 if (!explicitAction) {
5462 intent.setAction(ACTION_MAIN);
5463 }
5464 data = "";
5465 } else {
5466 // Target the Intent at the given package name always.
5467 String authority = null;
5468 intent.mPackage = data.substring(14, end);
5469 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005470 if ((end+1) < data.length()) {
5471 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5472 // Found a scheme, remember it.
5473 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005474 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005475 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5476 // Found a authority, remember it.
5477 authority = data.substring(end+1, newEnd);
5478 end = newEnd;
5479 }
5480 } else {
5481 // All we have is a scheme.
5482 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005483 }
5484 }
5485 if (scheme == null) {
5486 // If there was no scheme, then this just targets the package.
5487 if (!explicitAction) {
5488 intent.setAction(ACTION_MAIN);
5489 }
5490 data = "";
5491 } else if (authority == null) {
5492 data = scheme + ":";
5493 } else {
5494 data = scheme + "://" + authority + data.substring(end);
5495 }
5496 }
5497 } else {
5498 data = "";
5499 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005500 }
Tom Taylord4a47292009-12-21 13:59:18 -08005501
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005502 if (data.length() > 0) {
5503 try {
5504 intent.mData = Uri.parse(data);
5505 } catch (IllegalArgumentException e) {
5506 throw new URISyntaxException(uri, e.getMessage());
5507 }
5508 }
5509 }
Tom Taylord4a47292009-12-21 13:59:18 -08005510
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005511 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005512
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005513 } catch (IndexOutOfBoundsException e) {
5514 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5515 }
5516 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005517
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005518 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005519 return getIntentOld(uri, 0);
5520 }
5521
5522 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005523 Intent intent;
5524
5525 int i = uri.lastIndexOf('#');
5526 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005527 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005528 final int intentFragmentStart = i;
5529 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005530
5531 i++;
5532
5533 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005534 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005535 i += 7;
5536 int j = uri.indexOf(')', i);
5537 action = uri.substring(i, j);
5538 i = j + 1;
5539 }
5540
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005541 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005542
5543 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005544 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005545 i += 11;
5546 int j = uri.indexOf(')', i);
5547 while (i < j) {
5548 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005549 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005550 if (i < sep) {
5551 intent.addCategory(uri.substring(i, sep));
5552 }
5553 i = sep + 1;
5554 }
5555 i = j + 1;
5556 }
5557
5558 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005559 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005560 i += 5;
5561 int j = uri.indexOf(')', i);
5562 intent.mType = uri.substring(i, j);
5563 i = j + 1;
5564 }
5565
5566 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005567 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005568 i += 12;
5569 int j = uri.indexOf(')', i);
5570 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005571 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5572 intent.mFlags &= ~IMMUTABLE_FLAGS;
5573 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005574 i = j + 1;
5575 }
5576
5577 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005578 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005579 i += 10;
5580 int j = uri.indexOf(')', i);
5581 int sep = uri.indexOf('!', i);
5582 if (sep >= 0 && sep < j) {
5583 String pkg = uri.substring(i, sep);
5584 String cls = uri.substring(sep + 1, j);
5585 intent.mComponent = new ComponentName(pkg, cls);
5586 }
5587 i = j + 1;
5588 }
5589
5590 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005591 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005592 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005593
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005594 final int closeParen = uri.indexOf(')', i);
5595 if (closeParen == -1) throw new URISyntaxException(uri,
5596 "EXTRA missing trailing ')'", i);
5597
5598 while (i < closeParen) {
5599 // fetch the key value
5600 int j = uri.indexOf('=', i);
5601 if (j <= i + 1 || i >= closeParen) {
5602 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5603 }
5604 char type = uri.charAt(i);
5605 i++;
5606 String key = uri.substring(i, j);
5607 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005608
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005609 // get type-value
5610 j = uri.indexOf('!', i);
5611 if (j == -1 || j >= closeParen) j = closeParen;
5612 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5613 String value = uri.substring(i, j);
5614 i = j;
5615
5616 // create Bundle if it doesn't already exist
5617 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005619 // add item to bundle
5620 try {
5621 switch (type) {
5622 case 'S':
5623 intent.mExtras.putString(key, Uri.decode(value));
5624 break;
5625 case 'B':
5626 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5627 break;
5628 case 'b':
5629 intent.mExtras.putByte(key, Byte.parseByte(value));
5630 break;
5631 case 'c':
5632 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5633 break;
5634 case 'd':
5635 intent.mExtras.putDouble(key, Double.parseDouble(value));
5636 break;
5637 case 'f':
5638 intent.mExtras.putFloat(key, Float.parseFloat(value));
5639 break;
5640 case 'i':
5641 intent.mExtras.putInt(key, Integer.parseInt(value));
5642 break;
5643 case 'l':
5644 intent.mExtras.putLong(key, Long.parseLong(value));
5645 break;
5646 case 's':
5647 intent.mExtras.putShort(key, Short.parseShort(value));
5648 break;
5649 default:
5650 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5651 }
5652 } catch (NumberFormatException e) {
5653 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5654 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005656 char ch = uri.charAt(i);
5657 if (ch == ')') break;
5658 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5659 i++;
5660 }
5661 }
5662
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005663 if (isIntentFragment) {
5664 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5665 } else {
5666 intent.mData = Uri.parse(uri);
5667 }
Tom Taylord4a47292009-12-21 13:59:18 -08005668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005669 if (intent.mAction == null) {
5670 // By default, if no action is specified, then use VIEW.
5671 intent.mAction = ACTION_VIEW;
5672 }
5673
5674 } else {
5675 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5676 }
5677
5678 return intent;
5679 }
5680
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005681 /** @hide */
5682 public interface CommandOptionHandler {
5683 boolean handleOption(String opt, ShellCommand cmd);
5684 }
5685
5686 /** @hide */
5687 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5688 throws URISyntaxException {
5689 Intent intent = new Intent();
5690 Intent baseIntent = intent;
5691 boolean hasIntentInfo = false;
5692
5693 Uri data = null;
5694 String type = null;
5695
5696 String opt;
5697 while ((opt=cmd.getNextOption()) != null) {
5698 switch (opt) {
5699 case "-a":
5700 intent.setAction(cmd.getNextArgRequired());
5701 if (intent == baseIntent) {
5702 hasIntentInfo = true;
5703 }
5704 break;
5705 case "-d":
5706 data = Uri.parse(cmd.getNextArgRequired());
5707 if (intent == baseIntent) {
5708 hasIntentInfo = true;
5709 }
5710 break;
5711 case "-t":
5712 type = cmd.getNextArgRequired();
5713 if (intent == baseIntent) {
5714 hasIntentInfo = true;
5715 }
5716 break;
5717 case "-c":
5718 intent.addCategory(cmd.getNextArgRequired());
5719 if (intent == baseIntent) {
5720 hasIntentInfo = true;
5721 }
5722 break;
5723 case "-e":
5724 case "--es": {
5725 String key = cmd.getNextArgRequired();
5726 String value = cmd.getNextArgRequired();
5727 intent.putExtra(key, value);
5728 }
5729 break;
5730 case "--esn": {
5731 String key = cmd.getNextArgRequired();
5732 intent.putExtra(key, (String) null);
5733 }
5734 break;
5735 case "--ei": {
5736 String key = cmd.getNextArgRequired();
5737 String value = cmd.getNextArgRequired();
5738 intent.putExtra(key, Integer.decode(value));
5739 }
5740 break;
5741 case "--eu": {
5742 String key = cmd.getNextArgRequired();
5743 String value = cmd.getNextArgRequired();
5744 intent.putExtra(key, Uri.parse(value));
5745 }
5746 break;
5747 case "--ecn": {
5748 String key = cmd.getNextArgRequired();
5749 String value = cmd.getNextArgRequired();
5750 ComponentName cn = ComponentName.unflattenFromString(value);
5751 if (cn == null)
5752 throw new IllegalArgumentException("Bad component name: " + value);
5753 intent.putExtra(key, cn);
5754 }
5755 break;
5756 case "--eia": {
5757 String key = cmd.getNextArgRequired();
5758 String value = cmd.getNextArgRequired();
5759 String[] strings = value.split(",");
5760 int[] list = new int[strings.length];
5761 for (int i = 0; i < strings.length; i++) {
5762 list[i] = Integer.decode(strings[i]);
5763 }
5764 intent.putExtra(key, list);
5765 }
5766 break;
5767 case "--eial": {
5768 String key = cmd.getNextArgRequired();
5769 String value = cmd.getNextArgRequired();
5770 String[] strings = value.split(",");
5771 ArrayList<Integer> list = new ArrayList<>(strings.length);
5772 for (int i = 0; i < strings.length; i++) {
5773 list.add(Integer.decode(strings[i]));
5774 }
5775 intent.putExtra(key, list);
5776 }
5777 break;
5778 case "--el": {
5779 String key = cmd.getNextArgRequired();
5780 String value = cmd.getNextArgRequired();
5781 intent.putExtra(key, Long.valueOf(value));
5782 }
5783 break;
5784 case "--ela": {
5785 String key = cmd.getNextArgRequired();
5786 String value = cmd.getNextArgRequired();
5787 String[] strings = value.split(",");
5788 long[] list = new long[strings.length];
5789 for (int i = 0; i < strings.length; i++) {
5790 list[i] = Long.valueOf(strings[i]);
5791 }
5792 intent.putExtra(key, list);
5793 hasIntentInfo = true;
5794 }
5795 break;
5796 case "--elal": {
5797 String key = cmd.getNextArgRequired();
5798 String value = cmd.getNextArgRequired();
5799 String[] strings = value.split(",");
5800 ArrayList<Long> list = new ArrayList<>(strings.length);
5801 for (int i = 0; i < strings.length; i++) {
5802 list.add(Long.valueOf(strings[i]));
5803 }
5804 intent.putExtra(key, list);
5805 hasIntentInfo = true;
5806 }
5807 break;
5808 case "--ef": {
5809 String key = cmd.getNextArgRequired();
5810 String value = cmd.getNextArgRequired();
5811 intent.putExtra(key, Float.valueOf(value));
5812 hasIntentInfo = true;
5813 }
5814 break;
5815 case "--efa": {
5816 String key = cmd.getNextArgRequired();
5817 String value = cmd.getNextArgRequired();
5818 String[] strings = value.split(",");
5819 float[] list = new float[strings.length];
5820 for (int i = 0; i < strings.length; i++) {
5821 list[i] = Float.valueOf(strings[i]);
5822 }
5823 intent.putExtra(key, list);
5824 hasIntentInfo = true;
5825 }
5826 break;
5827 case "--efal": {
5828 String key = cmd.getNextArgRequired();
5829 String value = cmd.getNextArgRequired();
5830 String[] strings = value.split(",");
5831 ArrayList<Float> list = new ArrayList<>(strings.length);
5832 for (int i = 0; i < strings.length; i++) {
5833 list.add(Float.valueOf(strings[i]));
5834 }
5835 intent.putExtra(key, list);
5836 hasIntentInfo = true;
5837 }
5838 break;
5839 case "--esa": {
5840 String key = cmd.getNextArgRequired();
5841 String value = cmd.getNextArgRequired();
5842 // Split on commas unless they are preceeded by an escape.
5843 // The escape character must be escaped for the string and
5844 // again for the regex, thus four escape characters become one.
5845 String[] strings = value.split("(?<!\\\\),");
5846 intent.putExtra(key, strings);
5847 hasIntentInfo = true;
5848 }
5849 break;
5850 case "--esal": {
5851 String key = cmd.getNextArgRequired();
5852 String value = cmd.getNextArgRequired();
5853 // Split on commas unless they are preceeded by an escape.
5854 // The escape character must be escaped for the string and
5855 // again for the regex, thus four escape characters become one.
5856 String[] strings = value.split("(?<!\\\\),");
5857 ArrayList<String> list = new ArrayList<>(strings.length);
5858 for (int i = 0; i < strings.length; i++) {
5859 list.add(strings[i]);
5860 }
5861 intent.putExtra(key, list);
5862 hasIntentInfo = true;
5863 }
5864 break;
5865 case "--ez": {
5866 String key = cmd.getNextArgRequired();
5867 String value = cmd.getNextArgRequired().toLowerCase();
5868 // Boolean.valueOf() results in false for anything that is not "true", which is
5869 // error-prone in shell commands
5870 boolean arg;
5871 if ("true".equals(value) || "t".equals(value)) {
5872 arg = true;
5873 } else if ("false".equals(value) || "f".equals(value)) {
5874 arg = false;
5875 } else {
5876 try {
5877 arg = Integer.decode(value) != 0;
5878 } catch (NumberFormatException ex) {
5879 throw new IllegalArgumentException("Invalid boolean value: " + value);
5880 }
5881 }
5882
5883 intent.putExtra(key, arg);
5884 }
5885 break;
5886 case "-n": {
5887 String str = cmd.getNextArgRequired();
5888 ComponentName cn = ComponentName.unflattenFromString(str);
5889 if (cn == null)
5890 throw new IllegalArgumentException("Bad component name: " + str);
5891 intent.setComponent(cn);
5892 if (intent == baseIntent) {
5893 hasIntentInfo = true;
5894 }
5895 }
5896 break;
5897 case "-p": {
5898 String str = cmd.getNextArgRequired();
5899 intent.setPackage(str);
5900 if (intent == baseIntent) {
5901 hasIntentInfo = true;
5902 }
5903 }
5904 break;
5905 case "-f":
5906 String str = cmd.getNextArgRequired();
5907 intent.setFlags(Integer.decode(str).intValue());
5908 break;
5909 case "--grant-read-uri-permission":
5910 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5911 break;
5912 case "--grant-write-uri-permission":
5913 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5914 break;
5915 case "--grant-persistable-uri-permission":
5916 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5917 break;
5918 case "--grant-prefix-uri-permission":
5919 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5920 break;
5921 case "--exclude-stopped-packages":
5922 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5923 break;
5924 case "--include-stopped-packages":
5925 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5926 break;
5927 case "--debug-log-resolution":
5928 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5929 break;
5930 case "--activity-brought-to-front":
5931 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5932 break;
5933 case "--activity-clear-top":
5934 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5935 break;
5936 case "--activity-clear-when-task-reset":
5937 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5938 break;
5939 case "--activity-exclude-from-recents":
5940 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5941 break;
5942 case "--activity-launched-from-history":
5943 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5944 break;
5945 case "--activity-multiple-task":
5946 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5947 break;
5948 case "--activity-no-animation":
5949 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5950 break;
5951 case "--activity-no-history":
5952 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5953 break;
5954 case "--activity-no-user-action":
5955 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5956 break;
5957 case "--activity-previous-is-top":
5958 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5959 break;
5960 case "--activity-reorder-to-front":
5961 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5962 break;
5963 case "--activity-reset-task-if-needed":
5964 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5965 break;
5966 case "--activity-single-top":
5967 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5968 break;
5969 case "--activity-clear-task":
5970 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5971 break;
5972 case "--activity-task-on-home":
5973 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5974 break;
5975 case "--receiver-registered-only":
5976 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5977 break;
5978 case "--receiver-replace-pending":
5979 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5980 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005981 case "--receiver-foreground":
5982 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5983 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005984 case "--selector":
5985 intent.setDataAndType(data, type);
5986 intent = new Intent();
5987 break;
5988 default:
5989 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5990 // Okay, caller handled this option.
5991 } else {
5992 throw new IllegalArgumentException("Unknown option: " + opt);
5993 }
5994 break;
5995 }
5996 }
5997 intent.setDataAndType(data, type);
5998
5999 final boolean hasSelector = intent != baseIntent;
6000 if (hasSelector) {
6001 // A selector was specified; fix up.
6002 baseIntent.setSelector(intent);
6003 intent = baseIntent;
6004 }
6005
6006 String arg = cmd.getNextArg();
6007 baseIntent = null;
6008 if (arg == null) {
6009 if (hasSelector) {
6010 // If a selector has been specified, and no arguments
6011 // have been supplied for the main Intent, then we can
6012 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
6013 // need to have a component name specified yet, the
6014 // selector will take care of that.
6015 baseIntent = new Intent(Intent.ACTION_MAIN);
6016 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6017 }
6018 } else if (arg.indexOf(':') >= 0) {
6019 // The argument is a URI. Fully parse it, and use that result
6020 // to fill in any data not specified so far.
6021 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
6022 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
6023 } else if (arg.indexOf('/') >= 0) {
6024 // The argument is a component name. Build an Intent to launch
6025 // it.
6026 baseIntent = new Intent(Intent.ACTION_MAIN);
6027 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6028 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
6029 } else {
6030 // Assume the argument is a package name.
6031 baseIntent = new Intent(Intent.ACTION_MAIN);
6032 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
6033 baseIntent.setPackage(arg);
6034 }
6035 if (baseIntent != null) {
6036 Bundle extras = intent.getExtras();
6037 intent.replaceExtras((Bundle)null);
6038 Bundle uriExtras = baseIntent.getExtras();
6039 baseIntent.replaceExtras((Bundle)null);
6040 if (intent.getAction() != null && baseIntent.getCategories() != null) {
6041 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
6042 for (String c : cats) {
6043 baseIntent.removeCategory(c);
6044 }
6045 }
6046 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
6047 if (extras == null) {
6048 extras = uriExtras;
6049 } else if (uriExtras != null) {
6050 uriExtras.putAll(extras);
6051 extras = uriExtras;
6052 }
6053 intent.replaceExtras(extras);
6054 hasIntentInfo = true;
6055 }
6056
6057 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
6058 return intent;
6059 }
6060
6061 /** @hide */
6062 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
6063 final String[] lines = new String[] {
6064 "<INTENT> specifications include these flags and arguments:",
6065 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
6066 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
6067 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
6068 " [--esn <EXTRA_KEY> ...]",
6069 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
6070 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
6071 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
6072 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
6073 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
6074 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
6075 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6076 " (mutiple extras passed as Integer[])",
6077 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
6078 " (mutiple extras passed as List<Integer>)",
6079 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6080 " (mutiple extras passed as Long[])",
6081 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
6082 " (mutiple extras passed as List<Long>)",
6083 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6084 " (mutiple extras passed as Float[])",
6085 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
6086 " (mutiple extras passed as List<Float>)",
6087 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6088 " (mutiple extras passed as String[]; to embed a comma into a string,",
6089 " escape it using \"\\,\")",
6090 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
6091 " (mutiple extras passed as List<String>; to embed a comma into a string,",
6092 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08006093 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006094 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
6095 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
6096 " [--debug-log-resolution] [--exclude-stopped-packages]",
6097 " [--include-stopped-packages]",
6098 " [--activity-brought-to-front] [--activity-clear-top]",
6099 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
6100 " [--activity-launched-from-history] [--activity-multiple-task]",
6101 " [--activity-no-animation] [--activity-no-history]",
6102 " [--activity-no-user-action] [--activity-previous-is-top]",
6103 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
6104 " [--activity-single-top] [--activity-clear-task]",
6105 " [--activity-task-on-home]",
6106 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08006107 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08006108 " [--selector]",
6109 " [<URI> | <PACKAGE> | <COMPONENT>]"
6110 };
6111 for (String line : lines) {
6112 pw.print(prefix);
6113 pw.println(line);
6114 }
6115 }
6116
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006117 /**
6118 * Retrieve the general action to be performed, such as
6119 * {@link #ACTION_VIEW}. The action describes the general way the rest of
6120 * the information in the intent should be interpreted -- most importantly,
6121 * what to do with the data returned by {@link #getData}.
6122 *
6123 * @return The action of this intent or null if none is specified.
6124 *
6125 * @see #setAction
6126 */
6127 public String getAction() {
6128 return mAction;
6129 }
6130
6131 /**
6132 * Retrieve data this intent is operating on. This URI specifies the name
6133 * of the data; often it uses the content: scheme, specifying data in a
6134 * content provider. Other schemes may be handled by specific activities,
6135 * such as http: by the web browser.
6136 *
6137 * @return The URI of the data this intent is targeting or null.
6138 *
6139 * @see #getScheme
6140 * @see #setData
6141 */
6142 public Uri getData() {
6143 return mData;
6144 }
6145
6146 /**
6147 * The same as {@link #getData()}, but returns the URI as an encoded
6148 * String.
6149 */
6150 public String getDataString() {
6151 return mData != null ? mData.toString() : null;
6152 }
6153
6154 /**
6155 * Return the scheme portion of the intent's data. If the data is null or
6156 * does not include a scheme, null is returned. Otherwise, the scheme
6157 * prefix without the final ':' is returned, i.e. "http".
6158 *
6159 * <p>This is the same as calling getData().getScheme() (and checking for
6160 * null data).
6161 *
6162 * @return The scheme of this intent.
6163 *
6164 * @see #getData
6165 */
6166 public String getScheme() {
6167 return mData != null ? mData.getScheme() : null;
6168 }
6169
6170 /**
6171 * Retrieve any explicit MIME type included in the intent. This is usually
6172 * null, as the type is determined by the intent data.
6173 *
6174 * @return If a type was manually set, it is returned; else null is
6175 * returned.
6176 *
6177 * @see #resolveType(ContentResolver)
6178 * @see #setType
6179 */
6180 public String getType() {
6181 return mType;
6182 }
6183
6184 /**
6185 * Return the MIME data type of this intent. If the type field is
6186 * explicitly set, that is simply returned. Otherwise, if the data is set,
6187 * the type of that data is returned. If neither fields are set, a null is
6188 * returned.
6189 *
6190 * @return The MIME type of this intent.
6191 *
6192 * @see #getType
6193 * @see #resolveType(ContentResolver)
6194 */
6195 public String resolveType(Context context) {
6196 return resolveType(context.getContentResolver());
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 * @param resolver A ContentResolver that can be used to determine the MIME
6206 * type of the intent's data.
6207 *
6208 * @return The MIME type of this intent.
6209 *
6210 * @see #getType
6211 * @see #resolveType(Context)
6212 */
6213 public String resolveType(ContentResolver resolver) {
6214 if (mType != null) {
6215 return mType;
6216 }
6217 if (mData != null) {
6218 if ("content".equals(mData.getScheme())) {
6219 return resolver.getType(mData);
6220 }
6221 }
6222 return null;
6223 }
6224
6225 /**
6226 * Return the MIME data type of this intent, only if it will be needed for
6227 * intent resolution. This is not generally useful for application code;
6228 * it is used by the frameworks for communicating with back-end system
6229 * services.
6230 *
6231 * @param resolver A ContentResolver that can be used to determine the MIME
6232 * type of the intent's data.
6233 *
6234 * @return The MIME type of this intent, or null if it is unknown or not
6235 * needed.
6236 */
6237 public String resolveTypeIfNeeded(ContentResolver resolver) {
6238 if (mComponent != null) {
6239 return mType;
6240 }
6241 return resolveType(resolver);
6242 }
6243
6244 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006245 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006246 *
6247 * @param category The category to check.
6248 *
6249 * @return boolean True if the intent contains the category, else false.
6250 *
6251 * @see #getCategories
6252 * @see #addCategory
6253 */
6254 public boolean hasCategory(String category) {
6255 return mCategories != null && mCategories.contains(category);
6256 }
6257
6258 /**
6259 * Return the set of all categories in the intent. If there are no categories,
6260 * returns NULL.
6261 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006262 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006263 *
6264 * @see #hasCategory
6265 * @see #addCategory
6266 */
6267 public Set<String> getCategories() {
6268 return mCategories;
6269 }
6270
6271 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006272 * Return the specific selector associated with this Intent. If there is
6273 * none, returns null. See {@link #setSelector} for more information.
6274 *
6275 * @see #setSelector
6276 */
6277 public Intent getSelector() {
6278 return mSelector;
6279 }
6280
6281 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006282 * Return the {@link ClipData} associated with this Intent. If there is
6283 * none, returns null. See {@link #setClipData} for more information.
6284 *
John Spurlock125d1332013-11-25 11:58:37 -05006285 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006286 */
6287 public ClipData getClipData() {
6288 return mClipData;
6289 }
6290
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006291 /** @hide */
6292 public int getContentUserHint() {
6293 return mContentUserHint;
6294 }
6295
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006296 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006297 * Sets the ClassLoader that will be used when unmarshalling
6298 * any Parcelable values from the extras of this Intent.
6299 *
6300 * @param loader a ClassLoader, or null to use the default loader
6301 * at the time of unmarshalling.
6302 */
6303 public void setExtrasClassLoader(ClassLoader loader) {
6304 if (mExtras != null) {
6305 mExtras.setClassLoader(loader);
6306 }
6307 }
6308
6309 /**
6310 * Returns true if an extra value is associated with the given name.
6311 * @param name the extra's name
6312 * @return true if the given extra is present.
6313 */
6314 public boolean hasExtra(String name) {
6315 return mExtras != null && mExtras.containsKey(name);
6316 }
6317
6318 /**
6319 * Returns true if the Intent's extras contain a parcelled file descriptor.
6320 * @return true if the Intent contains a parcelled file descriptor.
6321 */
6322 public boolean hasFileDescriptors() {
6323 return mExtras != null && mExtras.hasFileDescriptors();
6324 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006325
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006326 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006327 public void setAllowFds(boolean allowFds) {
6328 if (mExtras != null) {
6329 mExtras.setAllowFds(allowFds);
6330 }
6331 }
6332
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006333 /** {@hide} */
6334 public void setDefusable(boolean defusable) {
6335 if (mExtras != null) {
6336 mExtras.setDefusable(defusable);
6337 }
6338 }
6339
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006340 /**
6341 * Retrieve extended data from the intent.
6342 *
6343 * @param name The name of the desired item.
6344 *
6345 * @return the value of an item that previously added with putExtra()
6346 * or null if none was found.
6347 *
6348 * @deprecated
6349 * @hide
6350 */
6351 @Deprecated
6352 public Object getExtra(String name) {
6353 return getExtra(name, null);
6354 }
6355
6356 /**
6357 * Retrieve extended data from the intent.
6358 *
6359 * @param name The name of the desired item.
6360 * @param defaultValue the value to be returned if no value of the desired
6361 * type is stored with the given name.
6362 *
6363 * @return the value of an item that previously added with putExtra()
6364 * or the default value if none was found.
6365 *
6366 * @see #putExtra(String, boolean)
6367 */
6368 public boolean getBooleanExtra(String name, boolean defaultValue) {
6369 return mExtras == null ? defaultValue :
6370 mExtras.getBoolean(name, defaultValue);
6371 }
6372
6373 /**
6374 * Retrieve extended data from the intent.
6375 *
6376 * @param name The name of the desired item.
6377 * @param defaultValue the value to be returned if no value of the desired
6378 * type is stored with the given name.
6379 *
6380 * @return the value of an item that previously added with putExtra()
6381 * or the default value if none was found.
6382 *
6383 * @see #putExtra(String, byte)
6384 */
6385 public byte getByteExtra(String name, byte defaultValue) {
6386 return mExtras == null ? defaultValue :
6387 mExtras.getByte(name, defaultValue);
6388 }
6389
6390 /**
6391 * Retrieve extended data from the intent.
6392 *
6393 * @param name The name of the desired item.
6394 * @param defaultValue the value to be returned if no value of the desired
6395 * type is stored with the given name.
6396 *
6397 * @return the value of an item that previously added with putExtra()
6398 * or the default value if none was found.
6399 *
6400 * @see #putExtra(String, short)
6401 */
6402 public short getShortExtra(String name, short defaultValue) {
6403 return mExtras == null ? defaultValue :
6404 mExtras.getShort(name, defaultValue);
6405 }
6406
6407 /**
6408 * Retrieve extended data from the intent.
6409 *
6410 * @param name The name of the desired item.
6411 * @param defaultValue the value to be returned if no value of the desired
6412 * type is stored with the given name.
6413 *
6414 * @return the value of an item that previously added with putExtra()
6415 * or the default value if none was found.
6416 *
6417 * @see #putExtra(String, char)
6418 */
6419 public char getCharExtra(String name, char defaultValue) {
6420 return mExtras == null ? defaultValue :
6421 mExtras.getChar(name, defaultValue);
6422 }
6423
6424 /**
6425 * Retrieve extended data from the intent.
6426 *
6427 * @param name The name of the desired item.
6428 * @param defaultValue the value to be returned if no value of the desired
6429 * type is stored with the given name.
6430 *
6431 * @return the value of an item that previously added with putExtra()
6432 * or the default value if none was found.
6433 *
6434 * @see #putExtra(String, int)
6435 */
6436 public int getIntExtra(String name, int defaultValue) {
6437 return mExtras == null ? defaultValue :
6438 mExtras.getInt(name, defaultValue);
6439 }
6440
6441 /**
6442 * Retrieve extended data from the intent.
6443 *
6444 * @param name The name of the desired item.
6445 * @param defaultValue the value to be returned if no value of the desired
6446 * type is stored with the given name.
6447 *
6448 * @return the value of an item that previously added with putExtra()
6449 * or the default value if none was found.
6450 *
6451 * @see #putExtra(String, long)
6452 */
6453 public long getLongExtra(String name, long defaultValue) {
6454 return mExtras == null ? defaultValue :
6455 mExtras.getLong(name, defaultValue);
6456 }
6457
6458 /**
6459 * Retrieve extended data from the intent.
6460 *
6461 * @param name The name of the desired item.
6462 * @param defaultValue the value to be returned if no value of the desired
6463 * type is stored with the given name.
6464 *
6465 * @return the value of an item that previously added with putExtra(),
6466 * or the default value if no such item is present
6467 *
6468 * @see #putExtra(String, float)
6469 */
6470 public float getFloatExtra(String name, float defaultValue) {
6471 return mExtras == null ? defaultValue :
6472 mExtras.getFloat(name, defaultValue);
6473 }
6474
6475 /**
6476 * Retrieve extended data from the intent.
6477 *
6478 * @param name The name of the desired item.
6479 * @param defaultValue the value to be returned if no value of the desired
6480 * type is stored with the given name.
6481 *
6482 * @return the value of an item that previously added with putExtra()
6483 * or the default value if none was found.
6484 *
6485 * @see #putExtra(String, double)
6486 */
6487 public double getDoubleExtra(String name, double defaultValue) {
6488 return mExtras == null ? defaultValue :
6489 mExtras.getDouble(name, defaultValue);
6490 }
6491
6492 /**
6493 * Retrieve extended data from the intent.
6494 *
6495 * @param name The name of the desired item.
6496 *
6497 * @return the value of an item that previously added with putExtra()
6498 * or null if no String value was found.
6499 *
6500 * @see #putExtra(String, String)
6501 */
6502 public String getStringExtra(String name) {
6503 return mExtras == null ? null : mExtras.getString(name);
6504 }
6505
6506 /**
6507 * Retrieve extended data from the intent.
6508 *
6509 * @param name The name of the desired item.
6510 *
6511 * @return the value of an item that previously added with putExtra()
6512 * or null if no CharSequence value was found.
6513 *
6514 * @see #putExtra(String, CharSequence)
6515 */
6516 public CharSequence getCharSequenceExtra(String name) {
6517 return mExtras == null ? null : mExtras.getCharSequence(name);
6518 }
6519
6520 /**
6521 * Retrieve extended data from the intent.
6522 *
6523 * @param name The name of the desired item.
6524 *
6525 * @return the value of an item that previously added with putExtra()
6526 * or null if no Parcelable value was found.
6527 *
6528 * @see #putExtra(String, Parcelable)
6529 */
6530 public <T extends Parcelable> T getParcelableExtra(String name) {
6531 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6532 }
6533
6534 /**
6535 * Retrieve extended data from the intent.
6536 *
6537 * @param name The name of the desired item.
6538 *
6539 * @return the value of an item that previously added with putExtra()
6540 * or null if no Parcelable[] value was found.
6541 *
6542 * @see #putExtra(String, Parcelable[])
6543 */
6544 public Parcelable[] getParcelableArrayExtra(String name) {
6545 return mExtras == null ? null : mExtras.getParcelableArray(name);
6546 }
6547
6548 /**
6549 * Retrieve extended data from the intent.
6550 *
6551 * @param name The name of the desired item.
6552 *
6553 * @return the value of an item that previously added with putExtra()
6554 * or null if no ArrayList<Parcelable> value was found.
6555 *
6556 * @see #putParcelableArrayListExtra(String, ArrayList)
6557 */
6558 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6559 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6560 }
6561
6562 /**
6563 * Retrieve extended data from the intent.
6564 *
6565 * @param name The name of the desired item.
6566 *
6567 * @return the value of an item that previously added with putExtra()
6568 * or null if no Serializable value was found.
6569 *
6570 * @see #putExtra(String, Serializable)
6571 */
6572 public Serializable getSerializableExtra(String name) {
6573 return mExtras == null ? null : mExtras.getSerializable(name);
6574 }
6575
6576 /**
6577 * Retrieve extended data from the intent.
6578 *
6579 * @param name The name of the desired item.
6580 *
6581 * @return the value of an item that previously added with putExtra()
6582 * or null if no ArrayList<Integer> value was found.
6583 *
6584 * @see #putIntegerArrayListExtra(String, ArrayList)
6585 */
6586 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6587 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6588 }
6589
6590 /**
6591 * Retrieve extended data from the intent.
6592 *
6593 * @param name The name of the desired item.
6594 *
6595 * @return the value of an item that previously added with putExtra()
6596 * or null if no ArrayList<String> value was found.
6597 *
6598 * @see #putStringArrayListExtra(String, ArrayList)
6599 */
6600 public ArrayList<String> getStringArrayListExtra(String name) {
6601 return mExtras == null ? null : mExtras.getStringArrayList(name);
6602 }
6603
6604 /**
6605 * Retrieve extended data from the intent.
6606 *
6607 * @param name The name of the desired item.
6608 *
6609 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006610 * or null if no ArrayList<CharSequence> value was found.
6611 *
6612 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6613 */
6614 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6615 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6616 }
6617
6618 /**
6619 * Retrieve extended data from the intent.
6620 *
6621 * @param name The name of the desired item.
6622 *
6623 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006624 * or null if no boolean array value was found.
6625 *
6626 * @see #putExtra(String, boolean[])
6627 */
6628 public boolean[] getBooleanArrayExtra(String name) {
6629 return mExtras == null ? null : mExtras.getBooleanArray(name);
6630 }
6631
6632 /**
6633 * Retrieve extended data from the intent.
6634 *
6635 * @param name The name of the desired item.
6636 *
6637 * @return the value of an item that previously added with putExtra()
6638 * or null if no byte array value was found.
6639 *
6640 * @see #putExtra(String, byte[])
6641 */
6642 public byte[] getByteArrayExtra(String name) {
6643 return mExtras == null ? null : mExtras.getByteArray(name);
6644 }
6645
6646 /**
6647 * Retrieve extended data from the intent.
6648 *
6649 * @param name The name of the desired item.
6650 *
6651 * @return the value of an item that previously added with putExtra()
6652 * or null if no short array value was found.
6653 *
6654 * @see #putExtra(String, short[])
6655 */
6656 public short[] getShortArrayExtra(String name) {
6657 return mExtras == null ? null : mExtras.getShortArray(name);
6658 }
6659
6660 /**
6661 * Retrieve extended data from the intent.
6662 *
6663 * @param name The name of the desired item.
6664 *
6665 * @return the value of an item that previously added with putExtra()
6666 * or null if no char array value was found.
6667 *
6668 * @see #putExtra(String, char[])
6669 */
6670 public char[] getCharArrayExtra(String name) {
6671 return mExtras == null ? null : mExtras.getCharArray(name);
6672 }
6673
6674 /**
6675 * Retrieve extended data from the intent.
6676 *
6677 * @param name The name of the desired item.
6678 *
6679 * @return the value of an item that previously added with putExtra()
6680 * or null if no int array value was found.
6681 *
6682 * @see #putExtra(String, int[])
6683 */
6684 public int[] getIntArrayExtra(String name) {
6685 return mExtras == null ? null : mExtras.getIntArray(name);
6686 }
6687
6688 /**
6689 * Retrieve extended data from the intent.
6690 *
6691 * @param name The name of the desired item.
6692 *
6693 * @return the value of an item that previously added with putExtra()
6694 * or null if no long array value was found.
6695 *
6696 * @see #putExtra(String, long[])
6697 */
6698 public long[] getLongArrayExtra(String name) {
6699 return mExtras == null ? null : mExtras.getLongArray(name);
6700 }
6701
6702 /**
6703 * Retrieve extended data from the intent.
6704 *
6705 * @param name The name of the desired item.
6706 *
6707 * @return the value of an item that previously added with putExtra()
6708 * or null if no float array value was found.
6709 *
6710 * @see #putExtra(String, float[])
6711 */
6712 public float[] getFloatArrayExtra(String name) {
6713 return mExtras == null ? null : mExtras.getFloatArray(name);
6714 }
6715
6716 /**
6717 * Retrieve extended data from the intent.
6718 *
6719 * @param name The name of the desired item.
6720 *
6721 * @return the value of an item that previously added with putExtra()
6722 * or null if no double array value was found.
6723 *
6724 * @see #putExtra(String, double[])
6725 */
6726 public double[] getDoubleArrayExtra(String name) {
6727 return mExtras == null ? null : mExtras.getDoubleArray(name);
6728 }
6729
6730 /**
6731 * Retrieve extended data from the intent.
6732 *
6733 * @param name The name of the desired item.
6734 *
6735 * @return the value of an item that previously added with putExtra()
6736 * or null if no String array value was found.
6737 *
6738 * @see #putExtra(String, String[])
6739 */
6740 public String[] getStringArrayExtra(String name) {
6741 return mExtras == null ? null : mExtras.getStringArray(name);
6742 }
6743
6744 /**
6745 * Retrieve extended data from the intent.
6746 *
6747 * @param name The name of the desired item.
6748 *
6749 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006750 * or null if no CharSequence array value was found.
6751 *
6752 * @see #putExtra(String, CharSequence[])
6753 */
6754 public CharSequence[] getCharSequenceArrayExtra(String name) {
6755 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6756 }
6757
6758 /**
6759 * Retrieve extended data from the intent.
6760 *
6761 * @param name The name of the desired item.
6762 *
6763 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006764 * or null if no Bundle value was found.
6765 *
6766 * @see #putExtra(String, Bundle)
6767 */
6768 public Bundle getBundleExtra(String name) {
6769 return mExtras == null ? null : mExtras.getBundle(name);
6770 }
6771
6772 /**
6773 * Retrieve extended data from the intent.
6774 *
6775 * @param name The name of the desired item.
6776 *
6777 * @return the value of an item that previously added with putExtra()
6778 * or null if no IBinder value was found.
6779 *
6780 * @see #putExtra(String, IBinder)
6781 *
6782 * @deprecated
6783 * @hide
6784 */
6785 @Deprecated
6786 public IBinder getIBinderExtra(String name) {
6787 return mExtras == null ? null : mExtras.getIBinder(name);
6788 }
6789
6790 /**
6791 * Retrieve extended data from the intent.
6792 *
6793 * @param name The name of the desired item.
6794 * @param defaultValue The default value to return in case no item is
6795 * associated with the key 'name'
6796 *
6797 * @return the value of an item that previously added with putExtra()
6798 * or defaultValue if none was found.
6799 *
6800 * @see #putExtra
6801 *
6802 * @deprecated
6803 * @hide
6804 */
6805 @Deprecated
6806 public Object getExtra(String name, Object defaultValue) {
6807 Object result = defaultValue;
6808 if (mExtras != null) {
6809 Object result2 = mExtras.get(name);
6810 if (result2 != null) {
6811 result = result2;
6812 }
6813 }
6814
6815 return result;
6816 }
6817
6818 /**
6819 * Retrieves a map of extended data from the intent.
6820 *
6821 * @return the map of all extras previously added with putExtra(),
6822 * or null if none have been added.
6823 */
6824 public Bundle getExtras() {
6825 return (mExtras != null)
6826 ? new Bundle(mExtras)
6827 : null;
6828 }
6829
6830 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006831 * Filter extras to only basic types.
6832 * @hide
6833 */
6834 public void removeUnsafeExtras() {
6835 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006836 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006837 }
6838 }
6839
6840 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006841 * Retrieve any special flags associated with this intent. You will
6842 * normally just set them with {@link #setFlags} and let the system
6843 * take the appropriate action with them.
6844 *
6845 * @return int The currently set flags.
6846 *
6847 * @see #setFlags
6848 */
6849 public int getFlags() {
6850 return mFlags;
6851 }
6852
Dianne Hackborne7f97212011-02-24 14:40:20 -08006853 /** @hide */
6854 public boolean isExcludingStopped() {
6855 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6856 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6857 }
6858
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006859 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006860 * Retrieve the application package name this Intent is limited to. When
6861 * resolving an Intent, if non-null this limits the resolution to only
6862 * components in the given application package.
6863 *
6864 * @return The name of the application package for the Intent.
6865 *
6866 * @see #resolveActivity
6867 * @see #setPackage
6868 */
6869 public String getPackage() {
6870 return mPackage;
6871 }
6872
6873 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874 * Retrieve the concrete component associated with the intent. When receiving
6875 * an intent, this is the component that was found to best handle it (that is,
6876 * yourself) and will always be non-null; in all other cases it will be
6877 * null unless explicitly set.
6878 *
6879 * @return The name of the application component to handle the intent.
6880 *
6881 * @see #resolveActivity
6882 * @see #setComponent
6883 */
6884 public ComponentName getComponent() {
6885 return mComponent;
6886 }
6887
6888 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006889 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6890 * used as a hint to the receiver for animations and the like. Null means that there
6891 * is no source bounds.
6892 */
6893 public Rect getSourceBounds() {
6894 return mSourceBounds;
6895 }
6896
6897 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006898 * Return the Activity component that should be used to handle this intent.
6899 * The appropriate component is determined based on the information in the
6900 * intent, evaluated as follows:
6901 *
6902 * <p>If {@link #getComponent} returns an explicit class, that is returned
6903 * without any further consideration.
6904 *
6905 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6906 * category to be considered.
6907 *
6908 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6909 * action.
6910 *
6911 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6912 * this type.
6913 *
6914 * <p>If {@link #addCategory} has added any categories, the activity must
6915 * handle ALL of the categories specified.
6916 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006917 * <p>If {@link #getPackage} is non-NULL, only activity components in
6918 * that application package will be considered.
6919 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006920 * <p>If there are no activities that satisfy all of these conditions, a
6921 * null string is returned.
6922 *
6923 * <p>If multiple activities are found to satisfy the intent, the one with
6924 * the highest priority will be used. If there are multiple activities
6925 * with the same priority, the system will either pick the best activity
6926 * based on user preference, or resolve to a system class that will allow
6927 * the user to pick an activity and forward from there.
6928 *
6929 * <p>This method is implemented simply by calling
6930 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6931 * true.</p>
6932 * <p> This API is called for you as part of starting an activity from an
6933 * intent. You do not normally need to call it yourself.</p>
6934 *
6935 * @param pm The package manager with which to resolve the Intent.
6936 *
6937 * @return Name of the component implementing an activity that can
6938 * display the intent.
6939 *
6940 * @see #setComponent
6941 * @see #getComponent
6942 * @see #resolveActivityInfo
6943 */
6944 public ComponentName resolveActivity(PackageManager pm) {
6945 if (mComponent != null) {
6946 return mComponent;
6947 }
6948
6949 ResolveInfo info = pm.resolveActivity(
6950 this, PackageManager.MATCH_DEFAULT_ONLY);
6951 if (info != null) {
6952 return new ComponentName(
6953 info.activityInfo.applicationInfo.packageName,
6954 info.activityInfo.name);
6955 }
6956
6957 return null;
6958 }
6959
6960 /**
6961 * Resolve the Intent into an {@link ActivityInfo}
6962 * describing the activity that should execute the intent. Resolution
6963 * follows the same rules as described for {@link #resolveActivity}, but
6964 * you get back the completely information about the resolved activity
6965 * instead of just its class name.
6966 *
6967 * @param pm The package manager with which to resolve the Intent.
6968 * @param flags Addition information to retrieve as per
6969 * {@link PackageManager#getActivityInfo(ComponentName, int)
6970 * PackageManager.getActivityInfo()}.
6971 *
6972 * @return PackageManager.ActivityInfo
6973 *
6974 * @see #resolveActivity
6975 */
6976 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6977 ActivityInfo ai = null;
6978 if (mComponent != null) {
6979 try {
6980 ai = pm.getActivityInfo(mComponent, flags);
6981 } catch (PackageManager.NameNotFoundException e) {
6982 // ignore
6983 }
6984 } else {
6985 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006986 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006987 if (info != null) {
6988 ai = info.activityInfo;
6989 }
6990 }
6991
6992 return ai;
6993 }
6994
6995 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006996 * Special function for use by the system to resolve service
6997 * intents to system apps. Throws an exception if there are
6998 * multiple potential matches to the Intent. Returns null if
6999 * there are no matches.
7000 * @hide
7001 */
7002 public ComponentName resolveSystemService(PackageManager pm, int flags) {
7003 if (mComponent != null) {
7004 return mComponent;
7005 }
7006
7007 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
7008 if (results == null) {
7009 return null;
7010 }
7011 ComponentName comp = null;
7012 for (int i=0; i<results.size(); i++) {
7013 ResolveInfo ri = results.get(i);
7014 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
7015 continue;
7016 }
7017 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
7018 ri.serviceInfo.name);
7019 if (comp != null) {
7020 throw new IllegalStateException("Multiple system services handle " + this
7021 + ": " + comp + ", " + foundComp);
7022 }
7023 comp = foundComp;
7024 }
7025 return comp;
7026 }
7027
7028 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007029 * Set the general action to be performed.
7030 *
7031 * @param action An action name, such as ACTION_VIEW. Application-specific
7032 * actions should be prefixed with the vendor's package name.
7033 *
7034 * @return Returns the same Intent object, for chaining multiple calls
7035 * into a single statement.
7036 *
7037 * @see #getAction
7038 */
7039 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007040 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007041 return this;
7042 }
7043
7044 /**
7045 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08007046 * clears any type that was previously set by {@link #setType} or
7047 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007048 *
Nick Pellyccae4122012-01-09 14:12:58 -08007049 * <p><em>Note: scheme matching in the Android framework is
7050 * case-sensitive, unlike the formal RFC. As a result,
7051 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007052 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007053 * {@link #setDataAndNormalize}
7054 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007055 *
Nick Pellyccae4122012-01-09 14:12:58 -08007056 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007057 *
7058 * @return Returns the same Intent object, for chaining multiple calls
7059 * into a single statement.
7060 *
7061 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08007062 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07007063 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007064 */
7065 public Intent setData(Uri data) {
7066 mData = data;
7067 mType = null;
7068 return this;
7069 }
7070
7071 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007072 * Normalize and set the data this intent is operating on.
7073 *
7074 * <p>This method automatically clears any type that was
7075 * previously set (for example, by {@link #setType}).
7076 *
7077 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007078 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08007079 * so really this is just a convenience method for
7080 * <pre>
7081 * setData(data.normalize())
7082 * </pre>
7083 *
7084 * @param data The Uri of the data this intent is now targeting.
7085 *
7086 * @return Returns the same Intent object, for chaining multiple calls
7087 * into a single statement.
7088 *
7089 * @see #getData
7090 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007091 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007092 */
7093 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007094 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08007095 }
7096
7097 /**
7098 * Set an explicit MIME data type.
7099 *
7100 * <p>This is used to create intents that only specify a type and not data,
7101 * for example to indicate the type of data to return.
7102 *
7103 * <p>This method automatically clears any data that was
7104 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07007105 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007106 * <p><em>Note: MIME type matching in the Android framework is
7107 * case-sensitive, unlike formal RFC MIME types. As a result,
7108 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08007109 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
7110 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007111 *
7112 * @param type The MIME type of the data being handled by this intent.
7113 *
7114 * @return Returns the same Intent object, for chaining multiple calls
7115 * into a single statement.
7116 *
7117 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08007118 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007119 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08007120 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007121 */
7122 public Intent setType(String type) {
7123 mData = null;
7124 mType = type;
7125 return this;
7126 }
7127
7128 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007129 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007130 *
Nick Pellyccae4122012-01-09 14:12:58 -08007131 * <p>This is used to create intents that only specify a type and not data,
7132 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07007133 *
Nick Pellyccae4122012-01-09 14:12:58 -08007134 * <p>This method automatically clears any data that was
7135 * previously set (for example by {@link #setData}).
7136 *
7137 * <p>The MIME type is normalized using
7138 * {@link #normalizeMimeType} before it is set,
7139 * so really this is just a convenience method for
7140 * <pre>
7141 * setType(Intent.normalizeMimeType(type))
7142 * </pre>
7143 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007144 * @param type The MIME type of the data being handled by this intent.
7145 *
7146 * @return Returns the same Intent object, for chaining multiple calls
7147 * into a single statement.
7148 *
Nick Pellyccae4122012-01-09 14:12:58 -08007149 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007150 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007151 * @see #normalizeMimeType
7152 */
7153 public Intent setTypeAndNormalize(String type) {
7154 return setType(normalizeMimeType(type));
7155 }
7156
7157 /**
7158 * (Usually optional) Set the data for the intent along with an explicit
7159 * MIME data type. This method should very rarely be used -- it allows you
7160 * to override the MIME type that would ordinarily be inferred from the
7161 * data with your own type given here.
7162 *
7163 * <p><em>Note: MIME type and Uri scheme matching in the
7164 * Android framework is case-sensitive, unlike the formal RFC definitions.
7165 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007166 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007167 * {@link #setDataAndTypeAndNormalize}
7168 * to ensure that they are converted to lower case.</em>
7169 *
7170 * @param data The Uri of the data this intent is now targeting.
7171 * @param type The MIME type of the data being handled by this intent.
7172 *
7173 * @return Returns the same Intent object, for chaining multiple calls
7174 * into a single statement.
7175 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007176 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007177 * @see #setData
7178 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007179 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007180 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007181 */
7182 public Intent setDataAndType(Uri data, String type) {
7183 mData = data;
7184 mType = type;
7185 return this;
7186 }
7187
7188 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007189 * (Usually optional) Normalize and set both the data Uri and an explicit
7190 * MIME data type. This method should very rarely be used -- it allows you
7191 * to override the MIME type that would ordinarily be inferred from the
7192 * data with your own type given here.
7193 *
7194 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007195 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007196 * before they are set, so really this is just a convenience method for
7197 * <pre>
7198 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7199 * </pre>
7200 *
7201 * @param data The Uri of the data this intent is now targeting.
7202 * @param type The MIME type of the data being handled by this intent.
7203 *
7204 * @return Returns the same Intent object, for chaining multiple calls
7205 * into a single statement.
7206 *
7207 * @see #setType
7208 * @see #setData
7209 * @see #setDataAndType
7210 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007211 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007212 */
7213 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007214 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007215 }
7216
7217 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007218 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007219 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007220 * activities that provide <em>all</em> of the requested categories will be
7221 * used.
7222 *
7223 * @param category The desired category. This can be either one of the
7224 * predefined Intent categories, or a custom category in your own
7225 * namespace.
7226 *
7227 * @return Returns the same Intent object, for chaining multiple calls
7228 * into a single statement.
7229 *
7230 * @see #hasCategory
7231 * @see #removeCategory
7232 */
7233 public Intent addCategory(String category) {
7234 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007235 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007236 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007237 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007238 return this;
7239 }
7240
7241 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007242 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007243 *
7244 * @param category The category to remove.
7245 *
7246 * @see #addCategory
7247 */
7248 public void removeCategory(String category) {
7249 if (mCategories != null) {
7250 mCategories.remove(category);
7251 if (mCategories.size() == 0) {
7252 mCategories = null;
7253 }
7254 }
7255 }
7256
7257 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007258 * Set a selector for this Intent. This is a modification to the kinds of
7259 * things the Intent will match. If the selector is set, it will be used
7260 * when trying to find entities that can handle the Intent, instead of the
7261 * main contents of the Intent. This allows you build an Intent containing
7262 * a generic protocol while targeting it more specifically.
7263 *
7264 * <p>An example of where this may be used is with things like
7265 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7266 * Intent that will launch the Browser application. However, the correct
7267 * main entry point of an application is actually {@link #ACTION_MAIN}
7268 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7269 * used to specify the actual Activity to launch. If you launch the browser
7270 * with something different, undesired behavior may happen if the user has
7271 * previously or later launches it the normal way, since they do not match.
7272 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7273 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7274 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7275 *
7276 * <p>Setting a selector does not impact the behavior of
7277 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7278 * desired behavior of a selector -- it does not impact the base meaning
7279 * of the Intent, just what kinds of things will be matched against it
7280 * when determining who can handle it.</p>
7281 *
7282 * <p>You can not use both a selector and {@link #setPackage(String)} on
7283 * the same base Intent.</p>
7284 *
7285 * @param selector The desired selector Intent; set to null to not use
7286 * a special selector.
7287 */
7288 public void setSelector(Intent selector) {
7289 if (selector == this) {
7290 throw new IllegalArgumentException(
7291 "Intent being set as a selector of itself");
7292 }
7293 if (selector != null && mPackage != null) {
7294 throw new IllegalArgumentException(
7295 "Can't set selector when package name is already set");
7296 }
7297 mSelector = selector;
7298 }
7299
7300 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007301 * Set a {@link ClipData} associated with this Intent. This replaces any
7302 * previously set ClipData.
7303 *
7304 * <p>The ClipData in an intent is not used for Intent matching or other
7305 * such operations. Semantically it is like extras, used to transmit
7306 * additional data with the Intent. The main feature of using this over
7307 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7308 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7309 * items included in the clip data. This is useful, in particular, if
7310 * you want to transmit an Intent containing multiple <code>content:</code>
7311 * URIs for which the recipient may not have global permission to access the
7312 * content provider.
7313 *
7314 * <p>If the ClipData contains items that are themselves Intents, any
7315 * grant flags in those Intents will be ignored. Only the top-level flags
7316 * of the main Intent are respected, and will be applied to all Uri or
7317 * Intent items in the clip (or sub-items of the clip).
7318 *
7319 * <p>The MIME type, label, and icon in the ClipData object are not
7320 * directly used by Intent. Applications should generally rely on the
7321 * MIME type of the Intent itself, not what it may find in the ClipData.
7322 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007323 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007324 *
7325 * @param clip The new clip to set. May be null to clear the current clip.
7326 */
7327 public void setClipData(ClipData clip) {
7328 mClipData = clip;
7329 }
7330
7331 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007332 * This is NOT a secure mechanism to identify the user who sent the intent.
7333 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7334 * who sent the intent.
7335 * @hide
7336 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007337 public void prepareToLeaveUser(int userId) {
7338 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7339 // We want mContentUserHint to refer to the original user, so don't do anything.
7340 if (mContentUserHint == UserHandle.USER_CURRENT) {
7341 mContentUserHint = userId;
7342 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007343 }
7344
7345 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007346 * Add extended data to the intent. The name must include a package
7347 * prefix, for example the app com.android.contacts would use names
7348 * like "com.android.contacts.ShowAll".
7349 *
7350 * @param name The name of the extra data, with package prefix.
7351 * @param value The boolean data value.
7352 *
7353 * @return Returns the same Intent object, for chaining multiple calls
7354 * into a single statement.
7355 *
7356 * @see #putExtras
7357 * @see #removeExtra
7358 * @see #getBooleanExtra(String, boolean)
7359 */
7360 public Intent putExtra(String name, boolean value) {
7361 if (mExtras == null) {
7362 mExtras = new Bundle();
7363 }
7364 mExtras.putBoolean(name, value);
7365 return this;
7366 }
7367
7368 /**
7369 * Add extended data to the intent. The name must include a package
7370 * prefix, for example the app com.android.contacts would use names
7371 * like "com.android.contacts.ShowAll".
7372 *
7373 * @param name The name of the extra data, with package prefix.
7374 * @param value The byte data value.
7375 *
7376 * @return Returns the same Intent object, for chaining multiple calls
7377 * into a single statement.
7378 *
7379 * @see #putExtras
7380 * @see #removeExtra
7381 * @see #getByteExtra(String, byte)
7382 */
7383 public Intent putExtra(String name, byte value) {
7384 if (mExtras == null) {
7385 mExtras = new Bundle();
7386 }
7387 mExtras.putByte(name, value);
7388 return this;
7389 }
7390
7391 /**
7392 * Add extended data to the intent. The name must include a package
7393 * prefix, for example the app com.android.contacts would use names
7394 * like "com.android.contacts.ShowAll".
7395 *
7396 * @param name The name of the extra data, with package prefix.
7397 * @param value The char data value.
7398 *
7399 * @return Returns the same Intent object, for chaining multiple calls
7400 * into a single statement.
7401 *
7402 * @see #putExtras
7403 * @see #removeExtra
7404 * @see #getCharExtra(String, char)
7405 */
7406 public Intent putExtra(String name, char value) {
7407 if (mExtras == null) {
7408 mExtras = new Bundle();
7409 }
7410 mExtras.putChar(name, value);
7411 return this;
7412 }
7413
7414 /**
7415 * Add extended data to the intent. The name must include a package
7416 * prefix, for example the app com.android.contacts would use names
7417 * like "com.android.contacts.ShowAll".
7418 *
7419 * @param name The name of the extra data, with package prefix.
7420 * @param value The short data value.
7421 *
7422 * @return Returns the same Intent object, for chaining multiple calls
7423 * into a single statement.
7424 *
7425 * @see #putExtras
7426 * @see #removeExtra
7427 * @see #getShortExtra(String, short)
7428 */
7429 public Intent putExtra(String name, short value) {
7430 if (mExtras == null) {
7431 mExtras = new Bundle();
7432 }
7433 mExtras.putShort(name, value);
7434 return this;
7435 }
7436
7437 /**
7438 * Add extended data to the intent. The name must include a package
7439 * prefix, for example the app com.android.contacts would use names
7440 * like "com.android.contacts.ShowAll".
7441 *
7442 * @param name The name of the extra data, with package prefix.
7443 * @param value The integer data value.
7444 *
7445 * @return Returns the same Intent object, for chaining multiple calls
7446 * into a single statement.
7447 *
7448 * @see #putExtras
7449 * @see #removeExtra
7450 * @see #getIntExtra(String, int)
7451 */
7452 public Intent putExtra(String name, int value) {
7453 if (mExtras == null) {
7454 mExtras = new Bundle();
7455 }
7456 mExtras.putInt(name, value);
7457 return this;
7458 }
7459
7460 /**
7461 * Add extended data to the intent. The name must include a package
7462 * prefix, for example the app com.android.contacts would use names
7463 * like "com.android.contacts.ShowAll".
7464 *
7465 * @param name The name of the extra data, with package prefix.
7466 * @param value The long data value.
7467 *
7468 * @return Returns the same Intent object, for chaining multiple calls
7469 * into a single statement.
7470 *
7471 * @see #putExtras
7472 * @see #removeExtra
7473 * @see #getLongExtra(String, long)
7474 */
7475 public Intent putExtra(String name, long value) {
7476 if (mExtras == null) {
7477 mExtras = new Bundle();
7478 }
7479 mExtras.putLong(name, value);
7480 return this;
7481 }
7482
7483 /**
7484 * Add extended data to the intent. The name must include a package
7485 * prefix, for example the app com.android.contacts would use names
7486 * like "com.android.contacts.ShowAll".
7487 *
7488 * @param name The name of the extra data, with package prefix.
7489 * @param value The float data value.
7490 *
7491 * @return Returns the same Intent object, for chaining multiple calls
7492 * into a single statement.
7493 *
7494 * @see #putExtras
7495 * @see #removeExtra
7496 * @see #getFloatExtra(String, float)
7497 */
7498 public Intent putExtra(String name, float value) {
7499 if (mExtras == null) {
7500 mExtras = new Bundle();
7501 }
7502 mExtras.putFloat(name, value);
7503 return this;
7504 }
7505
7506 /**
7507 * Add extended data to the intent. The name must include a package
7508 * prefix, for example the app com.android.contacts would use names
7509 * like "com.android.contacts.ShowAll".
7510 *
7511 * @param name The name of the extra data, with package prefix.
7512 * @param value The double data value.
7513 *
7514 * @return Returns the same Intent object, for chaining multiple calls
7515 * into a single statement.
7516 *
7517 * @see #putExtras
7518 * @see #removeExtra
7519 * @see #getDoubleExtra(String, double)
7520 */
7521 public Intent putExtra(String name, double value) {
7522 if (mExtras == null) {
7523 mExtras = new Bundle();
7524 }
7525 mExtras.putDouble(name, value);
7526 return this;
7527 }
7528
7529 /**
7530 * Add extended data to the intent. The name must include a package
7531 * prefix, for example the app com.android.contacts would use names
7532 * like "com.android.contacts.ShowAll".
7533 *
7534 * @param name The name of the extra data, with package prefix.
7535 * @param value The String data value.
7536 *
7537 * @return Returns the same Intent object, for chaining multiple calls
7538 * into a single statement.
7539 *
7540 * @see #putExtras
7541 * @see #removeExtra
7542 * @see #getStringExtra(String)
7543 */
7544 public Intent putExtra(String name, String value) {
7545 if (mExtras == null) {
7546 mExtras = new Bundle();
7547 }
7548 mExtras.putString(name, value);
7549 return this;
7550 }
7551
7552 /**
7553 * Add extended data to the intent. The name must include a package
7554 * prefix, for example the app com.android.contacts would use names
7555 * like "com.android.contacts.ShowAll".
7556 *
7557 * @param name The name of the extra data, with package prefix.
7558 * @param value The CharSequence data value.
7559 *
7560 * @return Returns the same Intent object, for chaining multiple calls
7561 * into a single statement.
7562 *
7563 * @see #putExtras
7564 * @see #removeExtra
7565 * @see #getCharSequenceExtra(String)
7566 */
7567 public Intent putExtra(String name, CharSequence value) {
7568 if (mExtras == null) {
7569 mExtras = new Bundle();
7570 }
7571 mExtras.putCharSequence(name, value);
7572 return this;
7573 }
7574
7575 /**
7576 * Add extended data to the intent. The name must include a package
7577 * prefix, for example the app com.android.contacts would use names
7578 * like "com.android.contacts.ShowAll".
7579 *
7580 * @param name The name of the extra data, with package prefix.
7581 * @param value The Parcelable data value.
7582 *
7583 * @return Returns the same Intent object, for chaining multiple calls
7584 * into a single statement.
7585 *
7586 * @see #putExtras
7587 * @see #removeExtra
7588 * @see #getParcelableExtra(String)
7589 */
7590 public Intent putExtra(String name, Parcelable value) {
7591 if (mExtras == null) {
7592 mExtras = new Bundle();
7593 }
7594 mExtras.putParcelable(name, value);
7595 return this;
7596 }
7597
7598 /**
7599 * Add extended data to the intent. The name must include a package
7600 * prefix, for example the app com.android.contacts would use names
7601 * like "com.android.contacts.ShowAll".
7602 *
7603 * @param name The name of the extra data, with package prefix.
7604 * @param value The Parcelable[] data value.
7605 *
7606 * @return Returns the same Intent object, for chaining multiple calls
7607 * into a single statement.
7608 *
7609 * @see #putExtras
7610 * @see #removeExtra
7611 * @see #getParcelableArrayExtra(String)
7612 */
7613 public Intent putExtra(String name, Parcelable[] value) {
7614 if (mExtras == null) {
7615 mExtras = new Bundle();
7616 }
7617 mExtras.putParcelableArray(name, value);
7618 return this;
7619 }
7620
7621 /**
7622 * Add extended data to the intent. The name must include a package
7623 * prefix, for example the app com.android.contacts would use names
7624 * like "com.android.contacts.ShowAll".
7625 *
7626 * @param name The name of the extra data, with package prefix.
7627 * @param value The ArrayList<Parcelable> data value.
7628 *
7629 * @return Returns the same Intent object, for chaining multiple calls
7630 * into a single statement.
7631 *
7632 * @see #putExtras
7633 * @see #removeExtra
7634 * @see #getParcelableArrayListExtra(String)
7635 */
7636 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7637 if (mExtras == null) {
7638 mExtras = new Bundle();
7639 }
7640 mExtras.putParcelableArrayList(name, value);
7641 return this;
7642 }
7643
7644 /**
7645 * Add extended data to the intent. The name must include a package
7646 * prefix, for example the app com.android.contacts would use names
7647 * like "com.android.contacts.ShowAll".
7648 *
7649 * @param name The name of the extra data, with package prefix.
7650 * @param value The ArrayList<Integer> data value.
7651 *
7652 * @return Returns the same Intent object, for chaining multiple calls
7653 * into a single statement.
7654 *
7655 * @see #putExtras
7656 * @see #removeExtra
7657 * @see #getIntegerArrayListExtra(String)
7658 */
7659 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7660 if (mExtras == null) {
7661 mExtras = new Bundle();
7662 }
7663 mExtras.putIntegerArrayList(name, value);
7664 return this;
7665 }
7666
7667 /**
7668 * Add extended data to the intent. The name must include a package
7669 * prefix, for example the app com.android.contacts would use names
7670 * like "com.android.contacts.ShowAll".
7671 *
7672 * @param name The name of the extra data, with package prefix.
7673 * @param value The ArrayList<String> data value.
7674 *
7675 * @return Returns the same Intent object, for chaining multiple calls
7676 * into a single statement.
7677 *
7678 * @see #putExtras
7679 * @see #removeExtra
7680 * @see #getStringArrayListExtra(String)
7681 */
7682 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7683 if (mExtras == null) {
7684 mExtras = new Bundle();
7685 }
7686 mExtras.putStringArrayList(name, value);
7687 return this;
7688 }
7689
7690 /**
7691 * Add extended data to the intent. The name must include a package
7692 * prefix, for example the app com.android.contacts would use names
7693 * like "com.android.contacts.ShowAll".
7694 *
7695 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007696 * @param value The ArrayList<CharSequence> data value.
7697 *
7698 * @return Returns the same Intent object, for chaining multiple calls
7699 * into a single statement.
7700 *
7701 * @see #putExtras
7702 * @see #removeExtra
7703 * @see #getCharSequenceArrayListExtra(String)
7704 */
7705 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7706 if (mExtras == null) {
7707 mExtras = new Bundle();
7708 }
7709 mExtras.putCharSequenceArrayList(name, value);
7710 return this;
7711 }
7712
7713 /**
7714 * Add extended data to the intent. The name must include a package
7715 * prefix, for example the app com.android.contacts would use names
7716 * like "com.android.contacts.ShowAll".
7717 *
7718 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007719 * @param value The Serializable data value.
7720 *
7721 * @return Returns the same Intent object, for chaining multiple calls
7722 * into a single statement.
7723 *
7724 * @see #putExtras
7725 * @see #removeExtra
7726 * @see #getSerializableExtra(String)
7727 */
7728 public Intent putExtra(String name, Serializable value) {
7729 if (mExtras == null) {
7730 mExtras = new Bundle();
7731 }
7732 mExtras.putSerializable(name, value);
7733 return this;
7734 }
7735
7736 /**
7737 * Add extended data to the intent. The name must include a package
7738 * prefix, for example the app com.android.contacts would use names
7739 * like "com.android.contacts.ShowAll".
7740 *
7741 * @param name The name of the extra data, with package prefix.
7742 * @param value The boolean array data value.
7743 *
7744 * @return Returns the same Intent object, for chaining multiple calls
7745 * into a single statement.
7746 *
7747 * @see #putExtras
7748 * @see #removeExtra
7749 * @see #getBooleanArrayExtra(String)
7750 */
7751 public Intent putExtra(String name, boolean[] value) {
7752 if (mExtras == null) {
7753 mExtras = new Bundle();
7754 }
7755 mExtras.putBooleanArray(name, value);
7756 return this;
7757 }
7758
7759 /**
7760 * Add extended data to the intent. The name must include a package
7761 * prefix, for example the app com.android.contacts would use names
7762 * like "com.android.contacts.ShowAll".
7763 *
7764 * @param name The name of the extra data, with package prefix.
7765 * @param value The byte array data value.
7766 *
7767 * @return Returns the same Intent object, for chaining multiple calls
7768 * into a single statement.
7769 *
7770 * @see #putExtras
7771 * @see #removeExtra
7772 * @see #getByteArrayExtra(String)
7773 */
7774 public Intent putExtra(String name, byte[] value) {
7775 if (mExtras == null) {
7776 mExtras = new Bundle();
7777 }
7778 mExtras.putByteArray(name, value);
7779 return this;
7780 }
7781
7782 /**
7783 * Add extended data to the intent. The name must include a package
7784 * prefix, for example the app com.android.contacts would use names
7785 * like "com.android.contacts.ShowAll".
7786 *
7787 * @param name The name of the extra data, with package prefix.
7788 * @param value The short array data value.
7789 *
7790 * @return Returns the same Intent object, for chaining multiple calls
7791 * into a single statement.
7792 *
7793 * @see #putExtras
7794 * @see #removeExtra
7795 * @see #getShortArrayExtra(String)
7796 */
7797 public Intent putExtra(String name, short[] value) {
7798 if (mExtras == null) {
7799 mExtras = new Bundle();
7800 }
7801 mExtras.putShortArray(name, value);
7802 return this;
7803 }
7804
7805 /**
7806 * Add extended data to the intent. The name must include a package
7807 * prefix, for example the app com.android.contacts would use names
7808 * like "com.android.contacts.ShowAll".
7809 *
7810 * @param name The name of the extra data, with package prefix.
7811 * @param value The char array data value.
7812 *
7813 * @return Returns the same Intent object, for chaining multiple calls
7814 * into a single statement.
7815 *
7816 * @see #putExtras
7817 * @see #removeExtra
7818 * @see #getCharArrayExtra(String)
7819 */
7820 public Intent putExtra(String name, char[] value) {
7821 if (mExtras == null) {
7822 mExtras = new Bundle();
7823 }
7824 mExtras.putCharArray(name, value);
7825 return this;
7826 }
7827
7828 /**
7829 * Add extended data to the intent. The name must include a package
7830 * prefix, for example the app com.android.contacts would use names
7831 * like "com.android.contacts.ShowAll".
7832 *
7833 * @param name The name of the extra data, with package prefix.
7834 * @param value The int array data value.
7835 *
7836 * @return Returns the same Intent object, for chaining multiple calls
7837 * into a single statement.
7838 *
7839 * @see #putExtras
7840 * @see #removeExtra
7841 * @see #getIntArrayExtra(String)
7842 */
7843 public Intent putExtra(String name, int[] value) {
7844 if (mExtras == null) {
7845 mExtras = new Bundle();
7846 }
7847 mExtras.putIntArray(name, value);
7848 return this;
7849 }
7850
7851 /**
7852 * Add extended data to the intent. The name must include a package
7853 * prefix, for example the app com.android.contacts would use names
7854 * like "com.android.contacts.ShowAll".
7855 *
7856 * @param name The name of the extra data, with package prefix.
7857 * @param value The byte array data value.
7858 *
7859 * @return Returns the same Intent object, for chaining multiple calls
7860 * into a single statement.
7861 *
7862 * @see #putExtras
7863 * @see #removeExtra
7864 * @see #getLongArrayExtra(String)
7865 */
7866 public Intent putExtra(String name, long[] value) {
7867 if (mExtras == null) {
7868 mExtras = new Bundle();
7869 }
7870 mExtras.putLongArray(name, value);
7871 return this;
7872 }
7873
7874 /**
7875 * Add extended data to the intent. The name must include a package
7876 * prefix, for example the app com.android.contacts would use names
7877 * like "com.android.contacts.ShowAll".
7878 *
7879 * @param name The name of the extra data, with package prefix.
7880 * @param value The float array data value.
7881 *
7882 * @return Returns the same Intent object, for chaining multiple calls
7883 * into a single statement.
7884 *
7885 * @see #putExtras
7886 * @see #removeExtra
7887 * @see #getFloatArrayExtra(String)
7888 */
7889 public Intent putExtra(String name, float[] value) {
7890 if (mExtras == null) {
7891 mExtras = new Bundle();
7892 }
7893 mExtras.putFloatArray(name, value);
7894 return this;
7895 }
7896
7897 /**
7898 * Add extended data to the intent. The name must include a package
7899 * prefix, for example the app com.android.contacts would use names
7900 * like "com.android.contacts.ShowAll".
7901 *
7902 * @param name The name of the extra data, with package prefix.
7903 * @param value The double array data value.
7904 *
7905 * @return Returns the same Intent object, for chaining multiple calls
7906 * into a single statement.
7907 *
7908 * @see #putExtras
7909 * @see #removeExtra
7910 * @see #getDoubleArrayExtra(String)
7911 */
7912 public Intent putExtra(String name, double[] value) {
7913 if (mExtras == null) {
7914 mExtras = new Bundle();
7915 }
7916 mExtras.putDoubleArray(name, value);
7917 return this;
7918 }
7919
7920 /**
7921 * Add extended data to the intent. The name must include a package
7922 * prefix, for example the app com.android.contacts would use names
7923 * like "com.android.contacts.ShowAll".
7924 *
7925 * @param name The name of the extra data, with package prefix.
7926 * @param value The String array data value.
7927 *
7928 * @return Returns the same Intent object, for chaining multiple calls
7929 * into a single statement.
7930 *
7931 * @see #putExtras
7932 * @see #removeExtra
7933 * @see #getStringArrayExtra(String)
7934 */
7935 public Intent putExtra(String name, String[] value) {
7936 if (mExtras == null) {
7937 mExtras = new Bundle();
7938 }
7939 mExtras.putStringArray(name, value);
7940 return this;
7941 }
7942
7943 /**
7944 * Add extended data to the intent. The name must include a package
7945 * prefix, for example the app com.android.contacts would use names
7946 * like "com.android.contacts.ShowAll".
7947 *
7948 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007949 * @param value The CharSequence array data value.
7950 *
7951 * @return Returns the same Intent object, for chaining multiple calls
7952 * into a single statement.
7953 *
7954 * @see #putExtras
7955 * @see #removeExtra
7956 * @see #getCharSequenceArrayExtra(String)
7957 */
7958 public Intent putExtra(String name, CharSequence[] value) {
7959 if (mExtras == null) {
7960 mExtras = new Bundle();
7961 }
7962 mExtras.putCharSequenceArray(name, value);
7963 return this;
7964 }
7965
7966 /**
7967 * Add extended data to the intent. The name must include a package
7968 * prefix, for example the app com.android.contacts would use names
7969 * like "com.android.contacts.ShowAll".
7970 *
7971 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007972 * @param value The Bundle data value.
7973 *
7974 * @return Returns the same Intent object, for chaining multiple calls
7975 * into a single statement.
7976 *
7977 * @see #putExtras
7978 * @see #removeExtra
7979 * @see #getBundleExtra(String)
7980 */
7981 public Intent putExtra(String name, Bundle value) {
7982 if (mExtras == null) {
7983 mExtras = new Bundle();
7984 }
7985 mExtras.putBundle(name, value);
7986 return this;
7987 }
7988
7989 /**
7990 * Add extended data to the intent. The name must include a package
7991 * prefix, for example the app com.android.contacts would use names
7992 * like "com.android.contacts.ShowAll".
7993 *
7994 * @param name The name of the extra data, with package prefix.
7995 * @param value The IBinder data value.
7996 *
7997 * @return Returns the same Intent object, for chaining multiple calls
7998 * into a single statement.
7999 *
8000 * @see #putExtras
8001 * @see #removeExtra
8002 * @see #getIBinderExtra(String)
8003 *
8004 * @deprecated
8005 * @hide
8006 */
8007 @Deprecated
8008 public Intent putExtra(String name, IBinder value) {
8009 if (mExtras == null) {
8010 mExtras = new Bundle();
8011 }
8012 mExtras.putIBinder(name, value);
8013 return this;
8014 }
8015
8016 /**
8017 * Copy all extras in 'src' in to this intent.
8018 *
8019 * @param src Contains the extras to copy.
8020 *
8021 * @see #putExtra
8022 */
8023 public Intent putExtras(Intent src) {
8024 if (src.mExtras != null) {
8025 if (mExtras == null) {
8026 mExtras = new Bundle(src.mExtras);
8027 } else {
8028 mExtras.putAll(src.mExtras);
8029 }
8030 }
8031 return this;
8032 }
8033
8034 /**
8035 * Add a set of extended data to the intent. The keys must include a package
8036 * prefix, for example the app com.android.contacts would use names
8037 * like "com.android.contacts.ShowAll".
8038 *
8039 * @param extras The Bundle of extras to add to this intent.
8040 *
8041 * @see #putExtra
8042 * @see #removeExtra
8043 */
8044 public Intent putExtras(Bundle extras) {
8045 if (mExtras == null) {
8046 mExtras = new Bundle();
8047 }
8048 mExtras.putAll(extras);
8049 return this;
8050 }
8051
8052 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008053 * Completely replace the extras in the Intent with the extras in the
8054 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07008055 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008056 * @param src The exact extras contained in this Intent are copied
8057 * into the target intent, replacing any that were previously there.
8058 */
8059 public Intent replaceExtras(Intent src) {
8060 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
8061 return this;
8062 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008063
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008064 /**
8065 * Completely replace the extras in the Intent with the given Bundle of
8066 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07008067 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008068 * @param extras The new set of extras in the Intent, or null to erase
8069 * all extras.
8070 */
8071 public Intent replaceExtras(Bundle extras) {
8072 mExtras = extras != null ? new Bundle(extras) : null;
8073 return this;
8074 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008075
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008076 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008077 * Remove extended data from the intent.
8078 *
8079 * @see #putExtra
8080 */
8081 public void removeExtra(String name) {
8082 if (mExtras != null) {
8083 mExtras.remove(name);
8084 if (mExtras.size() == 0) {
8085 mExtras = null;
8086 }
8087 }
8088 }
8089
8090 /**
8091 * Set special flags controlling how this intent is handled. Most values
8092 * here depend on the type of component being executed by the Intent,
8093 * specifically the FLAG_ACTIVITY_* flags are all for use with
8094 * {@link Context#startActivity Context.startActivity()} and the
8095 * FLAG_RECEIVER_* flags are all for use with
8096 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
8097 *
Scott Main7aee61f2011-02-08 11:25:01 -08008098 * <p>See the
8099 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
8100 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008101 * the behavior of your application.
8102 *
8103 * @param flags The desired flags.
8104 *
8105 * @return Returns the same Intent object, for chaining multiple calls
8106 * into a single statement.
8107 *
8108 * @see #getFlags
8109 * @see #addFlags
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008110 * @see #removeFlags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008111 *
8112 * @see #FLAG_GRANT_READ_URI_PERMISSION
8113 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07008114 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
8115 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008116 * @see #FLAG_DEBUG_LOG_RESOLUTION
8117 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008118 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008119 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008120 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008121 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008122 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
8123 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008124 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008125 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07008126 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008127 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008128 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008129 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08008130 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008131 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
8132 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008133 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008134 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08008135 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008136 * @see #FLAG_RECEIVER_REGISTERED_ONLY
8137 */
8138 public Intent setFlags(int flags) {
8139 mFlags = flags;
8140 return this;
8141 }
8142
8143 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008144 * Add additional flags to the intent (or with existing flags value).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008145 *
8146 * @param flags The new flags to set.
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008147 * @return Returns the same Intent object, for chaining multiple calls into
8148 * a single statement.
8149 * @see #setFlags(int)
8150 * @see #removeFlags(int)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008151 */
8152 public Intent addFlags(int flags) {
8153 mFlags |= flags;
8154 return this;
8155 }
8156
8157 /**
Jeff Sharkey6a34e562016-12-21 09:56:00 -07008158 * Remove these flags from the intent.
8159 *
8160 * @param flags The flags to remove.
8161 * @see #setFlags(int)
8162 * @see #addFlags(int)
8163 */
8164 public void removeFlags(int flags) {
8165 mFlags &= ~flags;
8166 }
8167
8168 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008169 * (Usually optional) Set an explicit application package name that limits
8170 * the components this Intent will resolve to. If left to the default
8171 * value of null, all components in all applications will considered.
8172 * If non-null, the Intent can only match the components in the given
8173 * application package.
8174 *
8175 * @param packageName The name of the application package to handle the
8176 * intent, or null to allow any application package.
8177 *
8178 * @return Returns the same Intent object, for chaining multiple calls
8179 * into a single statement.
8180 *
8181 * @see #getPackage
8182 * @see #resolveActivity
8183 */
8184 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008185 if (packageName != null && mSelector != null) {
8186 throw new IllegalArgumentException(
8187 "Can't set package name when selector is already set");
8188 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008189 mPackage = packageName;
8190 return this;
8191 }
8192
8193 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008194 * (Usually optional) Explicitly set the component to handle the intent.
8195 * If left with the default value of null, the system will determine the
8196 * appropriate class to use based on the other fields (action, data,
8197 * type, categories) in the Intent. If this class is defined, the
8198 * specified class will always be used regardless of the other fields. You
8199 * should only set this value when you know you absolutely want a specific
8200 * class to be used; otherwise it is better to let the system find the
8201 * appropriate class so that you will respect the installed applications
8202 * and user preferences.
8203 *
8204 * @param component The name of the application component to handle the
8205 * intent, or null to let the system find one for you.
8206 *
8207 * @return Returns the same Intent object, for chaining multiple calls
8208 * into a single statement.
8209 *
8210 * @see #setClass
8211 * @see #setClassName(Context, String)
8212 * @see #setClassName(String, String)
8213 * @see #getComponent
8214 * @see #resolveActivity
8215 */
8216 public Intent setComponent(ComponentName component) {
8217 mComponent = component;
8218 return this;
8219 }
8220
8221 /**
8222 * Convenience for calling {@link #setComponent} with an
8223 * explicit class name.
8224 *
8225 * @param packageContext A Context of the application package implementing
8226 * this class.
8227 * @param className The name of a class inside of the application package
8228 * that will be used as the component for this Intent.
8229 *
8230 * @return Returns the same Intent object, for chaining multiple calls
8231 * into a single statement.
8232 *
8233 * @see #setComponent
8234 * @see #setClass
8235 */
8236 public Intent setClassName(Context packageContext, String className) {
8237 mComponent = new ComponentName(packageContext, className);
8238 return this;
8239 }
8240
8241 /**
8242 * Convenience for calling {@link #setComponent} with an
8243 * explicit application package name and class name.
8244 *
8245 * @param packageName The name of the package implementing the desired
8246 * component.
8247 * @param className The name of a class inside of the application package
8248 * that will be used as the component for this Intent.
8249 *
8250 * @return Returns the same Intent object, for chaining multiple calls
8251 * into a single statement.
8252 *
8253 * @see #setComponent
8254 * @see #setClass
8255 */
8256 public Intent setClassName(String packageName, String className) {
8257 mComponent = new ComponentName(packageName, className);
8258 return this;
8259 }
8260
8261 /**
8262 * Convenience for calling {@link #setComponent(ComponentName)} with the
8263 * name returned by a {@link Class} object.
8264 *
8265 * @param packageContext A Context of the application package implementing
8266 * this class.
8267 * @param cls The class name to set, equivalent to
8268 * <code>setClassName(context, cls.getName())</code>.
8269 *
8270 * @return Returns the same Intent object, for chaining multiple calls
8271 * into a single statement.
8272 *
8273 * @see #setComponent
8274 */
8275 public Intent setClass(Context packageContext, Class<?> cls) {
8276 mComponent = new ComponentName(packageContext, cls);
8277 return this;
8278 }
8279
8280 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008281 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8282 * used as a hint to the receiver for animations and the like. Null means that there
8283 * is no source bounds.
8284 */
8285 public void setSourceBounds(Rect r) {
8286 if (r != null) {
8287 mSourceBounds = new Rect(r);
8288 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008289 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008290 }
8291 }
8292
Tor Norbyed9273d62013-05-30 15:59:53 -07008293 /** @hide */
8294 @IntDef(flag = true,
8295 value = {
8296 FILL_IN_ACTION,
8297 FILL_IN_DATA,
8298 FILL_IN_CATEGORIES,
8299 FILL_IN_COMPONENT,
8300 FILL_IN_PACKAGE,
8301 FILL_IN_SOURCE_BOUNDS,
8302 FILL_IN_SELECTOR,
8303 FILL_IN_CLIP_DATA
8304 })
8305 @Retention(RetentionPolicy.SOURCE)
8306 public @interface FillInFlags {}
8307
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008308 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008309 * Use with {@link #fillIn} to allow the current action value to be
8310 * overwritten, even if it is already set.
8311 */
8312 public static final int FILL_IN_ACTION = 1<<0;
8313
8314 /**
8315 * Use with {@link #fillIn} to allow the current data or type value
8316 * overwritten, even if it is already set.
8317 */
8318 public static final int FILL_IN_DATA = 1<<1;
8319
8320 /**
8321 * Use with {@link #fillIn} to allow the current categories to be
8322 * overwritten, even if they are already set.
8323 */
8324 public static final int FILL_IN_CATEGORIES = 1<<2;
8325
8326 /**
8327 * Use with {@link #fillIn} to allow the current component value to be
8328 * overwritten, even if it is already set.
8329 */
8330 public static final int FILL_IN_COMPONENT = 1<<3;
8331
8332 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008333 * Use with {@link #fillIn} to allow the current package value to be
8334 * overwritten, even if it is already set.
8335 */
8336 public static final int FILL_IN_PACKAGE = 1<<4;
8337
8338 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008339 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008340 * overwritten, even if it is already set.
8341 */
8342 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8343
8344 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008345 * Use with {@link #fillIn} to allow the current selector to be
8346 * overwritten, even if it is already set.
8347 */
8348 public static final int FILL_IN_SELECTOR = 1<<6;
8349
8350 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008351 * Use with {@link #fillIn} to allow the current ClipData to be
8352 * overwritten, even if it is already set.
8353 */
8354 public static final int FILL_IN_CLIP_DATA = 1<<7;
8355
8356 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008357 * Copy the contents of <var>other</var> in to this object, but only
8358 * where fields are not defined by this object. For purposes of a field
8359 * being defined, the following pieces of data in the Intent are
8360 * considered to be separate fields:
8361 *
8362 * <ul>
8363 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008364 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008365 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8366 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008367 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008368 * <li> component, as set by {@link #setComponent(ComponentName)} or
8369 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008370 * <li> source bounds, as set by {@link #setSourceBounds}.
8371 * <li> selector, as set by {@link #setSelector(Intent)}.
8372 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008373 * <li> each top-level name in the associated extras.
8374 * </ul>
8375 *
8376 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008377 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008378 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8379 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8380 * the restriction where the corresponding field will not be replaced if
8381 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008382 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008383 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8384 * is explicitly specified. The selector will only be copied if
8385 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008386 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008387 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8388 * and Intent B with {action="gotit", data-type="some/thing",
8389 * categories="one","two"}.
8390 *
8391 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8392 * containing: {action="gotit", data-type="some/thing",
8393 * categories="bar"}.
8394 *
8395 * @param other Another Intent whose values are to be used to fill in
8396 * the current one.
8397 * @param flags Options to control which fields can be filled in.
8398 *
8399 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008400 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008401 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
Elliot Waite54de7742017-01-11 15:30:35 -08008402 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA} indicating which fields were
Tor Norbyed9273d62013-05-30 15:59:53 -07008403 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008404 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008405 @FillInFlags
8406 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008407 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008408 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008409 if (other.mAction != null
8410 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008411 mAction = other.mAction;
8412 changes |= FILL_IN_ACTION;
8413 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008414 if ((other.mData != null || other.mType != null)
8415 && ((mData == null && mType == null)
8416 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008417 mData = other.mData;
8418 mType = other.mType;
8419 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008420 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008421 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008422 if (other.mCategories != null
8423 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008424 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008425 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008426 }
8427 changes |= FILL_IN_CATEGORIES;
8428 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008429 if (other.mPackage != null
8430 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008431 // Only do this if mSelector is not set.
8432 if (mSelector == null) {
8433 mPackage = other.mPackage;
8434 changes |= FILL_IN_PACKAGE;
8435 }
8436 }
8437 // Selector is special: it can only be set if explicitly allowed,
8438 // for the same reason as the component name.
8439 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8440 if (mPackage == null) {
8441 mSelector = new Intent(other.mSelector);
8442 mPackage = null;
8443 changes |= FILL_IN_SELECTOR;
8444 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008445 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008446 if (other.mClipData != null
8447 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8448 mClipData = other.mClipData;
8449 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008450 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008451 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008452 // Component is special: it can -only- be set if explicitly allowed,
8453 // since otherwise the sender could force the intent somewhere the
8454 // originator didn't intend.
8455 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008456 mComponent = other.mComponent;
8457 changes |= FILL_IN_COMPONENT;
8458 }
8459 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008460 if (other.mSourceBounds != null
8461 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8462 mSourceBounds = new Rect(other.mSourceBounds);
8463 changes |= FILL_IN_SOURCE_BOUNDS;
8464 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008465 if (mExtras == null) {
8466 if (other.mExtras != null) {
8467 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008468 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008469 }
8470 } else if (other.mExtras != null) {
8471 try {
8472 Bundle newb = new Bundle(other.mExtras);
8473 newb.putAll(mExtras);
8474 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008475 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008476 } catch (RuntimeException e) {
8477 // Modifying the extras can cause us to unparcel the contents
8478 // of the bundle, and if we do this in the system process that
8479 // may fail. We really should handle this (i.e., the Bundle
8480 // impl shouldn't be on top of a plain map), but for now just
8481 // ignore it and keep the original contents. :(
8482 Log.w("Intent", "Failure filling in extras", e);
8483 }
8484 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008485 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8486 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8487 mContentUserHint = other.mContentUserHint;
8488 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008489 return changes;
8490 }
8491
8492 /**
8493 * Wrapper class holding an Intent and implementing comparisons on it for
8494 * the purpose of filtering. The class implements its
8495 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8496 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8497 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8498 * on the wrapped Intent.
8499 */
8500 public static final class FilterComparison {
8501 private final Intent mIntent;
8502 private final int mHashCode;
8503
8504 public FilterComparison(Intent intent) {
8505 mIntent = intent;
8506 mHashCode = intent.filterHashCode();
8507 }
8508
8509 /**
8510 * Return the Intent that this FilterComparison represents.
8511 * @return Returns the Intent held by the FilterComparison. Do
8512 * not modify!
8513 */
8514 public Intent getIntent() {
8515 return mIntent;
8516 }
8517
8518 @Override
8519 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008520 if (obj instanceof FilterComparison) {
8521 Intent other = ((FilterComparison)obj).mIntent;
8522 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008523 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008524 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008525 }
8526
8527 @Override
8528 public int hashCode() {
8529 return mHashCode;
8530 }
8531 }
8532
8533 /**
8534 * Determine if two intents are the same for the purposes of intent
8535 * resolution (filtering). That is, if their action, data, type,
8536 * class, and categories are the same. This does <em>not</em> compare
8537 * any extra data included in the intents.
8538 *
8539 * @param other The other Intent to compare against.
8540 *
8541 * @return Returns true if action, data, type, class, and categories
8542 * are the same.
8543 */
8544 public boolean filterEquals(Intent other) {
8545 if (other == null) {
8546 return false;
8547 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008548 if (!Objects.equals(this.mAction, other.mAction)) return false;
8549 if (!Objects.equals(this.mData, other.mData)) return false;
8550 if (!Objects.equals(this.mType, other.mType)) return false;
8551 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8552 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8553 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008554
8555 return true;
8556 }
8557
8558 /**
8559 * Generate hash code that matches semantics of filterEquals().
8560 *
8561 * @return Returns the hash value of the action, data, type, class, and
8562 * categories.
8563 *
8564 * @see #filterEquals
8565 */
8566 public int filterHashCode() {
8567 int code = 0;
8568 if (mAction != null) {
8569 code += mAction.hashCode();
8570 }
8571 if (mData != null) {
8572 code += mData.hashCode();
8573 }
8574 if (mType != null) {
8575 code += mType.hashCode();
8576 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008577 if (mPackage != null) {
8578 code += mPackage.hashCode();
8579 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008580 if (mComponent != null) {
8581 code += mComponent.hashCode();
8582 }
8583 if (mCategories != null) {
8584 code += mCategories.hashCode();
8585 }
8586 return code;
8587 }
8588
8589 @Override
8590 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008591 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008592
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008593 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008594 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008595 b.append(" }");
8596
8597 return b.toString();
8598 }
8599
8600 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008601 public String toInsecureString() {
8602 StringBuilder b = new StringBuilder(128);
8603
8604 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008605 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008606 b.append(" }");
8607
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008608 return b.toString();
8609 }
Romain Guy4969af72009-06-17 10:53:19 -07008610
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008611 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008612 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008613 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008614
8615 b.append("Intent { ");
8616 toShortString(b, false, true, true, true);
8617 b.append(" }");
8618
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008619 return b.toString();
8620 }
8621
8622 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008623 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8624 StringBuilder b = new StringBuilder(128);
8625 toShortString(b, secure, comp, extras, clip);
8626 return b.toString();
8627 }
8628
8629 /** @hide */
8630 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8631 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008632 boolean first = true;
8633 if (mAction != null) {
8634 b.append("act=").append(mAction);
8635 first = false;
8636 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008637 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008638 if (!first) {
8639 b.append(' ');
8640 }
8641 first = false;
8642 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008643 for (int i=0; i<mCategories.size(); i++) {
8644 if (i > 0) b.append(',');
8645 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008646 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008647 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008648 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008649 if (mData != null) {
8650 if (!first) {
8651 b.append(' ');
8652 }
8653 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008654 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008655 if (secure) {
8656 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008657 } else {
8658 b.append(mData);
8659 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008660 }
8661 if (mType != null) {
8662 if (!first) {
8663 b.append(' ');
8664 }
8665 first = false;
8666 b.append("typ=").append(mType);
8667 }
8668 if (mFlags != 0) {
8669 if (!first) {
8670 b.append(' ');
8671 }
8672 first = false;
8673 b.append("flg=0x").append(Integer.toHexString(mFlags));
8674 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008675 if (mPackage != null) {
8676 if (!first) {
8677 b.append(' ');
8678 }
8679 first = false;
8680 b.append("pkg=").append(mPackage);
8681 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008682 if (comp && mComponent != null) {
8683 if (!first) {
8684 b.append(' ');
8685 }
8686 first = false;
8687 b.append("cmp=").append(mComponent.flattenToShortString());
8688 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008689 if (mSourceBounds != null) {
8690 if (!first) {
8691 b.append(' ');
8692 }
8693 first = false;
8694 b.append("bnds=").append(mSourceBounds.toShortString());
8695 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008696 if (mClipData != null) {
8697 if (!first) {
8698 b.append(' ');
8699 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008700 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008701 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008702 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008703 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008704 if (mClipData.getDescription() != null) {
8705 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8706 } else {
8707 first = true;
8708 }
8709 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008710 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008711 first = false;
8712 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008713 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008714 if (extras && mExtras != null) {
8715 if (!first) {
8716 b.append(' ');
8717 }
8718 first = false;
8719 b.append("(has extras)");
8720 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008721 if (mContentUserHint != UserHandle.USER_CURRENT) {
8722 if (!first) {
8723 b.append(' ');
8724 }
8725 first = false;
8726 b.append("u=").append(mContentUserHint);
8727 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008728 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008729 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008730 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008731 b.append("}");
8732 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008733 }
8734
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008735 /**
8736 * Call {@link #toUri} with 0 flags.
8737 * @deprecated Use {@link #toUri} instead.
8738 */
8739 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008740 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008741 return toUri(0);
8742 }
8743
8744 /**
8745 * Convert this Intent into a String holding a URI representation of it.
8746 * The returned URI string has been properly URI encoded, so it can be
8747 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8748 * Intent's data as the base URI, with an additional fragment describing
8749 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008750 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008751 * <p>You can convert the returned string back to an Intent with
8752 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008753 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008754 * @param flags Additional operating flags. Either 0,
8755 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008756 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008757 * @return Returns a URI encoding URI string describing the entire contents
8758 * of the Intent.
8759 */
8760 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008761 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008762 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8763 if (mPackage == null) {
8764 throw new IllegalArgumentException(
8765 "Intent must include an explicit package name to build an android-app: "
8766 + this);
8767 }
8768 uri.append("android-app://");
8769 uri.append(mPackage);
8770 String scheme = null;
8771 if (mData != null) {
8772 scheme = mData.getScheme();
8773 if (scheme != null) {
8774 uri.append('/');
8775 uri.append(scheme);
8776 String authority = mData.getEncodedAuthority();
8777 if (authority != null) {
8778 uri.append('/');
8779 uri.append(authority);
8780 String path = mData.getEncodedPath();
8781 if (path != null) {
8782 uri.append(path);
8783 }
8784 String queryParams = mData.getEncodedQuery();
8785 if (queryParams != null) {
8786 uri.append('?');
8787 uri.append(queryParams);
8788 }
8789 String fragment = mData.getEncodedFragment();
8790 if (fragment != null) {
8791 uri.append('#');
8792 uri.append(fragment);
8793 }
8794 }
8795 }
8796 }
8797 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8798 mPackage, flags);
8799 return uri.toString();
8800 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008801 String scheme = null;
8802 if (mData != null) {
8803 String data = mData.toString();
8804 if ((flags&URI_INTENT_SCHEME) != 0) {
8805 final int N = data.length();
8806 for (int i=0; i<N; i++) {
8807 char c = data.charAt(i);
8808 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8809 || c == '.' || c == '-') {
8810 continue;
8811 }
8812 if (c == ':' && i > 0) {
8813 // Valid scheme.
8814 scheme = data.substring(0, i);
8815 uri.append("intent:");
8816 data = data.substring(i+1);
8817 break;
8818 }
Tom Taylord4a47292009-12-21 13:59:18 -08008819
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008820 // No scheme.
8821 break;
8822 }
8823 }
8824 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008825
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008826 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8827 uri.append("intent:");
8828 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008829
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008830 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008831
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008832 return uri.toString();
8833 }
8834
8835 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8836 String defPackage, int flags) {
8837 StringBuilder frag = new StringBuilder(128);
8838
8839 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008840 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008841 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008842 // Note that for now we are not going to try to handle the
8843 // data part; not clear how to represent this as a URI, and
8844 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008845 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8846 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008847 }
8848
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008849 if (frag.length() > 0) {
8850 uri.append("#Intent;");
8851 uri.append(frag);
8852 uri.append("end");
8853 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008854 }
8855
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008856 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8857 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008858 if (scheme != null) {
8859 uri.append("scheme=").append(scheme).append(';');
8860 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008861 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008862 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008863 }
8864 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008865 for (int i=0; i<mCategories.size(); i++) {
8866 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008867 }
8868 }
8869 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008870 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008871 }
8872 if (mFlags != 0) {
8873 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8874 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008875 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008876 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8877 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008878 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008879 uri.append("component=").append(Uri.encode(
8880 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008881 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008882 if (mSourceBounds != null) {
8883 uri.append("sourceBounds=")
8884 .append(Uri.encode(mSourceBounds.flattenToString()))
8885 .append(';');
8886 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008887 if (mExtras != null) {
8888 for (String key : mExtras.keySet()) {
8889 final Object value = mExtras.get(key);
8890 char entryType =
8891 value instanceof String ? 'S' :
8892 value instanceof Boolean ? 'B' :
8893 value instanceof Byte ? 'b' :
8894 value instanceof Character ? 'c' :
8895 value instanceof Double ? 'd' :
8896 value instanceof Float ? 'f' :
8897 value instanceof Integer ? 'i' :
8898 value instanceof Long ? 'l' :
8899 value instanceof Short ? 's' :
8900 '\0';
8901
8902 if (entryType != '\0') {
8903 uri.append(entryType);
8904 uri.append('.');
8905 uri.append(Uri.encode(key));
8906 uri.append('=');
8907 uri.append(Uri.encode(value.toString()));
8908 uri.append(';');
8909 }
8910 }
8911 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008912 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008913
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008914 public int describeContents() {
8915 return (mExtras != null) ? mExtras.describeContents() : 0;
8916 }
8917
8918 public void writeToParcel(Parcel out, int flags) {
8919 out.writeString(mAction);
8920 Uri.writeToParcel(out, mData);
8921 out.writeString(mType);
8922 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008923 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008924 ComponentName.writeToParcel(mComponent, out);
8925
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008926 if (mSourceBounds != null) {
8927 out.writeInt(1);
8928 mSourceBounds.writeToParcel(out, flags);
8929 } else {
8930 out.writeInt(0);
8931 }
8932
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008933 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008934 final int N = mCategories.size();
8935 out.writeInt(N);
8936 for (int i=0; i<N; i++) {
8937 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008938 }
8939 } else {
8940 out.writeInt(0);
8941 }
8942
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008943 if (mSelector != null) {
8944 out.writeInt(1);
8945 mSelector.writeToParcel(out, flags);
8946 } else {
8947 out.writeInt(0);
8948 }
8949
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008950 if (mClipData != null) {
8951 out.writeInt(1);
8952 mClipData.writeToParcel(out, flags);
8953 } else {
8954 out.writeInt(0);
8955 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008956 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008957 out.writeBundle(mExtras);
8958 }
8959
8960 public static final Parcelable.Creator<Intent> CREATOR
8961 = new Parcelable.Creator<Intent>() {
8962 public Intent createFromParcel(Parcel in) {
8963 return new Intent(in);
8964 }
8965 public Intent[] newArray(int size) {
8966 return new Intent[size];
8967 }
8968 };
8969
Dianne Hackborneb034652009-09-07 00:49:58 -07008970 /** @hide */
8971 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008972 readFromParcel(in);
8973 }
8974
8975 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008976 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008977 mData = Uri.CREATOR.createFromParcel(in);
8978 mType = in.readString();
8979 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008980 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008981 mComponent = ComponentName.readFromParcel(in);
8982
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008983 if (in.readInt() != 0) {
8984 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8985 }
8986
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008987 int N = in.readInt();
8988 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008989 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008990 int i;
8991 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008992 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008993 }
8994 } else {
8995 mCategories = null;
8996 }
8997
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008998 if (in.readInt() != 0) {
8999 mSelector = new Intent(in);
9000 }
9001
Dianne Hackborn21c241e2012-03-08 13:57:23 -08009002 if (in.readInt() != 0) {
9003 mClipData = new ClipData(in);
9004 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009005 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009006 mExtras = in.readBundle();
9007 }
9008
9009 /**
9010 * Parses the "intent" element (and its children) from XML and instantiates
9011 * an Intent object. The given XML parser should be located at the tag
9012 * where parsing should start (often named "intent"), from which the
9013 * basic action, data, type, and package and class name will be
9014 * retrieved. The function will then parse in to any child elements,
9015 * looking for <category android:name="xxx"> tags to add categories and
9016 * <extra android:name="xxx" android:value="yyy"> to attach extra data
9017 * to the intent.
9018 *
9019 * @param resources The Resources to use when inflating resources.
9020 * @param parser The XML parser pointing at an "intent" tag.
9021 * @param attrs The AttributeSet interface for retrieving extended
9022 * attribute data at the current <var>parser</var> location.
9023 * @return An Intent object matching the XML data.
9024 * @throws XmlPullParserException If there was an XML parsing error.
9025 * @throws IOException If there was an I/O error.
9026 */
9027 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
9028 throws XmlPullParserException, IOException {
9029 Intent intent = new Intent();
9030
9031 TypedArray sa = resources.obtainAttributes(attrs,
9032 com.android.internal.R.styleable.Intent);
9033
9034 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
9035
9036 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
9037 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
9038 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
9039
9040 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
9041 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
9042 if (packageName != null && className != null) {
9043 intent.setComponent(new ComponentName(packageName, className));
9044 }
9045
9046 sa.recycle();
9047
9048 int outerDepth = parser.getDepth();
9049 int type;
9050 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
9051 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
9052 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
9053 continue;
9054 }
9055
9056 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07009057 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009058 sa = resources.obtainAttributes(attrs,
9059 com.android.internal.R.styleable.IntentCategory);
9060 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
9061 sa.recycle();
9062
9063 if (cat != null) {
9064 intent.addCategory(cat);
9065 }
9066 XmlUtils.skipCurrentTag(parser);
9067
Craig Mautner21d24a22014-04-23 11:45:37 -07009068 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009069 if (intent.mExtras == null) {
9070 intent.mExtras = new Bundle();
9071 }
Craig Mautner21d24a22014-04-23 11:45:37 -07009072 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08009073 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009074
9075 } else {
9076 XmlUtils.skipCurrentTag(parser);
9077 }
9078 }
9079
9080 return intent;
9081 }
Nick Pellyccae4122012-01-09 14:12:58 -08009082
Craig Mautner21d24a22014-04-23 11:45:37 -07009083 /** @hide */
9084 public void saveToXml(XmlSerializer out) throws IOException {
9085 if (mAction != null) {
9086 out.attribute(null, ATTR_ACTION, mAction);
9087 }
9088 if (mData != null) {
9089 out.attribute(null, ATTR_DATA, mData.toString());
9090 }
9091 if (mType != null) {
9092 out.attribute(null, ATTR_TYPE, mType);
9093 }
9094 if (mComponent != null) {
9095 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
9096 }
9097 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
9098
9099 if (mCategories != null) {
9100 out.startTag(null, TAG_CATEGORIES);
9101 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
9102 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
9103 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07009104 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07009105 }
9106 }
9107
9108 /** @hide */
9109 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
9110 XmlPullParserException {
9111 Intent intent = new Intent();
9112 final int outerDepth = in.getDepth();
9113
9114 int attrCount = in.getAttributeCount();
9115 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9116 final String attrName = in.getAttributeName(attrNdx);
9117 final String attrValue = in.getAttributeValue(attrNdx);
9118 if (ATTR_ACTION.equals(attrName)) {
9119 intent.setAction(attrValue);
9120 } else if (ATTR_DATA.equals(attrName)) {
9121 intent.setData(Uri.parse(attrValue));
9122 } else if (ATTR_TYPE.equals(attrName)) {
9123 intent.setType(attrValue);
9124 } else if (ATTR_COMPONENT.equals(attrName)) {
9125 intent.setComponent(ComponentName.unflattenFromString(attrValue));
9126 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01009127 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07009128 } else {
9129 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
9130 }
9131 }
9132
9133 int event;
9134 String name;
9135 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
9136 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
9137 if (event == XmlPullParser.START_TAG) {
9138 name = in.getName();
9139 if (TAG_CATEGORIES.equals(name)) {
9140 attrCount = in.getAttributeCount();
9141 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
9142 intent.addCategory(in.getAttributeValue(attrNdx));
9143 }
9144 } else {
9145 Log.w("Intent", "restoreFromXml: unknown name=" + name);
9146 XmlUtils.skipCurrentTag(in);
9147 }
9148 }
9149 }
9150
9151 return intent;
9152 }
9153
Nick Pellyccae4122012-01-09 14:12:58 -08009154 /**
9155 * Normalize a MIME data type.
9156 *
9157 * <p>A normalized MIME type has white-space trimmed,
9158 * content-type parameters removed, and is lower-case.
9159 * This aligns the type with Android best practices for
9160 * intent filtering.
9161 *
9162 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9163 * "text/x-vCard" becomes "text/x-vcard".
9164 *
9165 * <p>All MIME types received from outside Android (such as user input,
9166 * or external sources like Bluetooth, NFC, or the Internet) should
9167 * be normalized before they are used to create an Intent.
9168 *
9169 * @param type MIME data type to normalize
9170 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009171 * @see #setType
9172 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009173 */
9174 public static String normalizeMimeType(String type) {
9175 if (type == null) {
9176 return null;
9177 }
9178
Elliott Hughescb64d432013-08-02 10:00:44 -07009179 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009180
9181 final int semicolonIndex = type.indexOf(';');
9182 if (semicolonIndex != -1) {
9183 type = type.substring(0, semicolonIndex);
9184 }
9185 return type;
9186 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009187
9188 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009189 * Prepare this {@link Intent} to leave an app process.
9190 *
9191 * @hide
9192 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009193 public void prepareToLeaveProcess(Context context) {
9194 final boolean leavingPackage = (mComponent == null)
9195 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9196 prepareToLeaveProcess(leavingPackage);
9197 }
9198
9199 /**
9200 * Prepare this {@link Intent} to leave an app process.
9201 *
9202 * @hide
9203 */
9204 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009205 setAllowFds(false);
9206
9207 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009208 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009209 }
9210 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009211 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009212 }
9213
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009214 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9215 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009216 switch (mAction) {
9217 case ACTION_MEDIA_REMOVED:
9218 case ACTION_MEDIA_UNMOUNTED:
9219 case ACTION_MEDIA_CHECKING:
9220 case ACTION_MEDIA_NOFS:
9221 case ACTION_MEDIA_MOUNTED:
9222 case ACTION_MEDIA_SHARED:
9223 case ACTION_MEDIA_UNSHARED:
9224 case ACTION_MEDIA_BAD_REMOVAL:
9225 case ACTION_MEDIA_UNMOUNTABLE:
9226 case ACTION_MEDIA_EJECT:
9227 case ACTION_MEDIA_SCANNER_STARTED:
9228 case ACTION_MEDIA_SCANNER_FINISHED:
9229 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009230 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9231 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009232 // Ignore legacy actions
9233 break;
9234 default:
9235 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009236 }
9237 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009238
9239 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9240 && leavingPackage) {
9241 switch (mAction) {
9242 case ACTION_PROVIDER_CHANGED:
9243 // Ignore actions that don't need to grant
9244 break;
9245 default:
9246 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9247 }
9248 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009249 }
9250
9251 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009252 * @hide
9253 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009254 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009255 // We just entered destination process, so we should be able to read all
9256 // parcelables inside.
9257 setDefusable(true);
9258
9259 if (mSelector != null) {
9260 mSelector.prepareToEnterProcess();
9261 }
9262 if (mClipData != null) {
9263 mClipData.prepareToEnterProcess();
9264 }
9265
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009266 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009267 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9268 fixUris(mContentUserHint);
9269 mContentUserHint = UserHandle.USER_CURRENT;
9270 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009271 }
9272 }
9273
9274 /**
9275 * @hide
9276 */
9277 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009278 Uri data = getData();
9279 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009280 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009281 }
9282 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009283 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009284 }
9285 String action = getAction();
9286 if (ACTION_SEND.equals(action)) {
9287 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9288 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009289 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009290 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009291 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009292 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9293 if (streams != null) {
9294 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9295 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009296 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009297 }
9298 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9299 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009300 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9301 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9302 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9303 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9304 if (output != null) {
9305 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9306 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009307 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009308 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009309
9310 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009311 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009312 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9313 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009314 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009315 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009316 * @hide
9317 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009318 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009319 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009320 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009321
9322 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009323 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009324
9325 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009326 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009327 // Inspect contained intents to see if we need to migrate extras. We
9328 // don't promote ClipData to the parent, since ChooserActivity will
9329 // already start the picked item as the caller, and we can't combine
9330 // the flags in a safe way.
9331
9332 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009333 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009334 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9335 if (intent != null) {
9336 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009337 }
9338 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009339 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009340 try {
9341 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9342 if (intents != null) {
9343 for (int i = 0; i < intents.length; i++) {
9344 final Intent intent = (Intent) intents[i];
9345 if (intent != null) {
9346 migrated |= intent.migrateExtraStreamToClipData();
9347 }
9348 }
9349 }
9350 } catch (ClassCastException e) {
9351 }
9352 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009353
9354 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009355 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009356 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9357 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9358 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9359 if (stream != null || text != null || htmlText != null) {
9360 final ClipData clipData = new ClipData(
9361 null, new String[] { getType() },
9362 new ClipData.Item(text, htmlText, null, stream));
9363 setClipData(clipData);
9364 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009365 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009366 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009367 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009368 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009369
9370 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009371 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009372 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9373 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9374 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9375 int num = -1;
9376 if (streams != null) {
9377 num = streams.size();
9378 }
9379 if (texts != null) {
9380 if (num >= 0 && num != texts.size()) {
9381 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009382 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009383 }
9384 num = texts.size();
9385 }
9386 if (htmlTexts != null) {
9387 if (num >= 0 && num != htmlTexts.size()) {
9388 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009389 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009390 }
9391 num = htmlTexts.size();
9392 }
9393 if (num > 0) {
9394 final ClipData clipData = new ClipData(
9395 null, new String[] { getType() },
9396 makeClipItem(streams, texts, htmlTexts, 0));
9397
9398 for (int i = 1; i < num; i++) {
9399 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9400 }
9401
9402 setClipData(clipData);
9403 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009404 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009405 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009406 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009407 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009408 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9409 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9410 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9411 final Uri output;
9412 try {
9413 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9414 } catch (ClassCastException e) {
9415 return false;
9416 }
9417 if (output != null) {
9418 setClipData(ClipData.newRawUri("", output));
9419 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9420 return true;
9421 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009422 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009423
9424 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009425 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009426
9427 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9428 ArrayList<String> htmlTexts, int which) {
9429 Uri uri = streams != null ? streams.get(which) : null;
9430 CharSequence text = texts != null ? texts.get(which) : null;
9431 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9432 return new ClipData.Item(text, htmlText, null, uri);
9433 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009434
9435 /** @hide */
9436 public boolean isDocument() {
9437 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9438 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009439}