blob: 16af5e1c45a2f33cf4172a34e7d84dbcd79e51cb [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700118 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700189 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700342 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700361 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * </ul>
573 *
574 * <h3>Standard Extra Data</h3>
575 *
576 * <p>These are the current standard fields that can be used as extra data via
577 * {@link #putExtra}.
578 *
579 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_ALARM_COUNT}
581 * <li> {@link #EXTRA_BCC}
582 * <li> {@link #EXTRA_CC}
583 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
584 * <li> {@link #EXTRA_DATA_REMOVED}
585 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500586 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_DOCK_STATE_CAR}
589 * <li> {@link #EXTRA_DOCK_STATE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
591 * <li> {@link #EXTRA_DONT_KILL_APP}
592 * <li> {@link #EXTRA_EMAIL}
593 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700596 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700598 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
600 * <li> {@link #EXTRA_REPLACING}
601 * <li> {@link #EXTRA_SHORTCUT_ICON}
602 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
603 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_SHORTCUT_NAME}
606 * <li> {@link #EXTRA_SUBJECT}
607 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_TITLE}
610 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * </ul>
612 *
613 * <h3>Flags</h3>
614 *
615 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
617 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800619public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700620 private static final String ATTR_ACTION = "action";
621 private static final String TAG_CATEGORIES = "categories";
622 private static final String ATTR_CATEGORY = "category";
623 private static final String TAG_EXTRA = "extra";
624 private static final String ATTR_TYPE = "type";
625 private static final String ATTR_COMPONENT = "component";
626 private static final String ATTR_DATA = "data";
627 private static final String ATTR_FLAGS = "flags";
628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 // ---------------------------------------------------------------------
630 // ---------------------------------------------------------------------
631 // Standard intent activity actions (see action variable).
632
633 /**
634 * Activity Action: Start as a main entry point, does not expect to
635 * receive data.
636 * <p>Input: nothing
637 * <p>Output: nothing
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Display the data to the user. This is the most common
644 * action performed on data -- it is the generic action you can use on
645 * a piece of data to get the most reasonable thing to occur. For example,
646 * when used on a contacts entry it will view the entry; when used on a
647 * mailto: URI it will bring up a compose window filled with the information
648 * supplied by the URI; when used with a tel: URI it will invoke the
649 * dialer.
650 * <p>Input: {@link #getData} is URI from which to retrieve data.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
658 * performed on a piece of data.
659 */
660 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900663 * Activity Action: Quick view the data. Launches a quick viewer for
664 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900665 * <p>Activities handling this intent action should handle the vast majority of
666 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * <p>Input: {@link #getData} is a mandatory content URI of the item to
668 * preview. {@link #getClipData} contains an optional list of content URIs
669 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
670 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700671 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
675
676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * Used to indicate that some piece of data should be attached to some other
678 * place. For example, image data could be attached to a contact. It is up
679 * to the recipient to decide where the data should be attached; the intent
680 * does not specify the ultimate destination.
681 * <p>Input: {@link #getData} is URI of data to be attached.
682 * <p>Output: nothing.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Provide explicit editable access to the given data.
689 * <p>Input: {@link #getData} is URI of data to be edited.
690 * <p>Output: nothing.
691 */
692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
693 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700695 /**
696 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
697 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
698 * The extras can contain type specific data to pass through to the editing/creating
699 * activity.
700 * <p>Output: The URI of the item that was picked. This must be a content:
701 * URI so that any receiver can access it.
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800705
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700706 /**
707 * Activity Action: Pick an item from the data, returning what was selected.
708 * <p>Input: {@link #getData} is URI containing a directory of data
709 * (vnd.android.cursor.dir/*) from which to pick an item.
710 * <p>Output: The URI of the item that was picked.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 * <p>Output: An Intent representing the shortcut. The intent must contain three
719 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
720 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * (value: ShortcutIconResource).</p>
722 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 * @see #EXTRA_SHORTCUT_INTENT
724 * @see #EXTRA_SHORTCUT_NAME
725 * @see #EXTRA_SHORTCUT_ICON
726 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
727 * @see android.content.Intent.ShortcutIconResource
728 */
729 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
730 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
731
732 /**
733 * The name of the extra used to define the Intent of a shortcut.
734 *
735 * @see #ACTION_CREATE_SHORTCUT
736 */
737 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
738 /**
739 * The name of the extra used to define the name of a shortcut.
740 *
741 * @see #ACTION_CREATE_SHORTCUT
742 */
743 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
744 /**
745 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
746 *
747 * @see #ACTION_CREATE_SHORTCUT
748 */
749 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
750 /**
751 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
752 *
753 * @see #ACTION_CREATE_SHORTCUT
754 * @see android.content.Intent.ShortcutIconResource
755 */
756 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
757 "android.intent.extra.shortcut.ICON_RESOURCE";
758
759 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500760 * An activity that provides a user interface for adjusting application preferences.
761 * Optional but recommended settings for all applications which have settings.
762 */
763 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
764 public static final String ACTION_APPLICATION_PREFERENCES
765 = "android.intent.action.APPLICATION_PREFERENCES";
766
767 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700768 * Activity Action: Launch an activity showing the app information.
769 * For applications which install other applications (such as app stores), it is recommended
770 * to handle this action for providing the app information to the user.
771 *
772 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
773 * to be displayed.
774 * <p>Output: Nothing.
775 */
776 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
777 public static final String ACTION_SHOW_APP_INFO
778 = "android.intent.action.SHOW_APP_INFO";
779
780 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800781 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 *
783 * @see Intent#ACTION_CREATE_SHORTCUT
784 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800785 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
786 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 */
788 public static class ShortcutIconResource implements Parcelable {
789 /**
790 * The package name of the application containing the icon.
791 */
792 public String packageName;
793
794 /**
795 * The resource name of the icon, including package, name and type.
796 */
797 public String resourceName;
798
799 /**
800 * Creates a new ShortcutIconResource for the specified context and resource
801 * identifier.
802 *
803 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700804 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700805 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700806 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700807 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700808 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700809 ShortcutIconResource icon = new ShortcutIconResource();
810 icon.packageName = context.getPackageName();
811 icon.resourceName = context.getResources().getResourceName(resourceId);
812 return icon;
813 }
814
815 /**
816 * Used to read a ShortcutIconResource from a Parcel.
817 */
818 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
819 new Parcelable.Creator<ShortcutIconResource>() {
820
821 public ShortcutIconResource createFromParcel(Parcel source) {
822 ShortcutIconResource icon = new ShortcutIconResource();
823 icon.packageName = source.readString();
824 icon.resourceName = source.readString();
825 return icon;
826 }
827
828 public ShortcutIconResource[] newArray(int size) {
829 return new ShortcutIconResource[size];
830 }
831 };
832
833 /**
834 * No special parcel contents.
835 */
836 public int describeContents() {
837 return 0;
838 }
839
840 public void writeToParcel(Parcel dest, int flags) {
841 dest.writeString(packageName);
842 dest.writeString(resourceName);
843 }
844
845 @Override
846 public String toString() {
847 return resourceName;
848 }
849 }
850
851 /**
852 * Activity Action: Display an activity chooser, allowing the user to pick
853 * what they want to before proceeding. This can be used as an alternative
854 * to the standard activity picker that is displayed by the system when
855 * you try to start an activity with multiple possible matches, with these
856 * differences in behavior:
857 * <ul>
858 * <li>You can specify the title that will appear in the activity chooser.
859 * <li>The user does not have the option to make one of the matching
860 * activities a preferred activity, and all possible activities will
861 * always be shown even if one of them is currently marked as the
862 * preferred activity.
863 * </ul>
864 * <p>
865 * This action should be used when the user will naturally expect to
866 * select an activity in order to proceed. An example if when not to use
867 * it is when the user clicks on a "mailto:" link. They would naturally
868 * expect to go directly to their mail app, so startActivity() should be
869 * called directly: it will
870 * either launch the current preferred app, or put up a dialog allowing the
871 * user to pick an app to use and optionally marking that as preferred.
872 * <p>
873 * In contrast, if the user is selecting a menu item to send a picture
874 * they are viewing to someone else, there are many different things they
875 * may want to do at this point: send it through e-mail, upload it to a
876 * web service, etc. In this case the CHOOSER action should be used, to
877 * always present to the user a list of the things they can do, with a
878 * nice title given by the caller such as "Send this photo with:".
879 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700880 * If you need to grant URI permissions through a chooser, you must specify
881 * the permissions to be granted on the ACTION_CHOOSER Intent
882 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
883 * {@link #setClipData} to specify the URIs to be granted as well as
884 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
885 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
886 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 * As a convenience, an Intent of this form can be created with the
888 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700889 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700890 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700891 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
892 * and can optionally have a {@link #EXTRA_TITLE} field containing the
893 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700894 * <p>
895 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700896 */
897 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
898 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
899
900 /**
901 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
902 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700903 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
904 * target intent, also optionally supplying a title. If the target
905 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
906 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
907 * set in the returned chooser intent, with its ClipData set appropriately:
908 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500909 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700910 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * @param target The Intent that the user will be selecting an activity
912 * to perform.
913 * @param title Optional title that will be displayed in the chooser.
914 * @return Return a new Intent object that you can hand to
915 * {@link Context#startActivity(Intent) Context.startActivity()} and
916 * related methods.
917 */
918 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700919 return createChooser(target, title, null);
920 }
921
922 /**
923 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
924 *
925 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
926 * target intent, also optionally supplying a title. If the target
927 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
928 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
929 * set in the returned chooser intent, with its ClipData set appropriately:
930 * either a direct reflection of {@link #getClipData()} if that is non-null,
931 * or a new ClipData built from {@link #getData()}.</p>
932 *
933 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
934 * when the user makes a choice. This can be useful if the calling application wants
935 * to remember the last chosen target and surface it as a more prominent or one-touch
936 * affordance elsewhere in the UI for next time.</p>
937 *
938 * @param target The Intent that the user will be selecting an activity
939 * to perform.
940 * @param title Optional title that will be displayed in the chooser.
941 * @param sender Optional IntentSender to be called when a choice is made.
942 * @return Return a new Intent object that you can hand to
943 * {@link Context#startActivity(Intent) Context.startActivity()} and
944 * related methods.
945 */
946 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 Intent intent = new Intent(ACTION_CHOOSER);
948 intent.putExtra(EXTRA_INTENT, target);
949 if (title != null) {
950 intent.putExtra(EXTRA_TITLE, title);
951 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700952
Adam Powell0b3c1122014-10-09 12:50:14 -0700953 if (sender != null) {
954 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
955 }
956
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700957 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700958 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
959 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
960 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700961 if (permFlags != 0) {
962 ClipData targetClipData = target.getClipData();
963 if (targetClipData == null && target.getData() != null) {
964 ClipData.Item item = new ClipData.Item(target.getData());
965 String[] mimeTypes;
966 if (target.getType() != null) {
967 mimeTypes = new String[] { target.getType() };
968 } else {
969 mimeTypes = new String[] { };
970 }
971 targetClipData = new ClipData(null, mimeTypes, item);
972 }
973 if (targetClipData != null) {
974 intent.setClipData(targetClipData);
975 intent.addFlags(permFlags);
976 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700977 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700979 return intent;
980 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 /**
983 * Activity Action: Allow the user to select a particular kind of data and
984 * return it. This is different than {@link #ACTION_PICK} in that here we
985 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800986 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700987 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900988 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700989 * etc.
990 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900991 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700992 * of data, such as a person contact, you set the MIME type to the kind of
993 * data you want and launch it with {@link Context#startActivity(Intent)}.
994 * The system will then launch the best application to select that kind
995 * of data for you.
996 * <p>
997 * You may also be interested in any of a set of types of content the user
998 * can pick. For example, an e-mail application that wants to allow the
999 * user to add an attachment to an e-mail message can use this action to
1000 * bring up a list of all of the types of content the user can attach.
1001 * <p>
1002 * In this case, you should wrap the GET_CONTENT intent with a chooser
1003 * (through {@link #createChooser}), which will give the proper interface
1004 * for the user to pick how to send your data and allow you to specify
1005 * a prompt indicating what they are doing. You will usually specify a
1006 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1007 * broad range of content types the user can select from.
1008 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001009 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001010 * only pick from data that can be represented as a stream. This is
1011 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1012 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001013 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001014 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001015 * is locally available on the device. For example, if this extra is set
1016 * to true then an image picker should not show any pictures that are available
1017 * from a remote server but not already on the local device (thus requiring
1018 * they be downloaded when opened).
1019 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001020 * If the caller can handle multiple returned items (the user performing
1021 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1022 * to indicate this.
1023 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1025 * that no URI is supplied in the intent, as there are no constraints on
1026 * where the returned data originally comes from. You may also include the
1027 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001028 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001029 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1030 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001031 * <p>
1032 * Output: The URI of the item that was picked. This must be a content:
1033 * URI so that any receiver can access it.
1034 */
1035 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1036 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1037 /**
1038 * Activity Action: Dial a number as specified by the data. This shows a
1039 * UI with the number being dialed, allowing the user to explicitly
1040 * initiate the call.
1041 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1042 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1043 * number.
1044 * <p>Output: nothing.
1045 */
1046 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1047 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1048 /**
1049 * Activity Action: Perform a call to someone specified by the data.
1050 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1051 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1052 * number.
1053 * <p>Output: nothing.
1054 *
1055 * <p>Note: there will be restrictions on which applications can initiate a
1056 * call; most applications should use the {@link #ACTION_DIAL}.
1057 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1058 * numbers. Applications can <strong>dial</strong> emergency numbers using
1059 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001060 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001061 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001062 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001063 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001064 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 */
1066 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1067 public static final String ACTION_CALL = "android.intent.action.CALL";
1068 /**
1069 * Activity Action: Perform a call to an emergency number specified by the
1070 * data.
1071 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1072 * tel: URI of an explicit phone number.
1073 * <p>Output: nothing.
1074 * @hide
1075 */
1076 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1077 /**
1078 * Activity action: Perform a call to any number (emergency or not)
1079 * specified by the data.
1080 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1081 * tel: URI of an explicit phone number.
1082 * <p>Output: nothing.
1083 * @hide
1084 */
1085 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1086 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001087 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1088 * sending this intent is a no-op.
1089 * <p>Input: No data should be specified. get*Extra may have an optional
1090 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1091 * send the activation result.
1092 * <p>Output: nothing.
1093 * @hide
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1097 "android.intent.action.SIM_ACTIVATION_REQUEST";
1098 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001099 * Activity Action: Send a message to someone specified by the data.
1100 * <p>Input: {@link #getData} is URI describing the target.
1101 * <p>Output: nothing.
1102 */
1103 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1104 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1105 /**
1106 * Activity Action: Deliver some data to someone else. Who the data is
1107 * being delivered to is not specified; it is up to the receiver of this
1108 * action to ask the user where the data should be sent.
1109 * <p>
1110 * When launching a SEND intent, you should usually wrap it in a chooser
1111 * (through {@link #createChooser}), which will give the proper interface
1112 * for the user to pick how to send your data and allow you to specify
1113 * a prompt indicating what they are doing.
1114 * <p>
1115 * Input: {@link #getType} is the MIME type of the data being sent.
1116 * get*Extra can have either a {@link #EXTRA_TEXT}
1117 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1118 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1119 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1120 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001121 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1122 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1123 * your text with HTML formatting.
1124 * <p>
1125 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1126 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1127 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1128 * content: URIs and other advanced features of {@link ClipData}. If
1129 * using this approach, you still must supply the same data through the
1130 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1131 * for compatibility with old applications. If you don't set a ClipData,
1132 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001133 * <p>
1134 * Optional standard extras, which may be interpreted by some recipients as
1135 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1136 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1137 * <p>
1138 * Output: nothing.
1139 */
1140 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1141 public static final String ACTION_SEND = "android.intent.action.SEND";
1142 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001143 * Activity Action: Deliver multiple data to someone else.
1144 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001145 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001146 * <p>
1147 * Input: {@link #getType} is the MIME type of the data being sent.
1148 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001149 * #EXTRA_STREAM} field, containing the data to be sent. If using
1150 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1151 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001152 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001153 * Multiple types are supported, and receivers should handle mixed types
1154 * whenever possible. The right way for the receiver to check them is to
1155 * use the content resolver on each URI. The intent sender should try to
1156 * put the most concrete mime type in the intent type, but it can fall
1157 * back to {@literal <type>/*} or {@literal *}/* as needed.
1158 * <p>
1159 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1160 * be image/jpg, but if you are sending image/jpg and image/png, then the
1161 * intent's type should be image/*.
1162 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001163 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1164 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1165 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1166 * content: URIs and other advanced features of {@link ClipData}. If
1167 * using this approach, you still must supply the same data through the
1168 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1169 * for compatibility with old applications. If you don't set a ClipData,
1170 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1171 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001172 * Optional standard extras, which may be interpreted by some recipients as
1173 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1174 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1175 * <p>
1176 * Output: nothing.
1177 */
1178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1179 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1180 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001181 * Activity Action: Handle an incoming phone call.
1182 * <p>Input: nothing.
1183 * <p>Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1187 /**
1188 * Activity Action: Insert an empty item into the given container.
1189 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1190 * in which to place the data.
1191 * <p>Output: URI of the new data that was created.
1192 */
1193 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1194 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1195 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001196 * Activity Action: Create a new item in the given container, initializing it
1197 * from the current contents of the clipboard.
1198 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1199 * in which to place the data.
1200 * <p>Output: URI of the new data that was created.
1201 */
1202 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1203 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1204 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001205 * Activity Action: Delete the given data from its container.
1206 * <p>Input: {@link #getData} is URI of data to be deleted.
1207 * <p>Output: nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1211 /**
1212 * Activity Action: Run the data, whatever that means.
1213 * <p>Input: ? (Note: this is currently specific to the test harness.)
1214 * <p>Output: nothing.
1215 */
1216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1217 public static final String ACTION_RUN = "android.intent.action.RUN";
1218 /**
1219 * Activity Action: Perform a data synchronization.
1220 * <p>Input: ?
1221 * <p>Output: ?
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1225 /**
1226 * Activity Action: Pick an activity given an intent, returning the class
1227 * selected.
1228 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1229 * used with {@link PackageManager#queryIntentActivities} to determine the
1230 * set of activities from which to pick.
1231 * <p>Output: Class name of the activity that was selected.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1235 /**
1236 * Activity Action: Perform a search.
1237 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1238 * is the text to search for. If empty, simply
1239 * enter your search results Activity with the search UI activated.
1240 * <p>Output: nothing.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1244 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001245 * Activity Action: Start the platform-defined tutorial
1246 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1247 * is the text to search for. If empty, simply
1248 * enter your search results Activity with the search UI activated.
1249 * <p>Output: nothing.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001254 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001255 * <p>
1256 * Input: {@link android.app.SearchManager#QUERY
1257 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1258 * a url starts with http or https, the site will be opened. If it is plain
1259 * text, Google search will be applied.
1260 * <p>
1261 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001265
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001266 /**
Jim Miller07994402012-05-02 14:22:27 -07001267 * Activity Action: Perform assist action.
1268 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001269 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1270 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001271 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1272 * information.
Jim Miller07994402012-05-02 14:22:27 -07001273 * Output: nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001277
1278 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001279 * Activity Action: Perform voice assist action.
1280 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001281 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1282 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001283 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001284 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001285 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1289
1290 /**
Adam Skory7140a252013-09-11 12:04:58 +01001291 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1292 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001293 */
1294 public static final String EXTRA_ASSIST_PACKAGE
1295 = "android.intent.extra.ASSIST_PACKAGE";
1296
1297 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001298 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1299 * application package at the time the assist was invoked.
1300 */
1301 public static final String EXTRA_ASSIST_UID
1302 = "android.intent.extra.ASSIST_UID";
1303
1304 /**
Adam Skory7140a252013-09-11 12:04:58 +01001305 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1306 * information supplied by the current foreground app at the time of the assist request.
1307 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001308 */
1309 public static final String EXTRA_ASSIST_CONTEXT
1310 = "android.intent.extra.ASSIST_CONTEXT";
1311
Jim Miller07994402012-05-02 14:22:27 -07001312 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001313 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1314 * keyboard as the primary input device for assistance.
1315 */
1316 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1317 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1318
1319 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001320 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1321 * that was used to invoke the assist.
1322 */
1323 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1324 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1325
1326 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001327 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 * <p>Input: Nothing.
1329 * <p>Output: nothing.
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1333 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001334 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001335 * <p>Input: Nothing.
1336 * <p>Output: Nothing.
1337 */
1338 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1339 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1340
1341 /**
1342 * Activity Action: Show activity for reporting a bug.
1343 * <p>Input: Nothing.
1344 * <p>Output: Nothing.
1345 */
1346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1347 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1348
1349 /**
1350 * Activity Action: Main entry point for factory tests. Only used when
1351 * the device is booting in factory test node. The implementing package
1352 * must be installed in the system image.
1353 * <p>Input: nothing
1354 * <p>Output: nothing
1355 */
1356 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1357
1358 /**
1359 * Activity Action: The user pressed the "call" button to go to the dialer
1360 * or other appropriate UI for placing a call.
1361 * <p>Input: Nothing.
1362 * <p>Output: Nothing.
1363 */
1364 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1365 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1366
1367 /**
1368 * Activity Action: Start Voice Command.
1369 * <p>Input: Nothing.
1370 * <p>Output: Nothing.
1371 */
1372 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1373 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001374
1375 /**
1376 * Activity Action: Start action associated with long pressing on the
1377 * search key.
1378 * <p>Input: Nothing.
1379 * <p>Output: Nothing.
1380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001383
Jacek Surazski86b6c532009-05-13 14:38:28 +02001384 /**
1385 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1386 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001387 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001388 * <p>Input: No data is specified. The bug report is passed in using
1389 * an {@link #EXTRA_BUG_REPORT} field.
1390 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001391 *
1392 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001396
1397 /**
1398 * Activity Action: Show power usage information to the user.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 */
1402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1403 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001404
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001405 /**
1406 * Activity Action: Setup wizard to launch after a platform update. This
1407 * activity should have a string meta-data field associated with it,
1408 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1409 * the platform for setup. The activity will be launched only if
1410 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1411 * same value.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 * @hide
1415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001418
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001419 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001420 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1421 * <p>Input: Nothing.
1422 * <p>Output: Nothing.
1423 * @hide
1424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1427 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1428
1429 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001430 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1431 * <p>Input: Nothing.
1432 * <p>Output: Nothing.
1433 * @hide
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1437 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1438
1439 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001440 * Activity Action: Show settings for managing network data usage of a
1441 * specific application. Applications should define an activity that offers
1442 * options to control data usage.
1443 */
1444 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1445 public static final String ACTION_MANAGE_NETWORK_USAGE =
1446 "android.intent.action.MANAGE_NETWORK_USAGE";
1447
1448 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001449 * Activity Action: Launch application installer.
1450 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001451 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001452 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1453 * you can also use "package:<package-name>" to install an application for the
1454 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001455 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1456 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1457 * <p>
1458 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1459 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001460 * <p>
1461 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1462 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1463 * in order to launch the application installer.
1464 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 *
1466 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1467 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1468 * @see #EXTRA_RETURN_RESULT
1469 */
1470 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1471 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1472
1473 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001474 * Activity Action: Launch ephemeral installer.
1475 * <p>
1476 * Input: The data must be a http: URI that the ephemeral application is registered
1477 * to handle.
1478 * <p class="note">
1479 * This is a protected intent that can only be sent by the system.
1480 * </p>
1481 *
1482 * @hide
1483 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001484 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1485 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1486 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1487
1488 /**
1489 * Service Action: Resolve ephemeral application.
1490 * <p>
1491 * The system will have a persistent connection to this service.
1492 * This is a protected intent that can only be sent by the system.
1493 * </p>
1494 *
1495 * @hide
1496 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001497 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1498 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1499 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1500
1501 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001502 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1503 * package. Specifies the installer package name; this package will receive the
1504 * {@link #ACTION_APP_ERROR} intent.
1505 */
1506 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1507 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1508
1509 /**
1510 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1511 * package. Specifies that the application being installed should not be
1512 * treated as coming from an unknown source, but as coming from the app
1513 * invoking the Intent. For this to work you must start the installer with
1514 * startActivityForResult().
1515 */
1516 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1517 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1518
1519 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001520 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1521 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001522 * data field originated from.
1523 */
rich cannings706e8ba2012-08-20 13:20:14 -07001524 public static final String EXTRA_ORIGINATING_URI
1525 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001526
1527 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001528 * This extra can be used with any Intent used to launch an activity, supplying information
1529 * about who is launching that activity. This field contains a {@link android.net.Uri}
1530 * object, typically an http: or https: URI of the web site that the referral came from;
1531 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1532 * a native application that it came from.
1533 *
1534 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1535 * instead of directly retrieving the extra. It is also valid for applications to
1536 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1537 * a string, not a Uri; the field here, if supplied, will always take precedence,
1538 * however.</p>
1539 *
1540 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001541 */
1542 public static final String EXTRA_REFERRER
1543 = "android.intent.extra.REFERRER";
1544
1545 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001546 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1547 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1548 * not be created, in particular when Intent extras are supplied through the
1549 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1550 * schemes.
1551 *
1552 * @see #EXTRA_REFERRER
1553 */
1554 public static final String EXTRA_REFERRER_NAME
1555 = "android.intent.extra.REFERRER_NAME";
1556
1557 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001558 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001559 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001560 * @hide
1561 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001562 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001563 public static final String EXTRA_ORIGINATING_UID
1564 = "android.intent.extra.ORIGINATING_UID";
1565
1566 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001567 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1568 * package. Tells the installer UI to skip the confirmation with the user
1569 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001570 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1571 * will no longer show an interstitial message about updating existing
1572 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001573 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001574 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001575 public static final String EXTRA_ALLOW_REPLACE
1576 = "android.intent.extra.ALLOW_REPLACE";
1577
1578 /**
1579 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1580 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1581 * return to the application the result code of the install/uninstall. The returned result
1582 * code will be {@link android.app.Activity#RESULT_OK} on success or
1583 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1584 */
1585 public static final String EXTRA_RETURN_RESULT
1586 = "android.intent.extra.RETURN_RESULT";
1587
1588 /**
1589 * Package manager install result code. @hide because result codes are not
1590 * yet ready to be exposed.
1591 */
1592 public static final String EXTRA_INSTALL_RESULT
1593 = "android.intent.extra.INSTALL_RESULT";
1594
1595 /**
1596 * Activity Action: Launch application uninstaller.
1597 * <p>
1598 * Input: The data must be a package: URI whose scheme specific part is
1599 * the package name of the current installed package to be uninstalled.
1600 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1601 * <p>
1602 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1603 * succeeded.
1604 */
1605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1606 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1607
1608 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001609 * Specify whether the package should be uninstalled for all users.
1610 * @hide because these should not be part of normal application flow.
1611 */
1612 public static final String EXTRA_UNINSTALL_ALL_USERS
1613 = "android.intent.extra.UNINSTALL_ALL_USERS";
1614
1615 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001616 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1617 * describing the last run version of the platform that was setup.
1618 * @hide
1619 */
1620 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1621
Svet Ganov3695b8a2015-03-24 16:30:25 -07001622 /**
1623 * Activity action: Launch UI to manage the permissions of an app.
1624 * <p>
1625 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1626 * will be managed by the launched UI.
1627 * </p>
1628 * <p>
1629 * Output: Nothing.
1630 * </p>
1631 *
1632 * @see #EXTRA_PACKAGE_NAME
1633 *
1634 * @hide
1635 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001636 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001637 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1638 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1639 "android.intent.action.MANAGE_APP_PERMISSIONS";
1640
1641 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001642 * Activity action: Launch UI to manage permissions.
1643 * <p>
1644 * Input: Nothing.
1645 * </p>
1646 * <p>
1647 * Output: Nothing.
1648 * </p>
1649 *
1650 * @hide
1651 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001652 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1654 public static final String ACTION_MANAGE_PERMISSIONS =
1655 "android.intent.action.MANAGE_PERMISSIONS";
1656
1657 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001658 * Activity action: Launch UI to review permissions for an app.
1659 * The system uses this intent if permission review for apps not
1660 * supporting the new runtime permissions model is enabled. In
1661 * this mode a permission review is required before any of the
1662 * app components can run.
1663 * <p>
1664 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1665 * permissions will be reviewed (mandatory).
1666 * </p>
1667 * <p>
1668 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1669 * be fired after the permission review (optional).
1670 * </p>
1671 * <p>
1672 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1673 * be invoked after the permission review (optional).
1674 * </p>
1675 * <p>
1676 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1677 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1678 * </p>
1679 * <p>
1680 * Output: Nothing.
1681 * </p>
1682 *
1683 * @see #EXTRA_PACKAGE_NAME
1684 * @see #EXTRA_INTENT
1685 * @see #EXTRA_REMOTE_CALLBACK
1686 * @see #EXTRA_RESULT_NEEDED
1687 *
1688 * @hide
1689 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001690 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1692 public static final String ACTION_REVIEW_PERMISSIONS =
1693 "android.intent.action.REVIEW_PERMISSIONS";
1694
1695 /**
1696 * Intent extra: A callback for reporting remote result as a bundle.
1697 * <p>
1698 * Type: IRemoteCallback
1699 * </p>
1700 *
1701 * @hide
1702 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001703 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001704 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1705
1706 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001707 * Intent extra: An app package name.
1708 * <p>
1709 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001710 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001711 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001712 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001713 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1714
1715 /**
Todd Kennedye5195dd2016-10-19 15:29:19 -07001716 * Intent extra: An app split name.
1717 * <p>
1718 * Type: String
1719 * </p>
1720 * @hide
1721 */
1722 @SystemApi
1723 public static final String EXTRA_SPLIT_NAME = "android.intent.extra.SPLIT_NAME";
1724
1725 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001726 * Intent extra: An extra for specifying whether a result is needed.
1727 * <p>
1728 * Type: boolean
1729 * </p>
1730 *
1731 * @hide
1732 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001733 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001734 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1735
1736 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001737 * Activity action: Launch UI to manage which apps have a given permission.
1738 * <p>
1739 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1740 * to which will be managed by the launched UI.
1741 * </p>
1742 * <p>
1743 * Output: Nothing.
1744 * </p>
1745 *
1746 * @see #EXTRA_PERMISSION_NAME
1747 *
1748 * @hide
1749 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001750 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001751 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1752 public static final String ACTION_MANAGE_PERMISSION_APPS =
1753 "android.intent.action.MANAGE_PERMISSION_APPS";
1754
1755 /**
1756 * Intent extra: The name of a permission.
1757 * <p>
1758 * Type: String
1759 * </p>
1760 *
1761 * @hide
1762 */
1763 @SystemApi
1764 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1765
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001766 // ---------------------------------------------------------------------
1767 // ---------------------------------------------------------------------
1768 // Standard intent broadcast actions (see action variable).
1769
1770 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001771 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1772 * <p>
1773 * For historical reasons, the name of this broadcast action refers to the power
1774 * state of the screen but it is actually sent in response to changes in the
1775 * overall interactive state of the device.
1776 * </p><p>
1777 * This broadcast is sent when the device becomes non-interactive which may have
1778 * nothing to do with the screen turning off. To determine the
1779 * actual state of the screen, use {@link android.view.Display#getState}.
1780 * </p><p>
1781 * See {@link android.os.PowerManager#isInteractive} for details.
1782 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001783 * You <em>cannot</em> receive this through components declared in
1784 * manifests, only by explicitly registering for it with
1785 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1786 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001787 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001788 * <p class="note">This is a protected intent that can only be sent
1789 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001790 */
1791 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1792 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001793
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001795 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1796 * <p>
1797 * For historical reasons, the name of this broadcast action refers to the power
1798 * state of the screen but it is actually sent in response to changes in the
1799 * overall interactive state of the device.
1800 * </p><p>
1801 * This broadcast is sent when the device becomes interactive which may have
1802 * nothing to do with the screen turning on. To determine the
1803 * actual state of the screen, use {@link android.view.Display#getState}.
1804 * </p><p>
1805 * See {@link android.os.PowerManager#isInteractive} for details.
1806 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001807 * You <em>cannot</em> receive this through components declared in
1808 * manifests, only by explicitly registering for it with
1809 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1810 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001817
1818 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001819 * Broadcast Action: Sent after the system stops dreaming.
1820 *
1821 * <p class="note">This is a protected intent that can only be sent by the system.
1822 * It is only sent to registered receivers.</p>
1823 */
1824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1825 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1826
1827 /**
1828 * Broadcast Action: Sent after the system starts dreaming.
1829 *
1830 * <p class="note">This is a protected intent that can only be sent by the system.
1831 * It is only sent to registered receivers.</p>
1832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1834 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1835
1836 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001837 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001838 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001839 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001840 * <p class="note">This is a protected intent that can only be sent
1841 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001842 */
1843 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001844 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001845
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001846 /**
1847 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001848 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001849 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001850 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1851 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1858 /**
1859 * Broadcast Action: The time was set.
1860 */
1861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1862 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1863 /**
1864 * Broadcast Action: The date has changed.
1865 */
1866 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1867 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1868 /**
1869 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1870 * <ul>
1871 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1872 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001873 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001874 * <p class="note">This is a protected intent that can only be sent
1875 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1878 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1879 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001880 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1881 * DNS entries should be tossed.
1882 * @hide
1883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1885 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1886 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001887 * Alarm Changed Action: This is broadcast when the AlarmClock
1888 * application's alarm is set or unset. It is used by the
1889 * AlarmClock application and the StatusBar service.
1890 * @hide
1891 */
1892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1893 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001894
1895 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001896 * Broadcast Action: This is broadcast once, after the user has finished
1897 * booting, but while still in the "locked" state. It can be used to perform
1898 * application-specific initialization, such as installing alarms. You must
1899 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1900 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001901 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001902 * This broadcast is sent immediately at boot by all devices (regardless of
1903 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1904 * higher. Upon receipt of this broadcast, the user is still locked and only
1905 * device-protected storage can be accessed safely. If you want to access
1906 * credential-protected storage, you need to wait for the user to be
1907 * unlocked (typically by entering their lock pattern or PIN for the first
1908 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1909 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1910 * <p>
1911 * To receive this broadcast, your receiver component must be marked as
1912 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001913 * <p class="note">
1914 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001915 *
1916 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1919 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1920
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001921 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001922 * Broadcast Action: This is broadcast once, after the user has finished
1923 * booting. It can be used to perform application-specific initialization,
1924 * such as installing alarms. You must hold the
1925 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1926 * order to receive this broadcast.
1927 * <p>
1928 * This broadcast is sent at boot by all devices (both with and without
1929 * direct boot support). Upon receipt of this broadcast, the user is
1930 * unlocked and both device-protected and credential-protected storage can
1931 * accessed safely.
1932 * <p>
1933 * If you need to run while the user is still locked (before they've entered
1934 * their lock pattern or PIN for the first time), you can listen for the
1935 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1936 * <p class="note">
1937 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 /**
1943 * Broadcast Action: This is broadcast when a user action should request a
1944 * temporary system dialog to dismiss. Some examples of temporary system
1945 * dialogs are the notification window-shade and the recent tasks dialog.
1946 */
1947 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1948 /**
1949 * Broadcast Action: Trigger the download and eventual installation
1950 * of a package.
1951 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001952 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001953 * <p class="note">This is a protected intent that can only be sent
1954 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001955 *
1956 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001957 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001958 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1961 /**
1962 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001963 * device. The data contains the name of the package. Note that the
1964 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001965 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001966 * <ul>
1967 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1968 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1969 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1970 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001971 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1977 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001978 * Broadcast Action: A new version of an application package has been
1979 * installed, replacing an existing version that was previously installed.
1980 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001981 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001982 * <ul>
1983 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1984 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001985 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001986 * <p class="note">This is a protected intent that can only be sent
1987 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1991 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001992 * Broadcast Action: A new version of your application has been installed
1993 * over an existing one. This is only sent to the application that was
1994 * replaced. It does not contain any additional data; to receive it, just
1995 * use an intent filter for this action.
1996 *
1997 * <p class="note">This is a protected intent that can only be sent
1998 * by the system.
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2002 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 * Broadcast Action: An existing application package has been removed from
2004 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07002005 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002006 * <ul>
2007 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2008 * to the package.
2009 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2010 * application -- data and code -- is being removed.
2011 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2012 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2013 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002014 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002015 * <p class="note">This is a protected intent that can only be sent
2016 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2020 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002021 * Broadcast Action: An existing application package has been completely
2022 * removed from the device. The data contains the name of the package.
2023 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2024 * {@link #EXTRA_DATA_REMOVED} is true and
2025 * {@link #EXTRA_REPLACING} is false of that broadcast.
2026 *
2027 * <ul>
2028 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2029 * to the package.
2030 * </ul>
2031 *
2032 * <p class="note">This is a protected intent that can only be sent
2033 * by the system.
2034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_PACKAGE_FULLY_REMOVED
2037 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2038 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002039 * Broadcast Action: An existing application package has been changed (for
2040 * example, a component has been enabled or disabled). The data contains
2041 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002042 * <ul>
2043 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002044 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002045 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002046 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2047 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002048 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002049 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002050 * <p class="note">This is a protected intent that can only be sent
2051 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2055 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002056 * @hide
2057 * Broadcast Action: Ask system services if there is any reason to
2058 * restart the given package. The data contains the name of the
2059 * package.
2060 * <ul>
2061 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2062 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2063 * </ul>
2064 *
2065 * <p class="note">This is a protected intent that can only be sent
2066 * by the system.
2067 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002068 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002069 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2070 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2071 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002072 * Broadcast Action: The user has restarted a package, and all of its
2073 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002075 * be removed. Note that the restarted package does <em>not</em>
2076 * receive this broadcast.
2077 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 * <ul>
2079 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2080 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002081 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002082 * <p class="note">This is a protected intent that can only be sent
2083 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2087 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002088 * Broadcast Action: The user has cleared the data of a package. This should
2089 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002090 * its persistent data is erased and this broadcast sent.
2091 * Note that the cleared package does <em>not</em>
2092 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002093 * <ul>
2094 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2095 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002096 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002097 * <p class="note">This is a protected intent that can only be sent
2098 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2102 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002103 * Broadcast Action: Packages have been suspended.
2104 * <p>Includes the following extras:
2105 * <ul>
2106 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2107 * </ul>
2108 *
2109 * <p class="note">This is a protected intent that can only be sent
2110 * by the system. It is only sent to registered receivers.
2111 */
2112 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2113 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2114 /**
2115 * Broadcast Action: Packages have been unsuspended.
2116 * <p>Includes the following extras:
2117 * <ul>
2118 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2119 * </ul>
2120 *
2121 * <p class="note">This is a protected intent that can only be sent
2122 * by the system. It is only sent to registered receivers.
2123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2126 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127 * Broadcast Action: A user ID has been removed from the system. The user
2128 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002129 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002130 * <p class="note">This is a protected intent that can only be sent
2131 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 */
2133 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2134 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002135
2136 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002137 * Broadcast Action: Sent to the installer package of an application when
2138 * that application is first launched (that is the first time it is moved
2139 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002140 *
2141 * <p class="note">This is a protected intent that can only be sent
2142 * by the system.
2143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2146
2147 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002148 * Broadcast Action: Sent to the system package verifier when a package
2149 * needs to be verified. The data contains the package URI.
2150 * <p class="note">
2151 * This is a protected intent that can only be sent by the system.
2152 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2156
2157 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002158 * Broadcast Action: Sent to the system package verifier when a package is
2159 * verified. The data contains the package URI.
2160 * <p class="note">
2161 * This is a protected intent that can only be sent by the system.
2162 */
2163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2164 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2165
2166 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002167 * Broadcast Action: Sent to the system intent filter verifier when an
2168 * intent filter needs to be verified. The data contains the filter data
2169 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002170 * <p class="note">
2171 * This is a protected intent that can only be sent by the system.
2172 * </p>
2173 *
2174 * @hide
2175 */
2176 @SystemApi
2177 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2178 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2179
2180 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002181 * Broadcast Action: Resources for a set of packages (which were
2182 * previously unavailable) are currently
2183 * available since the media on which they exist is available.
2184 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2185 * list of packages whose availability changed.
2186 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2187 * list of uids of packages whose availability changed.
2188 * Note that the
2189 * packages in this list do <em>not</em> receive this broadcast.
2190 * The specified set of packages are now available on the system.
2191 * <p>Includes the following extras:
2192 * <ul>
2193 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2194 * whose resources(were previously unavailable) are currently available.
2195 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2196 * packages whose resources(were previously unavailable)
2197 * are currently available.
2198 * </ul>
2199 *
2200 * <p class="note">This is a protected intent that can only be sent
2201 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002202 */
2203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002204 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2205 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002206
2207 /**
2208 * Broadcast Action: Resources for a set of packages are currently
2209 * unavailable since the media on which they exist is unavailable.
2210 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2211 * list of packages whose availability changed.
2212 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2213 * list of uids of packages whose availability changed.
2214 * The specified set of packages can no longer be
2215 * launched and are practically unavailable on the system.
2216 * <p>Inclues the following extras:
2217 * <ul>
2218 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2219 * whose resources are no longer available.
2220 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2221 * whose resources are no longer available.
2222 * </ul>
2223 *
2224 * <p class="note">This is a protected intent that can only be sent
2225 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002226 */
2227 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002228 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002229 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002231 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002232 * Broadcast Action: preferred activities have changed *explicitly*.
2233 *
2234 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2235 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2236 * be sent.
2237 *
2238 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2239 *
2240 * @hide
2241 */
2242 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2243 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2244 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2245
2246
2247 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002248 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002249 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002250 * This should <em>only</em> be used to determine when the wallpaper
2251 * has changed to show the new wallpaper to the user. You should certainly
2252 * never, in response to this, change the wallpaper or other attributes of
2253 * it such as the suggested size. That would be crazy, right? You'd cause
2254 * all kinds of loops, especially if other apps are doing similar things,
2255 * right? Of course. So please don't do this.
2256 *
2257 * @deprecated Modern applications should use
2258 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2259 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2260 * shown behind their UI, rather than watching for this broadcast and
2261 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002262 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002263 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2265 /**
2266 * Broadcast Action: The current device {@link android.content.res.Configuration}
2267 * (orientation, locale, etc) has changed. When such a change happens, the
2268 * UIs (view hierarchy) will need to be rebuilt based on this new
2269 * information; for the most part, applications don't need to worry about
2270 * this, because the system will take care of stopping and restarting the
2271 * application to make sure it sees the new changes. Some system code that
2272 * can not be restarted will need to watch for this action and handle it
2273 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002274 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002275 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002276 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002277 * in manifests, only by explicitly registering for it with
2278 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2279 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002280 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002283 *
2284 * @see android.content.res.Configuration
2285 */
2286 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2287 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2288 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002289 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002290 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002291 * <p class="note">This is a protected intent that can only be sent
2292 * by the system.
2293 */
2294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2295 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2296 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002297 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2298 * charging state, level, and other information about the battery.
2299 * See {@link android.os.BatteryManager} for documentation on the
2300 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002301 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002303 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002304 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002305 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002306 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2307 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2308 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2309 * broadcasts that are sent and can be received through manifest
2310 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002311 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002312 * <p class="note">This is a protected intent that can only be sent
2313 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002314 */
2315 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2316 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2317 /**
2318 * Broadcast Action: Indicates low battery condition on the device.
2319 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002321 * <p class="note">This is a protected intent that can only be sent
2322 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002323 */
2324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2325 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2326 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002327 * Broadcast Action: Indicates the battery is now okay after being low.
2328 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2329 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002330 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2335 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2336 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002337 * Broadcast Action: External power has been connected to the device.
2338 * This is intended for applications that wish to register specifically to this notification.
2339 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2340 * stay active to receive this notification. This action can be used to implement actions
2341 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002342 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002347 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002348 /**
2349 * Broadcast Action: External power has been removed from the device.
2350 * This is intended for applications that wish to register specifically to this notification.
2351 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2352 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002353 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002354 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002355 * <p class="note">This is a protected intent that can only be sent
2356 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002357 */
2358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002359 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002360 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002361 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002362 * Broadcast Action: Device is shutting down.
2363 * This is broadcast when the device is being shut down (completely turned
2364 * off, not sleeping). Once the broadcast is complete, the final shutdown
2365 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002366 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002367 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002368 * <p class="note">This is a protected intent that can only be sent
2369 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002370 * <p>May include the following extras:
2371 * <ul>
2372 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2373 * shutdown is only for userspace processes. If not set, assumed to be false.
2374 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002377 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002378 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002379 * Activity Action: Start this activity to request system shutdown.
2380 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002381 * to request confirmation from the user before shutting down. The optional boolean
2382 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2383 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002384 *
2385 * <p class="note">This is a protected intent that can only be sent
2386 * by the system.
2387 *
2388 * {@hide}
2389 */
2390 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2391 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002392 * Broadcast Action: A sticky broadcast that indicates low memory
2393 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002394 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002395 * <p class="note">This is a protected intent that can only be sent
2396 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002397 */
2398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2399 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2400 /**
2401 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002402 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002403 * <p class="note">This is a protected intent that can only be sent
2404 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002405 */
2406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2407 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2408 /**
Jake Hambybb371632010-08-23 18:16:48 -07002409 * Broadcast Action: A sticky broadcast that indicates a memory full
2410 * condition on the device. This is intended for activities that want
2411 * to be able to fill the data partition completely, leaving only
2412 * enough free space to prevent system-wide SQLite failures.
2413 *
2414 * <p class="note">This is a protected intent that can only be sent
2415 * by the system.
2416 *
2417 * {@hide}
2418 */
2419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2420 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2421 /**
2422 * Broadcast Action: Indicates memory full condition on the device
2423 * no longer exists.
2424 *
2425 * <p class="note">This is a protected intent that can only be sent
2426 * by the system.
2427 *
2428 * {@hide}
2429 */
2430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2431 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2432 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002433 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2434 * and package management should be started.
2435 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2436 * notification.
2437 */
2438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2439 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2440 /**
2441 * Broadcast Action: The device has entered USB Mass Storage mode.
2442 * This is used mainly for the USB Settings panel.
2443 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2444 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002445 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002446 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002447 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002448 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2449
2450 /**
2451 * Broadcast Action: The device has exited USB Mass Storage mode.
2452 * This is used mainly for the USB Settings panel.
2453 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2454 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002455 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002456 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002457 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002458 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2459
2460 /**
2461 * Broadcast Action: External media has been removed.
2462 * The path to the mount point for the removed media is contained in the Intent.mData field.
2463 */
2464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2465 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2466
2467 /**
2468 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002469 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002470 */
2471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2472 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2473
2474 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002475 * Broadcast Action: External media is present, and being disk-checked
2476 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002477 */
2478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2479 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2480
2481 /**
2482 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2483 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002484 */
2485 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2486 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2487
2488 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002489 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002490 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002491 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2492 * media was mounted read only.
2493 */
2494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2495 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2496
2497 /**
2498 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002499 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002500 */
2501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2502 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2503
2504 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002505 * Broadcast Action: External media is no longer being shared via USB mass storage.
2506 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2507 *
2508 * @hide
2509 */
2510 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2511
2512 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002513 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2514 * The path to the mount point for the removed media is contained in the Intent.mData field.
2515 */
2516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2517 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2518
2519 /**
2520 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002521 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2524 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2525
2526 /**
2527 * Broadcast Action: User has expressed the desire to remove the external storage media.
2528 * Applications should close all files they have open within the mount point when they receive this intent.
2529 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2530 */
2531 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2532 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2533
2534 /**
2535 * Broadcast Action: The media scanner has started scanning a directory.
2536 * The path to the directory being scanned is contained in the Intent.mData field.
2537 */
2538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2539 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2540
2541 /**
2542 * Broadcast Action: The media scanner has finished scanning a directory.
2543 * The path to the scanned directory is contained in the Intent.mData field.
2544 */
2545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2546 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2547
2548 /**
2549 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2550 * The path to the file is contained in the Intent.mData field.
2551 */
2552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2553 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2554
2555 /**
2556 * Broadcast Action: The "Media Button" was pressed. Includes a single
2557 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2558 * caused the broadcast.
2559 */
2560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2561 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2562
2563 /**
2564 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2565 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2566 * caused the broadcast.
2567 */
2568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2569 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2570
2571 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2572 // location; they are not general-purpose actions.
2573
2574 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002575 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002576 */
2577 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2578 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2579 "android.intent.action.GTALK_CONNECTED";
2580
2581 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002582 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002583 */
2584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2585 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2586 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002587
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002588 /**
2589 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002590 */
2591 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2592 public static final String ACTION_INPUT_METHOD_CHANGED =
2593 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002594
2595 /**
2596 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2597 * more radios have been turned off or on. The intent will have the following extra value:</p>
2598 * <ul>
2599 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2600 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2601 * turned off</li>
2602 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002603 *
Peng Xua35b5532016-01-20 00:05:45 -08002604 * <p class="note">This is a protected intent that can only be sent by the system.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 */
2606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2607 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2608
2609 /**
2610 * Broadcast Action: Some content providers have parts of their namespace
2611 * where they publish new events or items that the user may be especially
2612 * interested in. For these things, they may broadcast this action when the
2613 * set of interesting items change.
2614 *
2615 * For example, GmailProvider sends this notification when the set of unread
2616 * mail in the inbox changes.
2617 *
2618 * <p>The data of the intent identifies which part of which provider
2619 * changed. When queried through the content resolver, the data URI will
2620 * return the data set in question.
2621 *
2622 * <p>The intent will have the following extra values:
2623 * <ul>
2624 * <li><em>count</em> - The number of items in the data set. This is the
2625 * same as the number of items in the cursor returned by querying the
2626 * data URI. </li>
2627 * </ul>
2628 *
2629 * This intent will be sent at boot (if the count is non-zero) and when the
2630 * data set changes. It is possible for the data set to change without the
2631 * count changing (for example, if a new unread message arrives in the same
2632 * sync operation in which a message is archived). The phone should still
2633 * ring/vibrate/etc as normal in this case.
2634 */
2635 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2636 public static final String ACTION_PROVIDER_CHANGED =
2637 "android.intent.action.PROVIDER_CHANGED";
2638
2639 /**
2640 * Broadcast Action: Wired Headset plugged in or unplugged.
2641 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002642 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2643 * and documentation.
2644 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002645 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002646 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002649 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002650
2651 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002652 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2653 * <ul>
2654 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2655 * </ul>
2656 *
2657 * <p class="note">This is a protected intent that can only be sent
2658 * by the system.
2659 *
2660 * @hide
2661 */
2662 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2663 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2664 = "android.intent.action.ADVANCED_SETTINGS";
2665
2666 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002667 * Broadcast Action: Sent after application restrictions are changed.
2668 *
2669 * <p class="note">This is a protected intent that can only be sent
2670 * by the system.</p>
2671 */
2672 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2673 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2674 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2675
2676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002677 * Broadcast Action: An outgoing call is about to be placed.
2678 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002679 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002680 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002681 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002682 * the phone number originally intended to be dialed.</li>
2683 * </ul>
2684 * <p>Once the broadcast is finished, the resultData is used as the actual
2685 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002686 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002687 * outgoing call in turn: for example, a parental control application
2688 * might verify that the user is authorized to place the call at that
2689 * time, then a number-rewriting application might add an area code if
2690 * one was not specified.</p>
2691 * <p>For consistency, any receiver whose purpose is to prohibit phone
2692 * calls should have a priority of 0, to ensure it will see the final
2693 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002694 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002695 * should have a positive priority.
2696 * Negative priorities are reserved for the system for this broadcast;
2697 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002698 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2699 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002700 * <p>Emergency calls cannot be intercepted using this mechanism, and
2701 * other calls cannot be modified to call emergency numbers using this
2702 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002703 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2704 * call to use their own service instead. Those apps should first prevent
2705 * the call from being placed by setting resultData to <code>null</code>
2706 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002707 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002708 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2709 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002710 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002711 * <p class="note">This is a protected intent that can only be sent
2712 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 */
2714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2715 public static final String ACTION_NEW_OUTGOING_CALL =
2716 "android.intent.action.NEW_OUTGOING_CALL";
2717
2718 /**
2719 * Broadcast Action: Have the device reboot. This is only for use by
2720 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002721 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002722 * <p class="note">This is a protected intent that can only be sent
2723 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 */
2725 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2726 public static final String ACTION_REBOOT =
2727 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002728
Wei Huang97ecc9c2009-05-11 17:44:20 -07002729 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002730 * Broadcast Action: A sticky broadcast for changes in the physical
2731 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002732 *
2733 * <p>The intent will have the following extra values:
2734 * <ul>
2735 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002736 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002737 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002738 * <p>This is intended for monitoring the current physical dock state.
2739 * See {@link android.app.UiModeManager} for the normal API dealing with
2740 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002741 */
2742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2743 public static final String ACTION_DOCK_EVENT =
2744 "android.intent.action.DOCK_EVENT";
2745
2746 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002747 * Broadcast Action: A broadcast when idle maintenance can be started.
2748 * This means that the user is not interacting with the device and is
2749 * not expected to do so soon. Typical use of the idle maintenance is
2750 * to perform somehow expensive tasks that can be postponed at a moment
2751 * when they will not degrade user experience.
2752 * <p>
2753 * <p class="note">In order to keep the device responsive in case of an
2754 * unexpected user interaction, implementations of a maintenance task
2755 * should be interruptible. In such a scenario a broadcast with action
2756 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2757 * should not do the maintenance work in
2758 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2759 * maintenance service by {@link Context#startService(Intent)}. Also
2760 * you should hold a wake lock while your maintenance service is running
2761 * to prevent the device going to sleep.
2762 * </p>
2763 * <p>
2764 * <p class="note">This is a protected intent that can only be sent by
2765 * the system.
2766 * </p>
2767 *
2768 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002769 *
2770 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002771 */
2772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2773 public static final String ACTION_IDLE_MAINTENANCE_START =
2774 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2775
2776 /**
2777 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2778 * This means that the user was not interacting with the device as a result
2779 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2780 * was sent and now the user started interacting with the device. Typical
2781 * use of the idle maintenance is to perform somehow expensive tasks that
2782 * can be postponed at a moment when they will not degrade user experience.
2783 * <p>
2784 * <p class="note">In order to keep the device responsive in case of an
2785 * unexpected user interaction, implementations of a maintenance task
2786 * should be interruptible. Hence, on receiving a broadcast with this
2787 * action, the maintenance task should be interrupted as soon as possible.
2788 * In other words, you should not do the maintenance work in
2789 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2790 * maintenance service that was started on receiving of
2791 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2792 * lock you acquired when your maintenance service started.
2793 * </p>
2794 * <p class="note">This is a protected intent that can only be sent
2795 * by the system.
2796 *
2797 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002798 *
2799 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002800 */
2801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2802 public static final String ACTION_IDLE_MAINTENANCE_END =
2803 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2804
2805 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002806 * Broadcast Action: a remote intent is to be broadcasted.
2807 *
2808 * A remote intent is used for remote RPC between devices. The remote intent
2809 * is serialized and sent from one device to another device. The receiving
2810 * device parses the remote intent and broadcasts it. Note that anyone can
2811 * broadcast a remote intent. However, if the intent receiver of the remote intent
2812 * does not trust intent broadcasts from arbitrary intent senders, it should require
2813 * the sender to hold certain permissions so only trusted sender's broadcast will be
2814 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002815 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002816 */
2817 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002818 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002819
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002820 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002821 * Broadcast Action: This is broadcast once when the user is booting after a
2822 * system update. It can be used to perform cleanup or upgrades after a
2823 * system update.
2824 * <p>
2825 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2826 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2827 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2828 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002829 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002830 * @hide
2831 */
2832 public static final String ACTION_PRE_BOOT_COMPLETED =
2833 "android.intent.action.PRE_BOOT_COMPLETED";
2834
Amith Yamasani13593602012-03-22 16:16:17 -07002835 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002836 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002837 * on restricted users. The broadcast intent contains an extra
2838 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2839 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2840 * String[] depending on the restriction type.<p/>
2841 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002842 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2843 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2844 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002845 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2846 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002847 * @see RestrictionEntry
2848 */
2849 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2850 "android.intent.action.GET_RESTRICTION_ENTRIES";
2851
2852 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002853 * Sent the first time a user is starting, to allow system apps to
2854 * perform one time initialization. (This will not be seen by third
2855 * party applications because a newly initialized user does not have any
2856 * third party applications installed for it.) This is sent early in
2857 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002858 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2859 * broadcast, since it is part of a visible user interaction; be as quick
2860 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002861 */
2862 public static final String ACTION_USER_INITIALIZE =
2863 "android.intent.action.USER_INITIALIZE";
2864
2865 /**
2866 * Sent when a user switch is happening, causing the process's user to be
2867 * brought to the foreground. This is only sent to receivers registered
2868 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2869 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002870 * foreground. This is sent as a foreground
2871 * broadcast, since it is part of a visible user interaction; be as quick
2872 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002873 */
2874 public static final String ACTION_USER_FOREGROUND =
2875 "android.intent.action.USER_FOREGROUND";
2876
2877 /**
2878 * Sent when a user switch is happening, causing the process's user to be
2879 * sent to the background. This is only sent to receivers registered
2880 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2881 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002882 * background. This is sent as a foreground
2883 * broadcast, since it is part of a visible user interaction; be as quick
2884 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002885 */
2886 public static final String ACTION_USER_BACKGROUND =
2887 "android.intent.action.USER_BACKGROUND";
2888
2889 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002890 * Broadcast sent to the system when a user is added. Carries an extra
2891 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2892 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002893 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002894 * @hide
2895 */
2896 public static final String ACTION_USER_ADDED =
2897 "android.intent.action.USER_ADDED";
2898
2899 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002900 * Broadcast sent by the system when a user is started. Carries an extra
2901 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002902 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002903 * that has been started. This is sent as a foreground
2904 * broadcast, since it is part of a visible user interaction; be as quick
2905 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002906 * @hide
2907 */
2908 public static final String ACTION_USER_STARTED =
2909 "android.intent.action.USER_STARTED";
2910
2911 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002912 * Broadcast sent when a user is in the process of starting. Carries an extra
2913 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2914 * sent to registered receivers, not manifest receivers. It is sent to all
2915 * users (including the one that is being started). You must hold
2916 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2917 * this broadcast. This is sent as a background broadcast, since
2918 * its result is not part of the primary UX flow; to safely keep track of
2919 * started/stopped state of a user you can use this in conjunction with
2920 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2921 * other user state broadcasts since those are foreground broadcasts so can
2922 * execute in a different order.
2923 * @hide
2924 */
2925 public static final String ACTION_USER_STARTING =
2926 "android.intent.action.USER_STARTING";
2927
2928 /**
2929 * Broadcast sent when a user is going to be stopped. Carries an extra
2930 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2931 * sent to registered receivers, not manifest receivers. It is sent to all
2932 * users (including the one that is being stopped). You must hold
2933 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2934 * this broadcast. The user will not stop until all receivers have
2935 * handled the broadcast. This is sent as a background broadcast, since
2936 * its result is not part of the primary UX flow; to safely keep track of
2937 * started/stopped state of a user you can use this in conjunction with
2938 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2939 * other user state broadcasts since those are foreground broadcasts so can
2940 * execute in a different order.
2941 * @hide
2942 */
2943 public static final String ACTION_USER_STOPPING =
2944 "android.intent.action.USER_STOPPING";
2945
2946 /**
2947 * Broadcast sent to the system when a user is stopped. Carries an extra
2948 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2949 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2950 * specific package. This is only sent to registered receivers, not manifest
2951 * receivers. It is sent to all running users <em>except</em> the one that
2952 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002953 * @hide
2954 */
2955 public static final String ACTION_USER_STOPPED =
2956 "android.intent.action.USER_STOPPED";
2957
2958 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002959 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002960 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002961 * one that has been removed. The user will not be completely removed until all receivers have
2962 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002963 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002964 * @hide
2965 */
2966 public static final String ACTION_USER_REMOVED =
2967 "android.intent.action.USER_REMOVED";
2968
2969 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002970 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002971 * the userHandle of the user to become the current one. This is only sent to
2972 * registered receivers, not manifest receivers. It is sent to all running users.
2973 * You must hold
2974 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002975 * @hide
2976 */
2977 public static final String ACTION_USER_SWITCHED =
2978 "android.intent.action.USER_SWITCHED";
2979
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002980 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002981 * Broadcast Action: Sent when the credential-encrypted private storage has
2982 * become unlocked for the target user. This is only sent to registered
2983 * receivers, not manifest receivers.
2984 */
2985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2986 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2987
2988 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002989 * Broadcast sent to the system when a user's information changes. Carries an extra
2990 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002991 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002992 * @hide
2993 */
2994 public static final String ACTION_USER_INFO_CHANGED =
2995 "android.intent.action.USER_INFO_CHANGED";
2996
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002997 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002998 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2999 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003000 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3001 * that need to display merged content across both primary and managed profiles need to
3002 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003003 * not manifest receivers.
3004 */
3005 public static final String ACTION_MANAGED_PROFILE_ADDED =
3006 "android.intent.action.MANAGED_PROFILE_ADDED";
3007
3008 /**
3009 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003010 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3011 * Only applications (for example Launchers) that need to display merged content across both
3012 * primary and managed profiles need to worry about this broadcast. This is only sent to
3013 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003014 */
3015 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3016 "android.intent.action.MANAGED_PROFILE_REMOVED";
3017
3018 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003019 * Broadcast sent to the primary user when the credential-encrypted private storage for
3020 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3021 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3022 * Launchers) that need to display merged content across both primary and managed profiles
3023 * need to worry about this broadcast. This is only sent to registered receivers,
3024 * not manifest receivers.
3025 */
3026 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3027 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3028
3029 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003030 * Broadcast sent to the primary user when an associated managed profile has become available.
3031 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003032 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3033 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3034 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003035 */
Rubin Xue95057a2016-04-01 16:49:25 +01003036 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3037 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3038
3039 /**
3040 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3041 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3042 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3043 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3044 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3045 */
3046 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3047 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003048
3049 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003050 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3051 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3052 * the device was locked or unlocked.
3053 *
3054 * This is only sent to registered receivers.
3055 *
3056 * @hide
3057 */
3058 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3059 "android.intent.action.DEVICE_LOCKED_CHANGED";
3060
3061 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003062 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3063 */
3064 public static final String ACTION_QUICK_CLOCK =
3065 "android.intent.action.QUICK_CLOCK";
3066
Michael Wright0087a142013-02-05 16:29:39 -08003067 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003068 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003069 * @hide
3070 */
3071 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3072 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3073
Justin Kohd378ad72013-04-01 12:18:26 -07003074 /**
3075 * Broadcast Action: A global button was pressed. Includes a single
3076 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3077 * caused the broadcast.
3078 * @hide
3079 */
3080 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3081
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003082 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003083 * Broadcast Action: Sent when media resource is granted.
3084 * <p>
3085 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3086 * granted.
3087 * </p>
3088 * <p class="note">
3089 * This is a protected intent that can only be sent by the system.
3090 * </p>
3091 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003092 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003093 * </p>
3094 *
3095 * @hide
3096 */
3097 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3098 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3099
3100 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003101 * Activity Action: Allow the user to select and return one or more existing
3102 * documents. When invoked, the system will display the various
3103 * {@link DocumentsProvider} instances installed on the device, letting the
3104 * user interactively navigate through them. These documents include local
3105 * media, such as photos and video, and documents provided by installed
3106 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003107 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003108 * Each document is represented as a {@code content://} URI backed by a
3109 * {@link DocumentsProvider}, which can be opened as a stream with
3110 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3111 * {@link android.provider.DocumentsContract.Document} metadata.
3112 * <p>
3113 * All selected documents are returned to the calling application with
3114 * persistable read and write permission grants. If you want to maintain
3115 * access to the documents across device reboots, you need to explicitly
3116 * take the persistable permissions using
3117 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3118 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003119 * Callers must indicate the acceptable document MIME types through
3120 * {@link #setType(String)}. For example, to select photos, use
3121 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3122 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3123 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003124 * <p>
3125 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003126 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3127 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003128 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003129 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3130 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003131 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003132 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003133 * Callers can set a document URI through
3134 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3135 * location of documents navigator. System will do its best to launch the
3136 * navigator in the specified document if it's a folder, or the folder that
3137 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003138 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003139 * Output: The URI of the item that was picked, returned in
3140 * {@link #getData()}. This must be a {@code content://} URI so that any
3141 * receiver can access it. If multiple documents were selected, they are
3142 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003143 *
3144 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003145 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003146 * @see #ACTION_CREATE_DOCUMENT
3147 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003148 */
3149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3150 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3151
3152 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003153 * Activity Action: Allow the user to create a new document. When invoked,
3154 * the system will display the various {@link DocumentsProvider} instances
3155 * installed on the device, letting the user navigate through them. The
3156 * returned document may be a newly created document with no content, or it
3157 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003158 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003159 * Each document is represented as a {@code content://} URI backed by a
3160 * {@link DocumentsProvider}, which can be opened as a stream with
3161 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3162 * {@link android.provider.DocumentsContract.Document} metadata.
3163 * <p>
3164 * Callers must indicate the concrete MIME type of the document being
3165 * created by setting {@link #setType(String)}. This MIME type cannot be
3166 * changed after the document is created.
3167 * <p>
3168 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3169 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003170 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003171 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3172 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003173 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003174 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003175 * Callers can set a document URI through
3176 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3177 * location of documents navigator. System will do its best to launch the
3178 * navigator in the specified document if it's a folder, or the folder that
3179 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003180 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003181 * Output: The URI of the item that was created. This must be a
3182 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003183 *
3184 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003185 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003186 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003187 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003188 */
3189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3190 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3191
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003192 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003193 * Activity Action: Allow the user to pick a directory subtree. When
3194 * invoked, the system will display the various {@link DocumentsProvider}
3195 * instances installed on the device, letting the user navigate through
3196 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003197 * <p>
3198 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003199 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3200 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3201 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003202 * <p>
Garfield Tanb44ae612016-11-07 16:46:37 -08003203 * Callers can set a document URI through
3204 * {@link DocumentsContract#EXTRA_INITIAL_URI} to indicate the initial
3205 * location of documents navigator. System will do its best to launch the
3206 * navigator in the specified document if it's a folder, or the folder that
3207 * contains the specified document if not.
Garfield Tan0b3cf662016-10-31 12:59:45 -07003208 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003209 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003210 *
3211 * @see DocumentsContract
3212 */
3213 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003214 public static final String
3215 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003216
Felipe Lemec7b1f892016-01-15 15:02:31 -08003217 /**
Peng Xua35b5532016-01-20 00:05:45 -08003218 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3219 * exisiting sensor being disconnected.
3220 *
3221 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3222 *
3223 * {@hide}
3224 */
3225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3226 public static final String
3227 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3228
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003229 /**
3230 * Deprecated - use {@link #ACTION_FACTORY_RESET} instead.
3231 *
3232 * {@hide}
3233 */
3234 @Deprecated
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003235 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3236
Christopher Tate6597e342015-02-17 12:15:25 -08003237 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003238 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3239 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3240 *
3241 * <p>Deprecated - use {@link #EXTRA_FORCE_FACTORY_RESET} instead.
3242 *
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003243 * @hide
3244 */
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003245 @Deprecated
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003246 public static final String EXTRA_FORCE_MASTER_CLEAR =
3247 "android.intent.extra.FORCE_MASTER_CLEAR";
3248
3249 /**
Lenka Trochtova73aeea22016-11-18 17:34:34 +01003250 * A broadcast action to trigger a factory reset.
3251 *
3252 * <p> The sender must hold the {@link android.Manifest.permission#MASTER_CLEAR} permission.
3253 *
3254 * <p>Not for use by third-party applications.
3255 *
3256 * @see #EXTRA_FORCE_MASTER_CLEAR
3257 *
3258 * {@hide}
3259 */
3260 @SystemApi
3261 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3262 public static final String ACTION_FACTORY_RESET = "android.intent.action.FACTORY_RESET";
3263
3264 /**
3265 * Boolean intent extra to be used with {@link #ACTION_MASTER_CLEAR} in order to force a factory
3266 * reset even if {@link android.os.UserManager#DISALLOW_FACTORY_RESET} is set.
3267 *
3268 * <p>Not for use by third-party applications.
3269 *
3270 * @hide
3271 */
3272 @SystemApi
3273 public static final String EXTRA_FORCE_FACTORY_RESET =
3274 "android.intent.extra.FORCE_FACTORY_RESET";
3275
3276 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003277 * Broadcast action: report that a settings element is being restored from backup. The intent
3278 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3279 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3280 * is the value of that settings entry prior to the restore operation. All of these values are
3281 * represented as strings.
3282 *
3283 * <p>This broadcast is sent only for settings provider entries known to require special handling
3284 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3285 * the provider's backup agent implementation.
3286 *
3287 * @see #EXTRA_SETTING_NAME
3288 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3289 * @see #EXTRA_SETTING_NEW_VALUE
3290 * {@hide}
3291 */
3292 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3293
3294 /** {@hide} */
3295 public static final String EXTRA_SETTING_NAME = "setting_name";
3296 /** {@hide} */
3297 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3298 /** {@hide} */
3299 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3300
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003301 /**
3302 * Activity Action: Process a piece of text.
3303 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3304 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3305 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3306 */
3307 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3308 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3309 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003310 * The name of the extra used to define the text to be processed, as a
3311 * CharSequence. Note that this may be a styled CharSequence, so you must use
3312 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003313 */
3314 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3315 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003316 * 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 +00003317 */
3318 public static final String EXTRA_PROCESS_TEXT_READONLY =
3319 "android.intent.extra.PROCESS_TEXT_READONLY";
3320
Bryce Leebc58f592015-09-25 16:43:01 -07003321 /**
3322 * Broadcast action: reports when a new thermal event has been reached. When the device
3323 * is reaching its maximum temperatue, the thermal level reported
3324 * {@hide}
3325 */
3326 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3327 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3328
3329 /** {@hide} */
3330 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3331
3332 /**
3333 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003334 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003335 * {@hide}
3336 */
3337 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3338
3339 /**
3340 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003341 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003342 * {@hide}
3343 */
3344 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3345
3346 /**
3347 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003348 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003349 * {@hide}
3350 */
3351 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3352
3353
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003354 // ---------------------------------------------------------------------
3355 // ---------------------------------------------------------------------
3356 // Standard intent categories (see addCategory()).
3357
3358 /**
3359 * Set if the activity should be an option for the default action
3360 * (center press) to perform on a piece of data. Setting this will
3361 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003362 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003363 * Intent when initiating an action -- it is for use in intent filters
3364 * specified in packages.
3365 */
3366 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3367 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3368 /**
3369 * Activities that can be safely invoked from a browser must support this
3370 * category. For example, if the user is viewing a web page or an e-mail
3371 * and clicks on a link in the text, the Intent generated execute that
3372 * link will require the BROWSABLE category, so that only activities
3373 * supporting this category will be considered as possible actions. By
3374 * supporting this category, you are promising that there is nothing
3375 * damaging (without user intervention) that can happen by invoking any
3376 * matching Intent.
3377 */
3378 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3379 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3380 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003381 * Categories for activities that can participate in voice interaction.
3382 * An activity that supports this category must be prepared to run with
3383 * no UI shown at all (though in some case it may have a UI shown), and
3384 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3385 */
3386 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3387 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3388 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003389 * Set if the activity should be considered as an alternative action to
3390 * the data the user is currently viewing. See also
3391 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3392 * applies to the selection in a list of items.
3393 *
3394 * <p>Supporting this category means that you would like your activity to be
3395 * displayed in the set of alternative things the user can do, usually as
3396 * part of the current activity's options menu. You will usually want to
3397 * include a specific label in the &lt;intent-filter&gt; of this action
3398 * describing to the user what it does.
3399 *
3400 * <p>The action of IntentFilter with this category is important in that it
3401 * describes the specific action the target will perform. This generally
3402 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3403 * a specific name such as "com.android.camera.action.CROP. Only one
3404 * alternative of any particular action will be shown to the user, so using
3405 * a specific action like this makes sure that your alternative will be
3406 * displayed while also allowing other applications to provide their own
3407 * overrides of that particular action.
3408 */
3409 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3410 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3411 /**
3412 * Set if the activity should be considered as an alternative selection
3413 * action to the data the user has currently selected. This is like
3414 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3415 * of items from which the user can select, giving them alternatives to the
3416 * default action that will be performed on it.
3417 */
3418 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3419 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3420 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003421 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003422 */
3423 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3424 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3425 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003426 * Should be displayed in the top-level launcher.
3427 */
3428 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3429 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3430 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003431 * Indicates an activity optimized for Leanback mode, and that should
3432 * be displayed in the Leanback launcher.
3433 */
3434 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3435 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3436 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003437 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3438 * @hide
3439 */
3440 @SystemApi
3441 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3442 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003443 * Provides information about the package it is in; typically used if
3444 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3445 * a front-door to the user without having to be shown in the all apps list.
3446 */
3447 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3448 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3449 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003450 * This is the home activity, that is the first activity that is displayed
3451 * when the device boots.
3452 */
3453 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3454 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3455 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003456 * This is the home activity that is displayed when the device is finished setting up and ready
3457 * for use.
3458 * @hide
3459 */
3460 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3461 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3462 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003463 * This is the setup wizard activity, that is the first activity that is displayed
3464 * when the user sets up the device for the first time.
3465 * @hide
3466 */
3467 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3468 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3469 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003470 * This activity is a preference panel.
3471 */
3472 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3473 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3474 /**
3475 * This activity is a development preference panel.
3476 */
3477 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3478 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3479 /**
3480 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481 */
3482 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3483 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3484 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003485 * This activity allows the user to browse and download new applications.
3486 */
3487 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3488 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3489 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003490 * This activity may be exercised by the monkey or other automated test tools.
3491 */
3492 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3493 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3494 /**
3495 * To be used as a test (not part of the normal user experience).
3496 */
3497 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3498 /**
3499 * To be used as a unit test (run through the Test Harness).
3500 */
3501 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3502 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003503 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003504 * experience).
3505 */
3506 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003507
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003508 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003509 * Used to indicate that an intent only wants URIs that can be opened with
3510 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3511 * must support at least the columns defined in {@link OpenableColumns} when
3512 * queried.
3513 *
3514 * @see #ACTION_GET_CONTENT
3515 * @see #ACTION_OPEN_DOCUMENT
3516 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003517 */
3518 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3519 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3520
3521 /**
Tomasz Mikolajewski28a815c2016-10-28 15:54:11 +09003522 * Used to indicate that an intent filter can accept files which are not necessarily
3523 * openable by {@link ContentResolver#openFileDescriptor(Uri, String)}, but
3524 * at least streamable via
3525 * {@link ContentResolver#openTypedAssetFileDescriptor(Uri, String, Bundle)}
3526 * using one of the stream types exposed via
3527 * {@link ContentResolver#getStreamTypes(Uri, String)}.
3528 *
3529 * @see #ACTION_SEND
3530 * @see #ACTION_SEND_MULTIPLE
3531 */
3532 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3533 public static final String CATEGORY_TYPED_OPENABLE =
3534 "android.intent.category.TYPED_OPENABLE";
3535
3536 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003537 * To be used as code under test for framework instrumentation tests.
3538 */
3539 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3540 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003541 /**
3542 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003543 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3544 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003545 */
3546 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3547 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3548 /**
3549 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003550 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3551 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003552 */
3553 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3554 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003555 /**
3556 * An activity to run when device is inserted into a analog (low end) dock.
3557 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3558 * information, see {@link android.app.UiModeManager}.
3559 */
3560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3561 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3562
3563 /**
3564 * An activity to run when device is inserted into a digital (high end) dock.
3565 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3566 * information, see {@link android.app.UiModeManager}.
3567 */
3568 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3569 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003570
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003571 /**
3572 * Used to indicate that the activity can be used in a car environment.
3573 */
3574 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3575 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3576
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003577 // ---------------------------------------------------------------------
3578 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003579 // Application launch intent categories (see addCategory()).
3580
3581 /**
3582 * Used with {@link #ACTION_MAIN} to launch the browser application.
3583 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003584 * <p>NOTE: This should not be used as the primary key of an Intent,
3585 * since it will not result in the app launching with the correct
3586 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003587 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003588 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003589 */
3590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3591 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3592
3593 /**
3594 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3595 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003596 * <p>NOTE: This should not be used as the primary key of an Intent,
3597 * since it will not result in the app launching with the correct
3598 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003599 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003600 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003601 */
3602 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3603 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3604
3605 /**
3606 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3607 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003608 * <p>NOTE: This should not be used as the primary key of an Intent,
3609 * since it will not result in the app launching with the correct
3610 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003611 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003612 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003613 */
3614 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3615 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3616
3617 /**
3618 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3619 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003620 * <p>NOTE: This should not be used as the primary key of an Intent,
3621 * since it will not result in the app launching with the correct
3622 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003623 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003624 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003625 */
3626 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3627 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3628
3629 /**
3630 * Used with {@link #ACTION_MAIN} to launch the email application.
3631 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003632 * <p>NOTE: This should not be used as the primary key of an Intent,
3633 * since it will not result in the app launching with the correct
3634 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003635 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003636 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003637 */
3638 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3639 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3640
3641 /**
3642 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3643 * The activity should be able to view and manipulate image and video files
3644 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003645 * <p>NOTE: This should not be used as the primary key of an Intent,
3646 * since it will not result in the app launching with the correct
3647 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003648 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003649 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003650 */
3651 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3652 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3653
3654 /**
3655 * Used with {@link #ACTION_MAIN} to launch the maps application.
3656 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003657 * <p>NOTE: This should not be used as the primary key of an Intent,
3658 * since it will not result in the app launching with the correct
3659 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003660 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003661 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003662 */
3663 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3664 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3665
3666 /**
3667 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3668 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003669 * <p>NOTE: This should not be used as the primary key of an Intent,
3670 * since it will not result in the app launching with the correct
3671 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003672 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003673 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003674 */
3675 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3676 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3677
3678 /**
3679 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003680 * The activity should be able to play, browse, or manipulate music files
3681 * stored on the device.
3682 * <p>NOTE: This should not be used as the primary key of an Intent,
3683 * since it will not result in the app launching with the correct
3684 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003685 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003686 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003687 */
3688 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3689 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3690
3691 // ---------------------------------------------------------------------
3692 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003693 // Standard extra data keys.
3694
3695 /**
3696 * The initial data to place in a newly created record. Use with
3697 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3698 * fields as would be given to the underlying ContentProvider.insert()
3699 * call.
3700 */
3701 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3702
3703 /**
3704 * A constant CharSequence that is associated with the Intent, used with
3705 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3706 * this may be a styled CharSequence, so you must use
3707 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3708 * retrieve it.
3709 */
3710 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3711
3712 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003713 * A constant String that is associated with the Intent, used with
3714 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3715 * as HTML formatted text. Note that you <em>must</em> also supply
3716 * {@link #EXTRA_TEXT}.
3717 */
3718 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3719
3720 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003721 * A content: URI holding a stream of data associated with the Intent,
3722 * used with {@link #ACTION_SEND} to supply the data being sent.
3723 */
3724 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3725
3726 /**
3727 * A String[] holding e-mail addresses that should be delivered to.
3728 */
3729 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3730
3731 /**
3732 * A String[] holding e-mail addresses that should be carbon copied.
3733 */
3734 public static final String EXTRA_CC = "android.intent.extra.CC";
3735
3736 /**
3737 * A String[] holding e-mail addresses that should be blind carbon copied.
3738 */
3739 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3740
3741 /**
3742 * A constant string holding the desired subject line of a message.
3743 */
3744 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3745
3746 /**
3747 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003748 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003749 */
3750 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3751
3752 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003753 * An int representing the user id to be used.
3754 *
3755 * @hide
3756 */
3757 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3758
3759 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003760 * An int representing the task id to be retrieved. This is used when a launch from recents is
3761 * intercepted by another action such as credentials confirmation to remember which task should
3762 * be resumed when complete.
3763 *
3764 * @hide
3765 */
3766 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3767
3768 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003769 * An Intent[] describing additional, alternate choices you would like shown with
3770 * {@link #ACTION_CHOOSER}.
3771 *
3772 * <p>An app may be capable of providing several different payload types to complete a
3773 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3774 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3775 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3776 * photo data or a hosted link where the photos can be viewed.</p>
3777 *
3778 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3779 * first/primary/preferred intent in the set. Additional intents specified in
3780 * this extra are ordered; by default intents that appear earlier in the array will be
3781 * preferred over intents that appear later in the array as matches for the same
3782 * target component. To alter this preference, a calling app may also supply
3783 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3784 */
3785 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3786
3787 /**
Adam Powell52c39212016-04-07 15:14:18 -07003788 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3789 * and omitted from a list of components presented to the user.
3790 *
3791 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3792 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3793 * from your own package or other apps from your organization if the idea of sending to those
3794 * targets would be redundant with other app functionality. Filtered components will not
3795 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3796 */
3797 public static final String EXTRA_EXCLUDE_COMPONENTS
3798 = "android.intent.extra.EXCLUDE_COMPONENTS";
3799
3800 /**
3801 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3802 * describing additional high-priority deep-link targets for the chooser to present to the user.
3803 *
3804 * <p>Targets provided in this way will be presented inline with all other targets provided
3805 * by services from other apps. They will be prioritized before other service targets, but
3806 * after those targets provided by sources that the user has manually pinned to the front.</p>
3807 *
3808 * @see #ACTION_CHOOSER
3809 */
3810 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3811
3812 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003813 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3814 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3815 *
3816 * <p>An app preparing an action for another app to complete may wish to allow the user to
3817 * disambiguate between several options for completing the action based on the chosen target
3818 * or otherwise refine the action before it is invoked.
3819 * </p>
3820 *
3821 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3822 * <ul>
3823 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3824 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3825 * chosen target beyond the first</li>
3826 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3827 * should fill in and send once the disambiguation is complete</li>
3828 * </ul>
3829 */
3830 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3831 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3832
3833 /**
3834 * A {@link ResultReceiver} used to return data back to the sender.
3835 *
3836 * <p>Used to complete an app-specific
3837 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3838 *
3839 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3840 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3841 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3842 * when the user selects a target component from the chooser. It is up to the recipient
3843 * to send a result to this ResultReceiver to signal that disambiguation is complete
3844 * and that the chooser should invoke the user's choice.</p>
3845 *
3846 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3847 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3848 * to match and fill in the final Intent or ChooserTarget before starting it.
3849 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3850 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3851 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3852 *
3853 * <p>The result code passed to the ResultReceiver should be
3854 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3855 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3856 * the chooser should finish without starting a target.</p>
3857 */
3858 public static final String EXTRA_RESULT_RECEIVER
3859 = "android.intent.extra.RESULT_RECEIVER";
3860
3861 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003862 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003863 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003864 */
3865 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3866
3867 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003868 * A Parcelable[] of {@link Intent} or
3869 * {@link android.content.pm.LabeledIntent} objects as set with
3870 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3871 * a the front of the list of choices, when shown to the user with a
3872 * {@link #ACTION_CHOOSER}.
3873 */
3874 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3875
3876 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003877 * A {@link IntentSender} to start after ephemeral installation success.
3878 * @hide
3879 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003880 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3881
3882 /**
3883 * A {@link IntentSender} to start after ephemeral installation failure.
3884 * @hide
3885 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003886 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3887
3888 /**
Todd Kennedy01ad0c72016-11-11 15:33:12 -08003889 * The host name that triggered an ephemeral resolution.
3890 * @hide
3891 */
3892 public static final String EXTRA_EPHEMERAL_HOSTNAME = "android.intent.extra.EPHEMERAL_HOSTNAME";
3893
3894 /**
3895 * An opaque token to track ephemeral resolution.
3896 * @hide
3897 */
3898 public static final String EXTRA_EPHEMERAL_TOKEN = "android.intent.extra.EPHEMERAL_TOKEN";
3899
3900 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003901 * A Bundle forming a mapping of potential target package names to different extras Bundles
3902 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3903 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3904 * be currently installed on the device.
3905 *
3906 * <p>An application may choose to provide alternate extras for the case where a user
3907 * selects an activity from a predetermined set of target packages. If the activity
3908 * the user selects from the chooser belongs to a package with its package name as
3909 * a key in this bundle, the corresponding extras for that package will be merged with
3910 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3911 * extra has the same key as an extra already present in the intent it will overwrite
3912 * the extra from the intent.</p>
3913 *
3914 * <p><em>Examples:</em>
3915 * <ul>
3916 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3917 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3918 * parameters for that target.</li>
3919 * <li>An application may offer additional metadata for known targets of a given intent
3920 * to pass along information only relevant to that target such as account or content
3921 * identifiers already known to that application.</li>
3922 * </ul></p>
3923 */
3924 public static final String EXTRA_REPLACEMENT_EXTRAS =
3925 "android.intent.extra.REPLACEMENT_EXTRAS";
3926
3927 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003928 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3929 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3930 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3931 * {@link ComponentName} of the chosen component.
3932 *
3933 * <p>In some situations this callback may never come, for example if the user abandons
3934 * the chooser, switches to another task or any number of other reasons. Apps should not
3935 * be written assuming that this callback will always occur.</p>
3936 */
3937 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3938 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3939
3940 /**
3941 * The {@link ComponentName} chosen by the user to complete an action.
3942 *
3943 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3944 */
3945 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3946
3947 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948 * A {@link android.view.KeyEvent} object containing the event that
3949 * triggered the creation of the Intent it is in.
3950 */
3951 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3952
3953 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003954 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3955 * before shutting down.
3956 *
3957 * {@hide}
3958 */
3959 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3960
3961 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003962 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3963 * requested by the user.
3964 *
3965 * {@hide}
3966 */
3967 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3968 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3969
3970 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003971 * 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 -07003972 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3973 * of restarting the application.
3974 */
3975 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3976
3977 /**
3978 * A String holding the phone number originally entered in
3979 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3980 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3981 */
3982 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003983
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003984 /**
3985 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3986 * intents to supply the uid the package had been assigned. Also an optional
3987 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3988 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3989 * purpose.
3990 */
3991 public static final String EXTRA_UID = "android.intent.extra.UID";
3992
3993 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003994 * @hide String array of package names.
3995 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003996 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003997 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3998
3999 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004000 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4001 * intents to indicate whether this represents a full uninstall (removing
4002 * both the code and its data) or a partial uninstall (leaving its data,
4003 * implying that this is an update).
4004 */
4005 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07004006
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004007 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07004008 * @hide
4009 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4010 * intents to indicate that at this point the package has been removed for
4011 * all users on the device.
4012 */
4013 public static final String EXTRA_REMOVED_FOR_ALL_USERS
4014 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
4015
4016 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004017 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
4018 * intents to indicate that this is a replacement of the package, so this
4019 * broadcast will immediately be followed by an add broadcast for a
4020 * different version of the same package.
4021 */
4022 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07004023
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004024 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004025 * Used as an int extra field in {@link android.app.AlarmManager} intents
4026 * to tell the application being invoked how many pending alarms are being
4027 * delievered with the intent. For one-shot alarms this will always be 1.
4028 * For recurring alarms, this might be greater than 1 if the device was
4029 * asleep or powered off at the time an earlier alarm would have been
4030 * delivered.
4031 */
4032 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07004033
Jacek Surazski86b6c532009-05-13 14:38:28 +02004034 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004035 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4036 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004037 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4038 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004039 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4040 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4041 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004042 */
4043 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4044
4045 /**
4046 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4047 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004048 */
4049 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4050
4051 /**
4052 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4053 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004054 */
4055 public static final int EXTRA_DOCK_STATE_DESK = 1;
4056
4057 /**
4058 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4059 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004060 */
4061 public static final int EXTRA_DOCK_STATE_CAR = 2;
4062
4063 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004064 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4065 * to represent that the phone is in a analog (low end) dock.
4066 */
4067 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4068
4069 /**
4070 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4071 * to represent that the phone is in a digital (high end) dock.
4072 */
4073 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4074
4075 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004076 * Boolean that can be supplied as meta-data with a dock activity, to
4077 * indicate that the dock should take over the home key when it is active.
4078 */
4079 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004080
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004081 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004082 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4083 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004084 */
4085 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4086
4087 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004088 * Used in the extra field in the remote intent. It's astring token passed with the
4089 * remote intent.
4090 */
4091 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4092 "android.intent.extra.remote_intent_token";
4093
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004094 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004095 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004096 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004097 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004098 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004099 "android.intent.extra.changed_component_name";
4100
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004101 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004102 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004103 * and contains a string array of all of the components that have changed. If
4104 * the state of the overall package has changed, then it will contain an entry
4105 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004106 */
4107 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4108 "android.intent.extra.changed_component_name_list";
4109
4110 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004111 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004112 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004113 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4114 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4115 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004116 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004117 */
4118 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4119 "android.intent.extra.changed_package_list";
4120
4121 /**
4122 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004123 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4124 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004125 * and contains an integer array of uids of all of the components
4126 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004127 */
4128 public static final String EXTRA_CHANGED_UID_LIST =
4129 "android.intent.extra.changed_uid_list";
4130
4131 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004132 * @hide
4133 * Magic extra system code can use when binding, to give a label for
4134 * who it is that has bound to a service. This is an integer giving
4135 * a framework string resource that can be displayed to the user.
4136 */
4137 public static final String EXTRA_CLIENT_LABEL =
4138 "android.intent.extra.client_label";
4139
4140 /**
4141 * @hide
4142 * Magic extra system code can use when binding, to give a PendingIntent object
4143 * that can be launched for the user to disable the system's use of this
4144 * service.
4145 */
4146 public static final String EXTRA_CLIENT_INTENT =
4147 "android.intent.extra.client_intent";
4148
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004149 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004150 * Extra used to indicate that an intent should only return data that is on
4151 * the local device. This is a boolean extra; the default is false. If true,
4152 * an implementation should only allow the user to select data that is
4153 * already on the device, not requiring it be downloaded from a remote
4154 * service when opened.
4155 *
4156 * @see #ACTION_GET_CONTENT
4157 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004158 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004159 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004160 */
4161 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004162 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004163
Amith Yamasani13593602012-03-22 16:16:17 -07004164 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004165 * Extra used to indicate that an intent can allow the user to select and
4166 * return multiple items. This is a boolean extra; the default is false. If
4167 * true, an implementation is allowed to present the user with a UI where
4168 * they can pick multiple items that are all returned to the caller. When
4169 * this happens, they should be returned as the {@link #getClipData()} part
4170 * of the result Intent.
4171 *
4172 * @see #ACTION_GET_CONTENT
4173 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004174 */
4175 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004176 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004177
4178 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004179 * The integer userHandle carried with broadcast intents related to addition, removal and
4180 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4181 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4182 *
Amith Yamasani13593602012-03-22 16:16:17 -07004183 * @hide
4184 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004185 public static final String EXTRA_USER_HANDLE =
4186 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004187
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004188 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004189 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4190 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4191 */
4192 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004193 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004194
4195 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004196 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004197 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4198 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004199 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004200 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4201
4202 /**
4203 * Extra sent in the intent to the BroadcastReceiver that handles
4204 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4205 * the restrictions as key/value pairs.
4206 */
4207 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4208 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004209
Amith Yamasani86118ba2013-03-28 14:33:16 -07004210 /**
4211 * Extra used in the response from a BroadcastReceiver that handles
4212 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4213 */
4214 public static final String EXTRA_RESTRICTIONS_INTENT =
4215 "android.intent.extra.restrictions_intent";
4216
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004217 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004218 * Extra used to communicate a set of acceptable MIME types. The type of the
4219 * extra is {@code String[]}. Values may be a combination of concrete MIME
4220 * types (such as "image/png") and/or partial MIME types (such as
4221 * "audio/*").
4222 *
4223 * @see #ACTION_GET_CONTENT
4224 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004225 */
4226 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4227
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004228 /**
4229 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4230 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004231 * When this is true, hardware devices can use this information to determine that
4232 * they shouldn't do a complete shutdown of their device since this is not a
4233 * complete shutdown down to the kernel, but only user space restarting.
4234 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004235 */
4236 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4237 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4238
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004239 /**
Neil Fullerb7146fe2016-11-15 16:52:15 +00004240 * Optional int extra for {@link #ACTION_TIME_CHANGED} that indicates the
4241 * user has set their time format preference. See {@link #EXTRA_TIME_PREF_VALUE_USE_12_HOUR},
4242 * {@link #EXTRA_TIME_PREF_VALUE_USE_24_HOUR} and
4243 * {@link #EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT}. The value must not be negative.
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004244 *
4245 * @hide for internal use only.
4246 */
4247 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4248 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
Neil Fullerb7146fe2016-11-15 16:52:15 +00004249 /** @hide */
4250 public static final int EXTRA_TIME_PREF_VALUE_USE_12_HOUR = 0;
4251 /** @hide */
4252 public static final int EXTRA_TIME_PREF_VALUE_USE_24_HOUR = 1;
4253 /** @hide */
4254 public static final int EXTRA_TIME_PREF_VALUE_USE_LOCALE_DEFAULT = 2;
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004255
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004256 /** {@hide} */
4257 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4258
Rubin Xue8490f12015-06-25 12:17:48 +01004259 /** {@hide} */
4260 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4261
Santos Cordon15a13782015-03-31 18:32:31 -07004262 /**
4263 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4264 * activation request.
4265 * TODO: Add information about the structure and response data used with the pending intent.
4266 * @hide
4267 */
4268 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4269 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4270
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004271 /**
4272 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004273 *
4274 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004275 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004276 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4277
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004278 /**
4279 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004280 * When a profile goes into quiet mode, all apps in the profile are killed and the
4281 * profile user is stopped. Widgets originating from the profile are masked, and app
4282 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004283 */
4284 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004285
4286 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004287 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004288 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004289 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4290 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004291 *
4292 * @hide
4293 */
4294 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4295 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4296
4297 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004298 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4299 * whether to show the chooser or not when there is only one application available
4300 * to choose from.
4301 *
4302 * @hide
4303 */
4304 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4305 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4306
4307 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004308 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004309 * to represent that a video codec is allowed to use.
4310 *
4311 * @hide
4312 */
4313 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4314
4315 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004316 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004317 * to represent that a audio codec is allowed to use.
4318 *
4319 * @hide
4320 */
4321 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4322
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004323 // ---------------------------------------------------------------------
4324 // ---------------------------------------------------------------------
4325 // Intent flags (see mFlags variable).
4326
Tor Norbyed9273d62013-05-30 15:59:53 -07004327 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004328 @IntDef(flag = true, value = {
4329 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4330 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004331 @Retention(RetentionPolicy.SOURCE)
4332 public @interface GrantUriMode {}
4333
Jeff Sharkey846318a2014-04-04 12:12:41 -07004334 /** @hide */
4335 @IntDef(flag = true, value = {
4336 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4337 @Retention(RetentionPolicy.SOURCE)
4338 public @interface AccessUriMode {}
4339
4340 /**
4341 * Test if given mode flags specify an access mode, which must be at least
4342 * read and/or write.
4343 *
4344 * @hide
4345 */
4346 public static boolean isAccessUriMode(int modeFlags) {
4347 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4348 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4349 }
4350
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004351 /**
4352 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004353 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004354 * specified in its ClipData. When applying to an Intent's ClipData,
4355 * all URIs as well as recursive traversals through data or other ClipData
4356 * in Intent items will be granted; only the grant flags of the top-level
4357 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004358 */
4359 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4360 /**
4361 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004362 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004363 * specified in its ClipData. When applying to an Intent's ClipData,
4364 * all URIs as well as recursive traversals through data or other ClipData
4365 * in Intent items will be granted; only the grant flags of the top-level
4366 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004367 */
4368 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4369 /**
4370 * Can be set by the caller to indicate that this Intent is coming from
4371 * a background operation, not from direct user interaction.
4372 */
4373 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4374 /**
4375 * A flag you can enable for debugging: when set, log messages will be
4376 * printed during the resolution of this intent to show you what has
4377 * been found to create the final resolved list.
4378 */
4379 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004380 /**
4381 * If set, this intent will not match any components in packages that
4382 * are currently stopped. If this is not set, then the default behavior
4383 * is to include such applications in the result.
4384 */
4385 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4386 /**
4387 * If set, this intent will always match any components in packages that
4388 * are currently stopped. This is the default behavior when
4389 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4390 * flags are set, this one wins (it allows overriding of exclude for
4391 * places where the framework may automatically set the exclude flag).
4392 */
4393 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004394
4395 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004396 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004397 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004398 * persisted across device reboots until explicitly revoked with
4399 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4400 * grant for possible persisting; the receiving application must call
4401 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4402 * actually persist.
4403 *
4404 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4405 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4406 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004407 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004408 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004409 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004410
4411 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004412 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4413 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4414 * applies to any URI that is a prefix match against the original granted
4415 * URI. (Without this flag, the URI must match exactly for access to be
4416 * granted.) Another URI is considered a prefix match only when scheme,
4417 * authority, and all path segments defined by the prefix are an exact
4418 * match.
4419 */
4420 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4421
4422 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004423 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004424 * homework and verified that they correctly handle packages and components
4425 * that come and go over time. In particular:
4426 * <ul>
4427 * <li>Apps installed on external storage, which will appear to be
4428 * uninstalled while the the device is ejected.
4429 * <li>Apps with encryption unaware components, which will appear to not
4430 * exist while the device is locked.
4431 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004432 *
4433 * @hide
4434 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004435 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004436
4437 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004438 * Internal flag used to indicate ephemeral applications should not be
4439 * considered when resolving the intent.
4440 *
4441 * @hide
4442 */
4443 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4444
4445 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004446 * If set, the new activity is not kept in the history stack. As soon as
4447 * the user navigates away from it, the activity is finished. This may also
4448 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4449 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004450 *
4451 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4452 * is never invoked when the current activity starts a new activity which
4453 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004454 */
4455 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4456 /**
4457 * If set, the activity will not be launched if it is already running
4458 * at the top of the history stack.
4459 */
4460 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4461 /**
4462 * If set, this activity will become the start of a new task on this
4463 * history stack. A task (from the activity that started it to the
4464 * next task activity) defines an atomic group of activities that the
4465 * user can move to. Tasks can be moved to the foreground and background;
4466 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004467 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004468 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4469 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004470 *
4471 * <p>This flag is generally used by activities that want
4472 * to present a "launcher" style behavior: they give the user a list of
4473 * separate things that can be done, which otherwise run completely
4474 * independently of the activity launching them.
4475 *
4476 * <p>When using this flag, if a task is already running for the activity
4477 * you are now starting, then a new activity will not be started; instead,
4478 * the current task will simply be brought to the front of the screen with
4479 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4480 * to disable this behavior.
4481 *
4482 * <p>This flag can not be used when the caller is requesting a result from
4483 * the activity being launched.
4484 */
4485 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4486 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004487 * This flag is used to create a new task and launch an activity into it.
4488 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4489 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4490 * search through existing tasks for ones matching this Intent. Only if no such
4491 * task is found would a new task be created. When paired with
4492 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4493 * the search for a matching task and unconditionally start a new task.
4494 *
4495 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4496 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004497 * top-level application launcher.</strong> Used in conjunction with
4498 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4499 * behavior of bringing an existing task to the foreground. When set,
4500 * a new task is <em>always</em> started to host the Activity for the
4501 * Intent, regardless of whether there is already an existing task running
4502 * the same thing.
4503 *
4504 * <p><strong>Because the default system does not include graphical task management,
4505 * you should not use this flag unless you provide some way for a user to
4506 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004507 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004508 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4509 * creating new document tasks.
4510 *
4511 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004512 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004513 *
Scott Main7aee61f2011-02-08 11:25:01 -08004514 * <p>See
4515 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4516 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004517 *
4518 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4519 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004520 */
4521 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4522 /**
4523 * If set, and the activity being launched is already running in the
4524 * current task, then instead of launching a new instance of that activity,
4525 * all of the other activities on top of it will be closed and this Intent
4526 * will be delivered to the (now on top) old activity as a new Intent.
4527 *
4528 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4529 * If D calls startActivity() with an Intent that resolves to the component
4530 * of activity B, then C and D will be finished and B receive the given
4531 * Intent, resulting in the stack now being: A, B.
4532 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004533 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004534 * either receive the new intent you are starting here in its
4535 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004536 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004537 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4538 * the same intent, then it will be finished and re-created; for all other
4539 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4540 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004541 *
4542 * <p>This launch mode can also be used to good effect in conjunction with
4543 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4544 * of a task, it will bring any currently running instance of that task
4545 * to the foreground, and then clear it to its root state. This is
4546 * especially useful, for example, when launching an activity from the
4547 * notification manager.
4548 *
Scott Main7aee61f2011-02-08 11:25:01 -08004549 * <p>See
4550 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4551 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004552 */
4553 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4554 /**
4555 * If set and this intent is being used to launch a new activity from an
4556 * existing one, then the reply target of the existing activity will be
4557 * transfered to the new activity. This way the new activity can call
4558 * {@link android.app.Activity#setResult} and have that result sent back to
4559 * the reply target of the original activity.
4560 */
4561 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4562 /**
4563 * If set and this intent is being used to launch a new activity from an
4564 * existing one, the current activity will not be counted as the top
4565 * activity for deciding whether the new intent should be delivered to
4566 * the top instead of starting a new one. The previous activity will
4567 * be used as the top, with the assumption being that the current activity
4568 * will finish itself immediately.
4569 */
4570 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4571 /**
4572 * If set, the new activity is not kept in the list of recently launched
4573 * activities.
4574 */
4575 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4576 /**
4577 * This flag is not normally set by application code, but set for you by
4578 * the system as described in the
4579 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4580 * launchMode} documentation for the singleTask mode.
4581 */
4582 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4583 /**
4584 * If set, and this activity is either being started in a new task or
4585 * bringing to the top an existing task, then it will be launched as
4586 * the front door of the task. This will result in the application of
4587 * any affinities needed to have that task in the proper state (either
4588 * moving activities to or from it), or simply resetting that task to
4589 * its initial state if needed.
4590 */
4591 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4592 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004593 * This flag is not normally set by application code, but set for you by
4594 * the system if this activity is being launched from history
4595 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004596 */
4597 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004598 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004599 * @deprecated As of API 21 this performs identically to
4600 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004601 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004602 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004603 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004604 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004605 * This flag is used to open a document into a new task rooted at the activity launched
4606 * by this Intent. Through the use of this flag, or its equivalent attribute,
4607 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004608 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004609 *
Craig Mautner026596b2014-05-21 15:35:44 -07004610 * <p>The use of the activity attribute form of this,
4611 * {@link android.R.attr#documentLaunchMode}, is
4612 * preferred over the Intent flag described here. The attribute form allows the
4613 * Activity to specify multiple document behavior for all launchers of the Activity
4614 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004615 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004616 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4617 * it is kept after the activity is finished is different than the use of
4618 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4619 * this flag is being used to create a new recents entry, then by default that entry
4620 * will be removed once the activity is finished. You can modify this behavior with
4621 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4622 *
Craig Mautner026596b2014-05-21 15:35:44 -07004623 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4624 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4625 * equivalent of the Activity manifest specifying {@link
4626 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4627 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4628 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004629 *
Craig Mautner026596b2014-05-21 15:35:44 -07004630 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004631 *
Craig Mautner026596b2014-05-21 15:35:44 -07004632 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004633 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4634 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004635 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004636 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004637 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004638 * callback from occurring on the current frontmost activity before it is
4639 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004640 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004641 * <p>Typically, an activity can rely on that callback to indicate that an
4642 * explicit user action has caused their activity to be moved out of the
4643 * foreground. The callback marks an appropriate point in the activity's
4644 * lifecycle for it to dismiss any notifications that it intends to display
4645 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004646 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004647 * <p>If an activity is ever started via any non-user-driven events such as
4648 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4649 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004650 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004651 */
4652 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004653 /**
4654 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4655 * this flag will cause the launched activity to be brought to the front of its
4656 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004657 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004658 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4659 * If D calls startActivity() with an Intent that resolves to the component
4660 * of activity B, then B will be brought to the front of the history stack,
4661 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004662 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004663 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004664 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004665 */
4666 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004667 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004668 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4669 * this flag will prevent the system from applying an activity transition
4670 * animation to go to the next activity state. This doesn't mean an
4671 * animation will never run -- if another activity change happens that doesn't
4672 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004673 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004674 * when you are going to do a series of activity operations but the
4675 * animation seen by the user shouldn't be driven by the first activity
4676 * change but rather a later one.
4677 */
4678 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4679 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004680 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4681 * this flag will cause any existing task that would be associated with the
4682 * activity to be cleared before the activity is started. That is, the activity
4683 * becomes the new root of an otherwise empty task, and any old activities
4684 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4685 */
4686 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4687 /**
4688 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4689 * this flag will cause a newly launching task to be placed on top of the current
4690 * home activity task (if there is one). That is, pressing back from the task
4691 * will always return the user to home even if that was not the last activity they
4692 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4693 */
4694 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4695 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004696 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4697 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004698 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004699 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004700 * this flag. When set and the task's activity is finished, the recents
4701 * entry will remain in the interface for the user to re-launch it, like a
4702 * recents entry for a top-level application.
4703 * <p>
4704 * The receiving activity can override this request with
4705 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4706 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004707 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004708 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004709 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004710
4711 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004712 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4713 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004714 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4715 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004716 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004717 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004718
4719 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004720 * If set, when sending a broadcast only registered receivers will be
4721 * called -- no BroadcastReceiver components will be launched.
4722 */
4723 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004724 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004725 * If set, when sending a broadcast the new broadcast will replace
4726 * any existing pending broadcast that matches it. Matching is defined
4727 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4728 * true for the intents of the two broadcasts. When a match is found,
4729 * the new broadcast (and receivers associated with it) will replace the
4730 * existing one in the pending broadcast list, remaining at the same
4731 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004732 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004733 * <p>This flag is most typically used with sticky broadcasts, which
4734 * only care about delivering the most recent values of the broadcast
4735 * to their receivers.
4736 */
4737 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4738 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004739 * If set, when sending a broadcast the recipient is allowed to run at
4740 * foreground priority, with a shorter timeout interval. During normal
4741 * broadcasts the receivers are not automatically hoisted out of the
4742 * background priority class.
4743 */
4744 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4745 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004746 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4747 * They can still propagate results through to later receivers, but they can not prevent
4748 * later receivers from seeing the broadcast.
4749 */
4750 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4751 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004752 * If set, when sending a broadcast <i>before boot has completed</i> only
4753 * registered receivers will be called -- no BroadcastReceiver components
4754 * will be launched. Sticky intent state will be recorded properly even
4755 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4756 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004757 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004758 * <p>This flag is only for use by system sevices as a convenience to
4759 * avoid having to implement a more complex mechanism around detection
4760 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004761 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004762 * @hide
4763 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004764 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004765 /**
4766 * Set when this broadcast is for a boot upgrade, a special mode that
4767 * allows the broadcast to be sent before the system is ready and launches
4768 * the app process with no providers running in it.
4769 * @hide
4770 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004771 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004772 /**
4773 * If set, the broadcast will always go to manifest receivers in background (cached
4774 * or not running) apps, regardless of whether that would be done by default. By
4775 * default they will only receive broadcasts if the broadcast has specified an
4776 * explicit component or package name.
4777 * @hide
4778 */
4779 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4780 /**
4781 * If set, the broadcast will never go to manifest receivers in background (cached
4782 * or not running) apps, regardless of whether that would be done by default. By
4783 * default they will receive broadcasts if the broadcast has specified an
4784 * explicit component or package name.
4785 * @hide
4786 */
4787 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004788
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004789 /**
4790 * @hide Flags that can't be changed with PendingIntent.
4791 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004792 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4793 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4794 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004795
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004796 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004797 // ---------------------------------------------------------------------
4798 // toUri() and parseUri() options.
4799
4800 /**
4801 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4802 * always has the "intent:" scheme. This syntax can be used when you want
4803 * to later disambiguate between URIs that are intended to describe an
4804 * Intent vs. all others that should be treated as raw URIs. When used
4805 * with {@link #parseUri}, any other scheme will result in a generic
4806 * VIEW action for that raw URI.
4807 */
4808 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004809
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004810 /**
4811 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4812 * always has the "android-app:" scheme. This is a variation of
4813 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4814 * http/https URI being delivered to a specific package name. The format
4815 * is:
4816 *
4817 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004818 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004819 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004820 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4821 * you must also include a scheme; including a path also requires both a host and a scheme.
4822 * The final #Intent; fragment can be used without a scheme, host, or path.
4823 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004824 * used with intents that have a {@link #setSelector}, since the base intent
4825 * will always have an explicit package name.</p>
4826 *
4827 * <p>Some examples of how this scheme maps to Intent objects:</p>
4828 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4829 * <colgroup align="left" />
4830 * <colgroup align="left" />
4831 * <thead>
4832 * <tr><th>URI</th> <th>Intent</th></tr>
4833 * </thead>
4834 *
4835 * <tbody>
4836 * <tr><td><code>android-app://com.example.app</code></td>
4837 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4838 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4839 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4840 * </table></td>
4841 * </tr>
4842 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4843 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4844 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4845 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4846 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4847 * </table></td>
4848 * </tr>
4849 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4850 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4851 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4852 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4853 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4854 * </table></td>
4855 * </tr>
4856 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4857 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4858 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4859 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4860 * </table></td>
4861 * </tr>
4862 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4863 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4864 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4865 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4866 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4867 * </table></td>
4868 * </tr>
4869 * <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>
4870 * <td><table border="" style="margin:0" >
4871 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4872 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4873 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4874 * </table></td>
4875 * </tr>
4876 * </tbody>
4877 * </table>
4878 */
4879 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4880
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004881 /**
4882 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4883 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4884 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4885 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4886 * generated Intent can not cause unexpected data access to happen.
4887 *
4888 * <p>If you do not trust the source of the URI being parsed, you should still do further
4889 * processing to protect yourself from it. In particular, when using it to start an
4890 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4891 * that can handle it.</p>
4892 */
4893 public static final int URI_ALLOW_UNSAFE = 1<<2;
4894
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004895 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004896
4897 private String mAction;
4898 private Uri mData;
4899 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004900 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004901 private ComponentName mComponent;
4902 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004903 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004904 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004905 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004906 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004907 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004908 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004909
4910 // ---------------------------------------------------------------------
4911
4912 /**
4913 * Create an empty intent.
4914 */
4915 public Intent() {
4916 }
4917
4918 /**
4919 * Copy constructor.
4920 */
4921 public Intent(Intent o) {
4922 this.mAction = o.mAction;
4923 this.mData = o.mData;
4924 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004925 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004926 this.mComponent = o.mComponent;
4927 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004928 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004929 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004930 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004931 }
4932 if (o.mExtras != null) {
4933 this.mExtras = new Bundle(o.mExtras);
4934 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004935 if (o.mSourceBounds != null) {
4936 this.mSourceBounds = new Rect(o.mSourceBounds);
4937 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004938 if (o.mSelector != null) {
4939 this.mSelector = new Intent(o.mSelector);
4940 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004941 if (o.mClipData != null) {
4942 this.mClipData = new ClipData(o.mClipData);
4943 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004944 }
4945
4946 @Override
4947 public Object clone() {
4948 return new Intent(this);
4949 }
4950
4951 private Intent(Intent o, boolean all) {
4952 this.mAction = o.mAction;
4953 this.mData = o.mData;
4954 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004955 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004956 this.mComponent = o.mComponent;
4957 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004958 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004959 }
4960 }
4961
4962 /**
4963 * Make a clone of only the parts of the Intent that are relevant for
4964 * filter matching: the action, data, type, component, and categories.
4965 */
4966 public Intent cloneFilter() {
4967 return new Intent(this, false);
4968 }
4969
4970 /**
4971 * Create an intent with a given action. All other fields (data, type,
4972 * class) are null. Note that the action <em>must</em> be in a
4973 * namespace because Intents are used globally in the system -- for
4974 * example the system VIEW action is android.intent.action.VIEW; an
4975 * application's custom action would be something like
4976 * com.google.app.myapp.CUSTOM_ACTION.
4977 *
4978 * @param action The Intent action, such as ACTION_VIEW.
4979 */
4980 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004981 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004982 }
4983
4984 /**
4985 * Create an intent with a given action and for a given data url. Note
4986 * that the action <em>must</em> be in a namespace because Intents are
4987 * used globally in the system -- for example the system VIEW action is
4988 * android.intent.action.VIEW; an application's custom action would be
4989 * something like com.google.app.myapp.CUSTOM_ACTION.
4990 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004991 * <p><em>Note: scheme and host name matching in the Android framework is
4992 * case-sensitive, unlike the formal RFC. As a result,
4993 * you should always ensure that you write your Uri with these elements
4994 * using lower case letters, and normalize any Uris you receive from
4995 * outside of Android to ensure the scheme and host is lower case.</em></p>
4996 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004997 * @param action The Intent action, such as ACTION_VIEW.
4998 * @param uri The Intent data URI.
4999 */
5000 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005001 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005002 mData = uri;
5003 }
5004
5005 /**
5006 * Create an intent for a specific component. All other fields (action, data,
5007 * type, class) are null, though they can be modified later with explicit
5008 * calls. This provides a convenient way to create an intent that is
5009 * intended to execute a hard-coded class name, rather than relying on the
5010 * system to find an appropriate class for you; see {@link #setComponent}
5011 * for more information on the repercussions of this.
5012 *
5013 * @param packageContext A Context of the application package implementing
5014 * this class.
5015 * @param cls The component class that is to be used for the intent.
5016 *
5017 * @see #setClass
5018 * @see #setComponent
5019 * @see #Intent(String, android.net.Uri , Context, Class)
5020 */
5021 public Intent(Context packageContext, Class<?> cls) {
5022 mComponent = new ComponentName(packageContext, cls);
5023 }
5024
5025 /**
5026 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07005027 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005028 * construct the Intent and then calling {@link #setClass} to set its
5029 * class.
5030 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005031 * <p><em>Note: scheme and host name matching in the Android framework is
5032 * case-sensitive, unlike the formal RFC. As a result,
5033 * you should always ensure that you write your Uri with these elements
5034 * using lower case letters, and normalize any Uris you receive from
5035 * outside of Android to ensure the scheme and host is lower case.</em></p>
5036 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005037 * @param action The Intent action, such as ACTION_VIEW.
5038 * @param uri The Intent data URI.
5039 * @param packageContext A Context of the application package implementing
5040 * this class.
5041 * @param cls The component class that is to be used for the intent.
5042 *
5043 * @see #Intent(String, android.net.Uri)
5044 * @see #Intent(Context, Class)
5045 * @see #setClass
5046 * @see #setComponent
5047 */
5048 public Intent(String action, Uri uri,
5049 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005050 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005051 mData = uri;
5052 mComponent = new ComponentName(packageContext, cls);
5053 }
5054
5055 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005056 * Create an intent to launch the main (root) activity of a task. This
5057 * is the Intent that is started when the application's is launched from
5058 * Home. For anything else that wants to launch an application in the
5059 * same way, it is important that they use an Intent structured the same
5060 * way, and can use this function to ensure this is the case.
5061 *
5062 * <p>The returned Intent has the given Activity component as its explicit
5063 * component, {@link #ACTION_MAIN} as its action, and includes the
5064 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5065 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5066 * to do that through {@link #addFlags(int)} on the returned Intent.
5067 *
5068 * @param mainActivity The main activity component that this Intent will
5069 * launch.
5070 * @return Returns a newly created Intent that can be used to launch the
5071 * activity as a main application entry.
5072 *
5073 * @see #setClass
5074 * @see #setComponent
5075 */
5076 public static Intent makeMainActivity(ComponentName mainActivity) {
5077 Intent intent = new Intent(ACTION_MAIN);
5078 intent.setComponent(mainActivity);
5079 intent.addCategory(CATEGORY_LAUNCHER);
5080 return intent;
5081 }
5082
5083 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005084 * Make an Intent for the main activity of an application, without
5085 * specifying a specific activity to run but giving a selector to find
5086 * the activity. This results in a final Intent that is structured
5087 * the same as when the application is launched from
5088 * Home. For anything else that wants to launch an application in the
5089 * same way, it is important that they use an Intent structured the same
5090 * way, and can use this function to ensure this is the case.
5091 *
5092 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5093 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5094 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5095 * to do that through {@link #addFlags(int)} on the returned Intent.
5096 *
5097 * @param selectorAction The action name of the Intent's selector.
5098 * @param selectorCategory The name of a category to add to the Intent's
5099 * selector.
5100 * @return Returns a newly created Intent that can be used to launch the
5101 * activity as a main application entry.
5102 *
5103 * @see #setSelector(Intent)
5104 */
5105 public static Intent makeMainSelectorActivity(String selectorAction,
5106 String selectorCategory) {
5107 Intent intent = new Intent(ACTION_MAIN);
5108 intent.addCategory(CATEGORY_LAUNCHER);
5109 Intent selector = new Intent();
5110 selector.setAction(selectorAction);
5111 selector.addCategory(selectorCategory);
5112 intent.setSelector(selector);
5113 return intent;
5114 }
5115
5116 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005117 * Make an Intent that can be used to re-launch an application's task
5118 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5119 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5120 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5121 *
5122 * @param mainActivity The activity component that is the root of the
5123 * task; this is the activity that has been published in the application's
5124 * manifest as the main launcher icon.
5125 *
5126 * @return Returns a newly created Intent that can be used to relaunch the
5127 * activity's task in its root state.
5128 */
5129 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5130 Intent intent = makeMainActivity(mainActivity);
5131 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5132 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5133 return intent;
5134 }
5135
5136 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005137 * Call {@link #parseUri} with 0 flags.
5138 * @deprecated Use {@link #parseUri} instead.
5139 */
5140 @Deprecated
5141 public static Intent getIntent(String uri) throws URISyntaxException {
5142 return parseUri(uri, 0);
5143 }
Tom Taylord4a47292009-12-21 13:59:18 -08005144
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005145 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005146 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005147 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005148 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005149 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005150 *
5151 * <p>The URI given here must not be relative -- that is, it must include
5152 * the scheme and full path.
5153 *
5154 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005155 * @param flags Additional processing flags. Either 0,
5156 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005157 *
5158 * @return Intent The newly created Intent object.
5159 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005160 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5161 * it bad (as parsed by the Uri class) or the Intent data within the
5162 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005163 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005164 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005165 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005166 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005167 int i = 0;
5168 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005169 final boolean androidApp = uri.startsWith("android-app:");
5170
5171 // Validate intent scheme if requested.
5172 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5173 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005174 Intent intent = new Intent(ACTION_VIEW);
5175 try {
5176 intent.setData(Uri.parse(uri));
5177 } catch (IllegalArgumentException e) {
5178 throw new URISyntaxException(uri, e.getMessage());
5179 }
5180 return intent;
5181 }
5182 }
Tom Taylord4a47292009-12-21 13:59:18 -08005183
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005184 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005185 // simple case
5186 if (i == -1) {
5187 if (!androidApp) {
5188 return new Intent(ACTION_VIEW, Uri.parse(uri));
5189 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005190
5191 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005192 } else if (!uri.startsWith("#Intent;", i)) {
5193 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005194 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005195 } else {
5196 i = -1;
5197 }
5198 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005199
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005200 // new format
5201 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005202 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005203 boolean explicitAction = false;
5204 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005205
5206 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005207 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005208 String data;
5209 if (i >= 0) {
5210 data = uri.substring(0, i);
5211 i += 8; // length of "#Intent;"
5212 } else {
5213 data = uri;
5214 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005215
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005216 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005217 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005218 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005219 if (eq < 0) eq = i-1;
5220 int semi = uri.indexOf(';', i);
5221 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005222
5223 // action
5224 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005225 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005226 if (!inSelector) {
5227 explicitAction = true;
5228 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005229 }
5230
5231 // categories
5232 else if (uri.startsWith("category=", i)) {
5233 intent.addCategory(value);
5234 }
5235
5236 // type
5237 else if (uri.startsWith("type=", i)) {
5238 intent.mType = value;
5239 }
5240
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005241 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005242 else if (uri.startsWith("launchFlags=", i)) {
5243 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005244 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5245 intent.mFlags &= ~IMMUTABLE_FLAGS;
5246 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005247 }
5248
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005249 // package
5250 else if (uri.startsWith("package=", i)) {
5251 intent.mPackage = value;
5252 }
5253
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005254 // component
5255 else if (uri.startsWith("component=", i)) {
5256 intent.mComponent = ComponentName.unflattenFromString(value);
5257 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005258
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005259 // scheme
5260 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005261 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005262 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005263 } else {
5264 scheme = value;
5265 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005266 }
5267
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005268 // source bounds
5269 else if (uri.startsWith("sourceBounds=", i)) {
5270 intent.mSourceBounds = Rect.unflattenFromString(value);
5271 }
5272
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005273 // selector
5274 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5275 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005276 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005277 }
5278
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005279 // extra
5280 else {
5281 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005282 // create Bundle if it doesn't already exist
5283 if (intent.mExtras == null) intent.mExtras = new Bundle();
5284 Bundle b = intent.mExtras;
5285 // add EXTRA
5286 if (uri.startsWith("S.", i)) b.putString(key, value);
5287 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5288 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5289 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5290 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5291 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5292 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5293 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5294 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5295 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5296 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005297
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005298 // move to the next item
5299 i = semi + 1;
5300 }
5301
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005302 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005303 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005304 if (baseIntent.mPackage == null) {
5305 baseIntent.setSelector(intent);
5306 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005307 intent = baseIntent;
5308 }
5309
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005310 if (data != null) {
5311 if (data.startsWith("intent:")) {
5312 data = data.substring(7);
5313 if (scheme != null) {
5314 data = scheme + ':' + data;
5315 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005316 } else if (data.startsWith("android-app:")) {
5317 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5318 // Correctly formed android-app, first part is package name.
5319 int end = data.indexOf('/', 14);
5320 if (end < 0) {
5321 // All we have is a package name.
5322 intent.mPackage = data.substring(14);
5323 if (!explicitAction) {
5324 intent.setAction(ACTION_MAIN);
5325 }
5326 data = "";
5327 } else {
5328 // Target the Intent at the given package name always.
5329 String authority = null;
5330 intent.mPackage = data.substring(14, end);
5331 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005332 if ((end+1) < data.length()) {
5333 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5334 // Found a scheme, remember it.
5335 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005336 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005337 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5338 // Found a authority, remember it.
5339 authority = data.substring(end+1, newEnd);
5340 end = newEnd;
5341 }
5342 } else {
5343 // All we have is a scheme.
5344 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005345 }
5346 }
5347 if (scheme == null) {
5348 // If there was no scheme, then this just targets the package.
5349 if (!explicitAction) {
5350 intent.setAction(ACTION_MAIN);
5351 }
5352 data = "";
5353 } else if (authority == null) {
5354 data = scheme + ":";
5355 } else {
5356 data = scheme + "://" + authority + data.substring(end);
5357 }
5358 }
5359 } else {
5360 data = "";
5361 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005362 }
Tom Taylord4a47292009-12-21 13:59:18 -08005363
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005364 if (data.length() > 0) {
5365 try {
5366 intent.mData = Uri.parse(data);
5367 } catch (IllegalArgumentException e) {
5368 throw new URISyntaxException(uri, e.getMessage());
5369 }
5370 }
5371 }
Tom Taylord4a47292009-12-21 13:59:18 -08005372
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005373 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005374
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005375 } catch (IndexOutOfBoundsException e) {
5376 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5377 }
5378 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005379
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005380 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005381 return getIntentOld(uri, 0);
5382 }
5383
5384 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005385 Intent intent;
5386
5387 int i = uri.lastIndexOf('#');
5388 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005389 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005390 final int intentFragmentStart = i;
5391 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005392
5393 i++;
5394
5395 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005396 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005397 i += 7;
5398 int j = uri.indexOf(')', i);
5399 action = uri.substring(i, j);
5400 i = j + 1;
5401 }
5402
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005403 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005404
5405 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005406 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005407 i += 11;
5408 int j = uri.indexOf(')', i);
5409 while (i < j) {
5410 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005411 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005412 if (i < sep) {
5413 intent.addCategory(uri.substring(i, sep));
5414 }
5415 i = sep + 1;
5416 }
5417 i = j + 1;
5418 }
5419
5420 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005421 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005422 i += 5;
5423 int j = uri.indexOf(')', i);
5424 intent.mType = uri.substring(i, j);
5425 i = j + 1;
5426 }
5427
5428 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005429 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005430 i += 12;
5431 int j = uri.indexOf(')', i);
5432 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005433 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5434 intent.mFlags &= ~IMMUTABLE_FLAGS;
5435 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005436 i = j + 1;
5437 }
5438
5439 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005440 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005441 i += 10;
5442 int j = uri.indexOf(')', i);
5443 int sep = uri.indexOf('!', i);
5444 if (sep >= 0 && sep < j) {
5445 String pkg = uri.substring(i, sep);
5446 String cls = uri.substring(sep + 1, j);
5447 intent.mComponent = new ComponentName(pkg, cls);
5448 }
5449 i = j + 1;
5450 }
5451
5452 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005453 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005454 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005455
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005456 final int closeParen = uri.indexOf(')', i);
5457 if (closeParen == -1) throw new URISyntaxException(uri,
5458 "EXTRA missing trailing ')'", i);
5459
5460 while (i < closeParen) {
5461 // fetch the key value
5462 int j = uri.indexOf('=', i);
5463 if (j <= i + 1 || i >= closeParen) {
5464 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5465 }
5466 char type = uri.charAt(i);
5467 i++;
5468 String key = uri.substring(i, j);
5469 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005470
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005471 // get type-value
5472 j = uri.indexOf('!', i);
5473 if (j == -1 || j >= closeParen) j = closeParen;
5474 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5475 String value = uri.substring(i, j);
5476 i = j;
5477
5478 // create Bundle if it doesn't already exist
5479 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005480
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005481 // add item to bundle
5482 try {
5483 switch (type) {
5484 case 'S':
5485 intent.mExtras.putString(key, Uri.decode(value));
5486 break;
5487 case 'B':
5488 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5489 break;
5490 case 'b':
5491 intent.mExtras.putByte(key, Byte.parseByte(value));
5492 break;
5493 case 'c':
5494 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5495 break;
5496 case 'd':
5497 intent.mExtras.putDouble(key, Double.parseDouble(value));
5498 break;
5499 case 'f':
5500 intent.mExtras.putFloat(key, Float.parseFloat(value));
5501 break;
5502 case 'i':
5503 intent.mExtras.putInt(key, Integer.parseInt(value));
5504 break;
5505 case 'l':
5506 intent.mExtras.putLong(key, Long.parseLong(value));
5507 break;
5508 case 's':
5509 intent.mExtras.putShort(key, Short.parseShort(value));
5510 break;
5511 default:
5512 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5513 }
5514 } catch (NumberFormatException e) {
5515 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5516 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005517
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005518 char ch = uri.charAt(i);
5519 if (ch == ')') break;
5520 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5521 i++;
5522 }
5523 }
5524
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005525 if (isIntentFragment) {
5526 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5527 } else {
5528 intent.mData = Uri.parse(uri);
5529 }
Tom Taylord4a47292009-12-21 13:59:18 -08005530
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005531 if (intent.mAction == null) {
5532 // By default, if no action is specified, then use VIEW.
5533 intent.mAction = ACTION_VIEW;
5534 }
5535
5536 } else {
5537 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5538 }
5539
5540 return intent;
5541 }
5542
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005543 /** @hide */
5544 public interface CommandOptionHandler {
5545 boolean handleOption(String opt, ShellCommand cmd);
5546 }
5547
5548 /** @hide */
5549 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5550 throws URISyntaxException {
5551 Intent intent = new Intent();
5552 Intent baseIntent = intent;
5553 boolean hasIntentInfo = false;
5554
5555 Uri data = null;
5556 String type = null;
5557
5558 String opt;
5559 while ((opt=cmd.getNextOption()) != null) {
5560 switch (opt) {
5561 case "-a":
5562 intent.setAction(cmd.getNextArgRequired());
5563 if (intent == baseIntent) {
5564 hasIntentInfo = true;
5565 }
5566 break;
5567 case "-d":
5568 data = Uri.parse(cmd.getNextArgRequired());
5569 if (intent == baseIntent) {
5570 hasIntentInfo = true;
5571 }
5572 break;
5573 case "-t":
5574 type = cmd.getNextArgRequired();
5575 if (intent == baseIntent) {
5576 hasIntentInfo = true;
5577 }
5578 break;
5579 case "-c":
5580 intent.addCategory(cmd.getNextArgRequired());
5581 if (intent == baseIntent) {
5582 hasIntentInfo = true;
5583 }
5584 break;
5585 case "-e":
5586 case "--es": {
5587 String key = cmd.getNextArgRequired();
5588 String value = cmd.getNextArgRequired();
5589 intent.putExtra(key, value);
5590 }
5591 break;
5592 case "--esn": {
5593 String key = cmd.getNextArgRequired();
5594 intent.putExtra(key, (String) null);
5595 }
5596 break;
5597 case "--ei": {
5598 String key = cmd.getNextArgRequired();
5599 String value = cmd.getNextArgRequired();
5600 intent.putExtra(key, Integer.decode(value));
5601 }
5602 break;
5603 case "--eu": {
5604 String key = cmd.getNextArgRequired();
5605 String value = cmd.getNextArgRequired();
5606 intent.putExtra(key, Uri.parse(value));
5607 }
5608 break;
5609 case "--ecn": {
5610 String key = cmd.getNextArgRequired();
5611 String value = cmd.getNextArgRequired();
5612 ComponentName cn = ComponentName.unflattenFromString(value);
5613 if (cn == null)
5614 throw new IllegalArgumentException("Bad component name: " + value);
5615 intent.putExtra(key, cn);
5616 }
5617 break;
5618 case "--eia": {
5619 String key = cmd.getNextArgRequired();
5620 String value = cmd.getNextArgRequired();
5621 String[] strings = value.split(",");
5622 int[] list = new int[strings.length];
5623 for (int i = 0; i < strings.length; i++) {
5624 list[i] = Integer.decode(strings[i]);
5625 }
5626 intent.putExtra(key, list);
5627 }
5628 break;
5629 case "--eial": {
5630 String key = cmd.getNextArgRequired();
5631 String value = cmd.getNextArgRequired();
5632 String[] strings = value.split(",");
5633 ArrayList<Integer> list = new ArrayList<>(strings.length);
5634 for (int i = 0; i < strings.length; i++) {
5635 list.add(Integer.decode(strings[i]));
5636 }
5637 intent.putExtra(key, list);
5638 }
5639 break;
5640 case "--el": {
5641 String key = cmd.getNextArgRequired();
5642 String value = cmd.getNextArgRequired();
5643 intent.putExtra(key, Long.valueOf(value));
5644 }
5645 break;
5646 case "--ela": {
5647 String key = cmd.getNextArgRequired();
5648 String value = cmd.getNextArgRequired();
5649 String[] strings = value.split(",");
5650 long[] list = new long[strings.length];
5651 for (int i = 0; i < strings.length; i++) {
5652 list[i] = Long.valueOf(strings[i]);
5653 }
5654 intent.putExtra(key, list);
5655 hasIntentInfo = true;
5656 }
5657 break;
5658 case "--elal": {
5659 String key = cmd.getNextArgRequired();
5660 String value = cmd.getNextArgRequired();
5661 String[] strings = value.split(",");
5662 ArrayList<Long> list = new ArrayList<>(strings.length);
5663 for (int i = 0; i < strings.length; i++) {
5664 list.add(Long.valueOf(strings[i]));
5665 }
5666 intent.putExtra(key, list);
5667 hasIntentInfo = true;
5668 }
5669 break;
5670 case "--ef": {
5671 String key = cmd.getNextArgRequired();
5672 String value = cmd.getNextArgRequired();
5673 intent.putExtra(key, Float.valueOf(value));
5674 hasIntentInfo = true;
5675 }
5676 break;
5677 case "--efa": {
5678 String key = cmd.getNextArgRequired();
5679 String value = cmd.getNextArgRequired();
5680 String[] strings = value.split(",");
5681 float[] list = new float[strings.length];
5682 for (int i = 0; i < strings.length; i++) {
5683 list[i] = Float.valueOf(strings[i]);
5684 }
5685 intent.putExtra(key, list);
5686 hasIntentInfo = true;
5687 }
5688 break;
5689 case "--efal": {
5690 String key = cmd.getNextArgRequired();
5691 String value = cmd.getNextArgRequired();
5692 String[] strings = value.split(",");
5693 ArrayList<Float> list = new ArrayList<>(strings.length);
5694 for (int i = 0; i < strings.length; i++) {
5695 list.add(Float.valueOf(strings[i]));
5696 }
5697 intent.putExtra(key, list);
5698 hasIntentInfo = true;
5699 }
5700 break;
5701 case "--esa": {
5702 String key = cmd.getNextArgRequired();
5703 String value = cmd.getNextArgRequired();
5704 // Split on commas unless they are preceeded by an escape.
5705 // The escape character must be escaped for the string and
5706 // again for the regex, thus four escape characters become one.
5707 String[] strings = value.split("(?<!\\\\),");
5708 intent.putExtra(key, strings);
5709 hasIntentInfo = true;
5710 }
5711 break;
5712 case "--esal": {
5713 String key = cmd.getNextArgRequired();
5714 String value = cmd.getNextArgRequired();
5715 // Split on commas unless they are preceeded by an escape.
5716 // The escape character must be escaped for the string and
5717 // again for the regex, thus four escape characters become one.
5718 String[] strings = value.split("(?<!\\\\),");
5719 ArrayList<String> list = new ArrayList<>(strings.length);
5720 for (int i = 0; i < strings.length; i++) {
5721 list.add(strings[i]);
5722 }
5723 intent.putExtra(key, list);
5724 hasIntentInfo = true;
5725 }
5726 break;
5727 case "--ez": {
5728 String key = cmd.getNextArgRequired();
5729 String value = cmd.getNextArgRequired().toLowerCase();
5730 // Boolean.valueOf() results in false for anything that is not "true", which is
5731 // error-prone in shell commands
5732 boolean arg;
5733 if ("true".equals(value) || "t".equals(value)) {
5734 arg = true;
5735 } else if ("false".equals(value) || "f".equals(value)) {
5736 arg = false;
5737 } else {
5738 try {
5739 arg = Integer.decode(value) != 0;
5740 } catch (NumberFormatException ex) {
5741 throw new IllegalArgumentException("Invalid boolean value: " + value);
5742 }
5743 }
5744
5745 intent.putExtra(key, arg);
5746 }
5747 break;
5748 case "-n": {
5749 String str = cmd.getNextArgRequired();
5750 ComponentName cn = ComponentName.unflattenFromString(str);
5751 if (cn == null)
5752 throw new IllegalArgumentException("Bad component name: " + str);
5753 intent.setComponent(cn);
5754 if (intent == baseIntent) {
5755 hasIntentInfo = true;
5756 }
5757 }
5758 break;
5759 case "-p": {
5760 String str = cmd.getNextArgRequired();
5761 intent.setPackage(str);
5762 if (intent == baseIntent) {
5763 hasIntentInfo = true;
5764 }
5765 }
5766 break;
5767 case "-f":
5768 String str = cmd.getNextArgRequired();
5769 intent.setFlags(Integer.decode(str).intValue());
5770 break;
5771 case "--grant-read-uri-permission":
5772 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5773 break;
5774 case "--grant-write-uri-permission":
5775 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5776 break;
5777 case "--grant-persistable-uri-permission":
5778 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5779 break;
5780 case "--grant-prefix-uri-permission":
5781 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5782 break;
5783 case "--exclude-stopped-packages":
5784 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5785 break;
5786 case "--include-stopped-packages":
5787 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5788 break;
5789 case "--debug-log-resolution":
5790 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5791 break;
5792 case "--activity-brought-to-front":
5793 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5794 break;
5795 case "--activity-clear-top":
5796 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5797 break;
5798 case "--activity-clear-when-task-reset":
5799 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5800 break;
5801 case "--activity-exclude-from-recents":
5802 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5803 break;
5804 case "--activity-launched-from-history":
5805 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5806 break;
5807 case "--activity-multiple-task":
5808 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5809 break;
5810 case "--activity-no-animation":
5811 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5812 break;
5813 case "--activity-no-history":
5814 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5815 break;
5816 case "--activity-no-user-action":
5817 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5818 break;
5819 case "--activity-previous-is-top":
5820 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5821 break;
5822 case "--activity-reorder-to-front":
5823 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5824 break;
5825 case "--activity-reset-task-if-needed":
5826 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5827 break;
5828 case "--activity-single-top":
5829 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5830 break;
5831 case "--activity-clear-task":
5832 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5833 break;
5834 case "--activity-task-on-home":
5835 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5836 break;
5837 case "--receiver-registered-only":
5838 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5839 break;
5840 case "--receiver-replace-pending":
5841 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5842 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005843 case "--receiver-foreground":
5844 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5845 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005846 case "--selector":
5847 intent.setDataAndType(data, type);
5848 intent = new Intent();
5849 break;
5850 default:
5851 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5852 // Okay, caller handled this option.
5853 } else {
5854 throw new IllegalArgumentException("Unknown option: " + opt);
5855 }
5856 break;
5857 }
5858 }
5859 intent.setDataAndType(data, type);
5860
5861 final boolean hasSelector = intent != baseIntent;
5862 if (hasSelector) {
5863 // A selector was specified; fix up.
5864 baseIntent.setSelector(intent);
5865 intent = baseIntent;
5866 }
5867
5868 String arg = cmd.getNextArg();
5869 baseIntent = null;
5870 if (arg == null) {
5871 if (hasSelector) {
5872 // If a selector has been specified, and no arguments
5873 // have been supplied for the main Intent, then we can
5874 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5875 // need to have a component name specified yet, the
5876 // selector will take care of that.
5877 baseIntent = new Intent(Intent.ACTION_MAIN);
5878 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5879 }
5880 } else if (arg.indexOf(':') >= 0) {
5881 // The argument is a URI. Fully parse it, and use that result
5882 // to fill in any data not specified so far.
5883 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5884 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5885 } else if (arg.indexOf('/') >= 0) {
5886 // The argument is a component name. Build an Intent to launch
5887 // it.
5888 baseIntent = new Intent(Intent.ACTION_MAIN);
5889 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5890 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5891 } else {
5892 // Assume the argument is a package name.
5893 baseIntent = new Intent(Intent.ACTION_MAIN);
5894 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5895 baseIntent.setPackage(arg);
5896 }
5897 if (baseIntent != null) {
5898 Bundle extras = intent.getExtras();
5899 intent.replaceExtras((Bundle)null);
5900 Bundle uriExtras = baseIntent.getExtras();
5901 baseIntent.replaceExtras((Bundle)null);
5902 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5903 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5904 for (String c : cats) {
5905 baseIntent.removeCategory(c);
5906 }
5907 }
5908 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5909 if (extras == null) {
5910 extras = uriExtras;
5911 } else if (uriExtras != null) {
5912 uriExtras.putAll(extras);
5913 extras = uriExtras;
5914 }
5915 intent.replaceExtras(extras);
5916 hasIntentInfo = true;
5917 }
5918
5919 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5920 return intent;
5921 }
5922
5923 /** @hide */
5924 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5925 final String[] lines = new String[] {
5926 "<INTENT> specifications include these flags and arguments:",
5927 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5928 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5929 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5930 " [--esn <EXTRA_KEY> ...]",
5931 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5932 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5933 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5934 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5935 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5936 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5937 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5938 " (mutiple extras passed as Integer[])",
5939 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5940 " (mutiple extras passed as List<Integer>)",
5941 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5942 " (mutiple extras passed as Long[])",
5943 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5944 " (mutiple extras passed as List<Long>)",
5945 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5946 " (mutiple extras passed as Float[])",
5947 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5948 " (mutiple extras passed as List<Float>)",
5949 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5950 " (mutiple extras passed as String[]; to embed a comma into a string,",
5951 " escape it using \"\\,\")",
5952 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5953 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5954 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08005955 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005956 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5957 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5958 " [--debug-log-resolution] [--exclude-stopped-packages]",
5959 " [--include-stopped-packages]",
5960 " [--activity-brought-to-front] [--activity-clear-top]",
5961 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5962 " [--activity-launched-from-history] [--activity-multiple-task]",
5963 " [--activity-no-animation] [--activity-no-history]",
5964 " [--activity-no-user-action] [--activity-previous-is-top]",
5965 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5966 " [--activity-single-top] [--activity-clear-task]",
5967 " [--activity-task-on-home]",
5968 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005969 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005970 " [--selector]",
5971 " [<URI> | <PACKAGE> | <COMPONENT>]"
5972 };
5973 for (String line : lines) {
5974 pw.print(prefix);
5975 pw.println(line);
5976 }
5977 }
5978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005979 /**
5980 * Retrieve the general action to be performed, such as
5981 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5982 * the information in the intent should be interpreted -- most importantly,
5983 * what to do with the data returned by {@link #getData}.
5984 *
5985 * @return The action of this intent or null if none is specified.
5986 *
5987 * @see #setAction
5988 */
5989 public String getAction() {
5990 return mAction;
5991 }
5992
5993 /**
5994 * Retrieve data this intent is operating on. This URI specifies the name
5995 * of the data; often it uses the content: scheme, specifying data in a
5996 * content provider. Other schemes may be handled by specific activities,
5997 * such as http: by the web browser.
5998 *
5999 * @return The URI of the data this intent is targeting or null.
6000 *
6001 * @see #getScheme
6002 * @see #setData
6003 */
6004 public Uri getData() {
6005 return mData;
6006 }
6007
6008 /**
6009 * The same as {@link #getData()}, but returns the URI as an encoded
6010 * String.
6011 */
6012 public String getDataString() {
6013 return mData != null ? mData.toString() : null;
6014 }
6015
6016 /**
6017 * Return the scheme portion of the intent's data. If the data is null or
6018 * does not include a scheme, null is returned. Otherwise, the scheme
6019 * prefix without the final ':' is returned, i.e. "http".
6020 *
6021 * <p>This is the same as calling getData().getScheme() (and checking for
6022 * null data).
6023 *
6024 * @return The scheme of this intent.
6025 *
6026 * @see #getData
6027 */
6028 public String getScheme() {
6029 return mData != null ? mData.getScheme() : null;
6030 }
6031
6032 /**
6033 * Retrieve any explicit MIME type included in the intent. This is usually
6034 * null, as the type is determined by the intent data.
6035 *
6036 * @return If a type was manually set, it is returned; else null is
6037 * returned.
6038 *
6039 * @see #resolveType(ContentResolver)
6040 * @see #setType
6041 */
6042 public String getType() {
6043 return mType;
6044 }
6045
6046 /**
6047 * Return the MIME data type of this intent. If the type field is
6048 * explicitly set, that is simply returned. Otherwise, if the data is set,
6049 * the type of that data is returned. If neither fields are set, a null is
6050 * returned.
6051 *
6052 * @return The MIME type of this intent.
6053 *
6054 * @see #getType
6055 * @see #resolveType(ContentResolver)
6056 */
6057 public String resolveType(Context context) {
6058 return resolveType(context.getContentResolver());
6059 }
6060
6061 /**
6062 * Return the MIME data type of this intent. If the type field is
6063 * explicitly set, that is simply returned. Otherwise, if the data is set,
6064 * the type of that data is returned. If neither fields are set, a null is
6065 * returned.
6066 *
6067 * @param resolver A ContentResolver that can be used to determine the MIME
6068 * type of the intent's data.
6069 *
6070 * @return The MIME type of this intent.
6071 *
6072 * @see #getType
6073 * @see #resolveType(Context)
6074 */
6075 public String resolveType(ContentResolver resolver) {
6076 if (mType != null) {
6077 return mType;
6078 }
6079 if (mData != null) {
6080 if ("content".equals(mData.getScheme())) {
6081 return resolver.getType(mData);
6082 }
6083 }
6084 return null;
6085 }
6086
6087 /**
6088 * Return the MIME data type of this intent, only if it will be needed for
6089 * intent resolution. This is not generally useful for application code;
6090 * it is used by the frameworks for communicating with back-end system
6091 * services.
6092 *
6093 * @param resolver A ContentResolver that can be used to determine the MIME
6094 * type of the intent's data.
6095 *
6096 * @return The MIME type of this intent, or null if it is unknown or not
6097 * needed.
6098 */
6099 public String resolveTypeIfNeeded(ContentResolver resolver) {
6100 if (mComponent != null) {
6101 return mType;
6102 }
6103 return resolveType(resolver);
6104 }
6105
6106 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006107 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006108 *
6109 * @param category The category to check.
6110 *
6111 * @return boolean True if the intent contains the category, else false.
6112 *
6113 * @see #getCategories
6114 * @see #addCategory
6115 */
6116 public boolean hasCategory(String category) {
6117 return mCategories != null && mCategories.contains(category);
6118 }
6119
6120 /**
6121 * Return the set of all categories in the intent. If there are no categories,
6122 * returns NULL.
6123 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006124 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006125 *
6126 * @see #hasCategory
6127 * @see #addCategory
6128 */
6129 public Set<String> getCategories() {
6130 return mCategories;
6131 }
6132
6133 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006134 * Return the specific selector associated with this Intent. If there is
6135 * none, returns null. See {@link #setSelector} for more information.
6136 *
6137 * @see #setSelector
6138 */
6139 public Intent getSelector() {
6140 return mSelector;
6141 }
6142
6143 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006144 * Return the {@link ClipData} associated with this Intent. If there is
6145 * none, returns null. See {@link #setClipData} for more information.
6146 *
John Spurlock125d1332013-11-25 11:58:37 -05006147 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006148 */
6149 public ClipData getClipData() {
6150 return mClipData;
6151 }
6152
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006153 /** @hide */
6154 public int getContentUserHint() {
6155 return mContentUserHint;
6156 }
6157
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006158 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006159 * Sets the ClassLoader that will be used when unmarshalling
6160 * any Parcelable values from the extras of this Intent.
6161 *
6162 * @param loader a ClassLoader, or null to use the default loader
6163 * at the time of unmarshalling.
6164 */
6165 public void setExtrasClassLoader(ClassLoader loader) {
6166 if (mExtras != null) {
6167 mExtras.setClassLoader(loader);
6168 }
6169 }
6170
6171 /**
6172 * Returns true if an extra value is associated with the given name.
6173 * @param name the extra's name
6174 * @return true if the given extra is present.
6175 */
6176 public boolean hasExtra(String name) {
6177 return mExtras != null && mExtras.containsKey(name);
6178 }
6179
6180 /**
6181 * Returns true if the Intent's extras contain a parcelled file descriptor.
6182 * @return true if the Intent contains a parcelled file descriptor.
6183 */
6184 public boolean hasFileDescriptors() {
6185 return mExtras != null && mExtras.hasFileDescriptors();
6186 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006187
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006188 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006189 public void setAllowFds(boolean allowFds) {
6190 if (mExtras != null) {
6191 mExtras.setAllowFds(allowFds);
6192 }
6193 }
6194
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006195 /** {@hide} */
6196 public void setDefusable(boolean defusable) {
6197 if (mExtras != null) {
6198 mExtras.setDefusable(defusable);
6199 }
6200 }
6201
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006202 /**
6203 * Retrieve extended data from the intent.
6204 *
6205 * @param name The name of the desired item.
6206 *
6207 * @return the value of an item that previously added with putExtra()
6208 * or null if none was found.
6209 *
6210 * @deprecated
6211 * @hide
6212 */
6213 @Deprecated
6214 public Object getExtra(String name) {
6215 return getExtra(name, null);
6216 }
6217
6218 /**
6219 * Retrieve extended data from the intent.
6220 *
6221 * @param name The name of the desired item.
6222 * @param defaultValue the value to be returned if no value of the desired
6223 * type is stored with the given name.
6224 *
6225 * @return the value of an item that previously added with putExtra()
6226 * or the default value if none was found.
6227 *
6228 * @see #putExtra(String, boolean)
6229 */
6230 public boolean getBooleanExtra(String name, boolean defaultValue) {
6231 return mExtras == null ? defaultValue :
6232 mExtras.getBoolean(name, defaultValue);
6233 }
6234
6235 /**
6236 * Retrieve extended data from the intent.
6237 *
6238 * @param name The name of the desired item.
6239 * @param defaultValue the value to be returned if no value of the desired
6240 * type is stored with the given name.
6241 *
6242 * @return the value of an item that previously added with putExtra()
6243 * or the default value if none was found.
6244 *
6245 * @see #putExtra(String, byte)
6246 */
6247 public byte getByteExtra(String name, byte defaultValue) {
6248 return mExtras == null ? defaultValue :
6249 mExtras.getByte(name, defaultValue);
6250 }
6251
6252 /**
6253 * Retrieve extended data from the intent.
6254 *
6255 * @param name The name of the desired item.
6256 * @param defaultValue the value to be returned if no value of the desired
6257 * type is stored with the given name.
6258 *
6259 * @return the value of an item that previously added with putExtra()
6260 * or the default value if none was found.
6261 *
6262 * @see #putExtra(String, short)
6263 */
6264 public short getShortExtra(String name, short defaultValue) {
6265 return mExtras == null ? defaultValue :
6266 mExtras.getShort(name, defaultValue);
6267 }
6268
6269 /**
6270 * Retrieve extended data from the intent.
6271 *
6272 * @param name The name of the desired item.
6273 * @param defaultValue the value to be returned if no value of the desired
6274 * type is stored with the given name.
6275 *
6276 * @return the value of an item that previously added with putExtra()
6277 * or the default value if none was found.
6278 *
6279 * @see #putExtra(String, char)
6280 */
6281 public char getCharExtra(String name, char defaultValue) {
6282 return mExtras == null ? defaultValue :
6283 mExtras.getChar(name, defaultValue);
6284 }
6285
6286 /**
6287 * Retrieve extended data from the intent.
6288 *
6289 * @param name The name of the desired item.
6290 * @param defaultValue the value to be returned if no value of the desired
6291 * type is stored with the given name.
6292 *
6293 * @return the value of an item that previously added with putExtra()
6294 * or the default value if none was found.
6295 *
6296 * @see #putExtra(String, int)
6297 */
6298 public int getIntExtra(String name, int defaultValue) {
6299 return mExtras == null ? defaultValue :
6300 mExtras.getInt(name, defaultValue);
6301 }
6302
6303 /**
6304 * Retrieve extended data from the intent.
6305 *
6306 * @param name The name of the desired item.
6307 * @param defaultValue the value to be returned if no value of the desired
6308 * type is stored with the given name.
6309 *
6310 * @return the value of an item that previously added with putExtra()
6311 * or the default value if none was found.
6312 *
6313 * @see #putExtra(String, long)
6314 */
6315 public long getLongExtra(String name, long defaultValue) {
6316 return mExtras == null ? defaultValue :
6317 mExtras.getLong(name, defaultValue);
6318 }
6319
6320 /**
6321 * Retrieve extended data from the intent.
6322 *
6323 * @param name The name of the desired item.
6324 * @param defaultValue the value to be returned if no value of the desired
6325 * type is stored with the given name.
6326 *
6327 * @return the value of an item that previously added with putExtra(),
6328 * or the default value if no such item is present
6329 *
6330 * @see #putExtra(String, float)
6331 */
6332 public float getFloatExtra(String name, float defaultValue) {
6333 return mExtras == null ? defaultValue :
6334 mExtras.getFloat(name, defaultValue);
6335 }
6336
6337 /**
6338 * Retrieve extended data from the intent.
6339 *
6340 * @param name The name of the desired item.
6341 * @param defaultValue the value to be returned if no value of the desired
6342 * type is stored with the given name.
6343 *
6344 * @return the value of an item that previously added with putExtra()
6345 * or the default value if none was found.
6346 *
6347 * @see #putExtra(String, double)
6348 */
6349 public double getDoubleExtra(String name, double defaultValue) {
6350 return mExtras == null ? defaultValue :
6351 mExtras.getDouble(name, defaultValue);
6352 }
6353
6354 /**
6355 * Retrieve extended data from the intent.
6356 *
6357 * @param name The name of the desired item.
6358 *
6359 * @return the value of an item that previously added with putExtra()
6360 * or null if no String value was found.
6361 *
6362 * @see #putExtra(String, String)
6363 */
6364 public String getStringExtra(String name) {
6365 return mExtras == null ? null : mExtras.getString(name);
6366 }
6367
6368 /**
6369 * Retrieve extended data from the intent.
6370 *
6371 * @param name The name of the desired item.
6372 *
6373 * @return the value of an item that previously added with putExtra()
6374 * or null if no CharSequence value was found.
6375 *
6376 * @see #putExtra(String, CharSequence)
6377 */
6378 public CharSequence getCharSequenceExtra(String name) {
6379 return mExtras == null ? null : mExtras.getCharSequence(name);
6380 }
6381
6382 /**
6383 * Retrieve extended data from the intent.
6384 *
6385 * @param name The name of the desired item.
6386 *
6387 * @return the value of an item that previously added with putExtra()
6388 * or null if no Parcelable value was found.
6389 *
6390 * @see #putExtra(String, Parcelable)
6391 */
6392 public <T extends Parcelable> T getParcelableExtra(String name) {
6393 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6394 }
6395
6396 /**
6397 * Retrieve extended data from the intent.
6398 *
6399 * @param name The name of the desired item.
6400 *
6401 * @return the value of an item that previously added with putExtra()
6402 * or null if no Parcelable[] value was found.
6403 *
6404 * @see #putExtra(String, Parcelable[])
6405 */
6406 public Parcelable[] getParcelableArrayExtra(String name) {
6407 return mExtras == null ? null : mExtras.getParcelableArray(name);
6408 }
6409
6410 /**
6411 * Retrieve extended data from the intent.
6412 *
6413 * @param name The name of the desired item.
6414 *
6415 * @return the value of an item that previously added with putExtra()
6416 * or null if no ArrayList<Parcelable> value was found.
6417 *
6418 * @see #putParcelableArrayListExtra(String, ArrayList)
6419 */
6420 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6421 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6422 }
6423
6424 /**
6425 * Retrieve extended data from the intent.
6426 *
6427 * @param name The name of the desired item.
6428 *
6429 * @return the value of an item that previously added with putExtra()
6430 * or null if no Serializable value was found.
6431 *
6432 * @see #putExtra(String, Serializable)
6433 */
6434 public Serializable getSerializableExtra(String name) {
6435 return mExtras == null ? null : mExtras.getSerializable(name);
6436 }
6437
6438 /**
6439 * Retrieve extended data from the intent.
6440 *
6441 * @param name The name of the desired item.
6442 *
6443 * @return the value of an item that previously added with putExtra()
6444 * or null if no ArrayList<Integer> value was found.
6445 *
6446 * @see #putIntegerArrayListExtra(String, ArrayList)
6447 */
6448 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6449 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6450 }
6451
6452 /**
6453 * Retrieve extended data from the intent.
6454 *
6455 * @param name The name of the desired item.
6456 *
6457 * @return the value of an item that previously added with putExtra()
6458 * or null if no ArrayList<String> value was found.
6459 *
6460 * @see #putStringArrayListExtra(String, ArrayList)
6461 */
6462 public ArrayList<String> getStringArrayListExtra(String name) {
6463 return mExtras == null ? null : mExtras.getStringArrayList(name);
6464 }
6465
6466 /**
6467 * Retrieve extended data from the intent.
6468 *
6469 * @param name The name of the desired item.
6470 *
6471 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006472 * or null if no ArrayList<CharSequence> value was found.
6473 *
6474 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6475 */
6476 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6477 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6478 }
6479
6480 /**
6481 * Retrieve extended data from the intent.
6482 *
6483 * @param name The name of the desired item.
6484 *
6485 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006486 * or null if no boolean array value was found.
6487 *
6488 * @see #putExtra(String, boolean[])
6489 */
6490 public boolean[] getBooleanArrayExtra(String name) {
6491 return mExtras == null ? null : mExtras.getBooleanArray(name);
6492 }
6493
6494 /**
6495 * Retrieve extended data from the intent.
6496 *
6497 * @param name The name of the desired item.
6498 *
6499 * @return the value of an item that previously added with putExtra()
6500 * or null if no byte array value was found.
6501 *
6502 * @see #putExtra(String, byte[])
6503 */
6504 public byte[] getByteArrayExtra(String name) {
6505 return mExtras == null ? null : mExtras.getByteArray(name);
6506 }
6507
6508 /**
6509 * Retrieve extended data from the intent.
6510 *
6511 * @param name The name of the desired item.
6512 *
6513 * @return the value of an item that previously added with putExtra()
6514 * or null if no short array value was found.
6515 *
6516 * @see #putExtra(String, short[])
6517 */
6518 public short[] getShortArrayExtra(String name) {
6519 return mExtras == null ? null : mExtras.getShortArray(name);
6520 }
6521
6522 /**
6523 * Retrieve extended data from the intent.
6524 *
6525 * @param name The name of the desired item.
6526 *
6527 * @return the value of an item that previously added with putExtra()
6528 * or null if no char array value was found.
6529 *
6530 * @see #putExtra(String, char[])
6531 */
6532 public char[] getCharArrayExtra(String name) {
6533 return mExtras == null ? null : mExtras.getCharArray(name);
6534 }
6535
6536 /**
6537 * Retrieve extended data from the intent.
6538 *
6539 * @param name The name of the desired item.
6540 *
6541 * @return the value of an item that previously added with putExtra()
6542 * or null if no int array value was found.
6543 *
6544 * @see #putExtra(String, int[])
6545 */
6546 public int[] getIntArrayExtra(String name) {
6547 return mExtras == null ? null : mExtras.getIntArray(name);
6548 }
6549
6550 /**
6551 * Retrieve extended data from the intent.
6552 *
6553 * @param name The name of the desired item.
6554 *
6555 * @return the value of an item that previously added with putExtra()
6556 * or null if no long array value was found.
6557 *
6558 * @see #putExtra(String, long[])
6559 */
6560 public long[] getLongArrayExtra(String name) {
6561 return mExtras == null ? null : mExtras.getLongArray(name);
6562 }
6563
6564 /**
6565 * Retrieve extended data from the intent.
6566 *
6567 * @param name The name of the desired item.
6568 *
6569 * @return the value of an item that previously added with putExtra()
6570 * or null if no float array value was found.
6571 *
6572 * @see #putExtra(String, float[])
6573 */
6574 public float[] getFloatArrayExtra(String name) {
6575 return mExtras == null ? null : mExtras.getFloatArray(name);
6576 }
6577
6578 /**
6579 * Retrieve extended data from the intent.
6580 *
6581 * @param name The name of the desired item.
6582 *
6583 * @return the value of an item that previously added with putExtra()
6584 * or null if no double array value was found.
6585 *
6586 * @see #putExtra(String, double[])
6587 */
6588 public double[] getDoubleArrayExtra(String name) {
6589 return mExtras == null ? null : mExtras.getDoubleArray(name);
6590 }
6591
6592 /**
6593 * Retrieve extended data from the intent.
6594 *
6595 * @param name The name of the desired item.
6596 *
6597 * @return the value of an item that previously added with putExtra()
6598 * or null if no String array value was found.
6599 *
6600 * @see #putExtra(String, String[])
6601 */
6602 public String[] getStringArrayExtra(String name) {
6603 return mExtras == null ? null : mExtras.getStringArray(name);
6604 }
6605
6606 /**
6607 * Retrieve extended data from the intent.
6608 *
6609 * @param name The name of the desired item.
6610 *
6611 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006612 * or null if no CharSequence array value was found.
6613 *
6614 * @see #putExtra(String, CharSequence[])
6615 */
6616 public CharSequence[] getCharSequenceArrayExtra(String name) {
6617 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6618 }
6619
6620 /**
6621 * Retrieve extended data from the intent.
6622 *
6623 * @param name The name of the desired item.
6624 *
6625 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006626 * or null if no Bundle value was found.
6627 *
6628 * @see #putExtra(String, Bundle)
6629 */
6630 public Bundle getBundleExtra(String name) {
6631 return mExtras == null ? null : mExtras.getBundle(name);
6632 }
6633
6634 /**
6635 * Retrieve extended data from the intent.
6636 *
6637 * @param name The name of the desired item.
6638 *
6639 * @return the value of an item that previously added with putExtra()
6640 * or null if no IBinder value was found.
6641 *
6642 * @see #putExtra(String, IBinder)
6643 *
6644 * @deprecated
6645 * @hide
6646 */
6647 @Deprecated
6648 public IBinder getIBinderExtra(String name) {
6649 return mExtras == null ? null : mExtras.getIBinder(name);
6650 }
6651
6652 /**
6653 * Retrieve extended data from the intent.
6654 *
6655 * @param name The name of the desired item.
6656 * @param defaultValue The default value to return in case no item is
6657 * associated with the key 'name'
6658 *
6659 * @return the value of an item that previously added with putExtra()
6660 * or defaultValue if none was found.
6661 *
6662 * @see #putExtra
6663 *
6664 * @deprecated
6665 * @hide
6666 */
6667 @Deprecated
6668 public Object getExtra(String name, Object defaultValue) {
6669 Object result = defaultValue;
6670 if (mExtras != null) {
6671 Object result2 = mExtras.get(name);
6672 if (result2 != null) {
6673 result = result2;
6674 }
6675 }
6676
6677 return result;
6678 }
6679
6680 /**
6681 * Retrieves a map of extended data from the intent.
6682 *
6683 * @return the map of all extras previously added with putExtra(),
6684 * or null if none have been added.
6685 */
6686 public Bundle getExtras() {
6687 return (mExtras != null)
6688 ? new Bundle(mExtras)
6689 : null;
6690 }
6691
6692 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006693 * Filter extras to only basic types.
6694 * @hide
6695 */
6696 public void removeUnsafeExtras() {
6697 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006698 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006699 }
6700 }
6701
6702 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006703 * Retrieve any special flags associated with this intent. You will
6704 * normally just set them with {@link #setFlags} and let the system
6705 * take the appropriate action with them.
6706 *
6707 * @return int The currently set flags.
6708 *
6709 * @see #setFlags
6710 */
6711 public int getFlags() {
6712 return mFlags;
6713 }
6714
Dianne Hackborne7f97212011-02-24 14:40:20 -08006715 /** @hide */
6716 public boolean isExcludingStopped() {
6717 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6718 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6719 }
6720
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006721 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006722 * Retrieve the application package name this Intent is limited to. When
6723 * resolving an Intent, if non-null this limits the resolution to only
6724 * components in the given application package.
6725 *
6726 * @return The name of the application package for the Intent.
6727 *
6728 * @see #resolveActivity
6729 * @see #setPackage
6730 */
6731 public String getPackage() {
6732 return mPackage;
6733 }
6734
6735 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006736 * Retrieve the concrete component associated with the intent. When receiving
6737 * an intent, this is the component that was found to best handle it (that is,
6738 * yourself) and will always be non-null; in all other cases it will be
6739 * null unless explicitly set.
6740 *
6741 * @return The name of the application component to handle the intent.
6742 *
6743 * @see #resolveActivity
6744 * @see #setComponent
6745 */
6746 public ComponentName getComponent() {
6747 return mComponent;
6748 }
6749
6750 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006751 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6752 * used as a hint to the receiver for animations and the like. Null means that there
6753 * is no source bounds.
6754 */
6755 public Rect getSourceBounds() {
6756 return mSourceBounds;
6757 }
6758
6759 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006760 * Return the Activity component that should be used to handle this intent.
6761 * The appropriate component is determined based on the information in the
6762 * intent, evaluated as follows:
6763 *
6764 * <p>If {@link #getComponent} returns an explicit class, that is returned
6765 * without any further consideration.
6766 *
6767 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6768 * category to be considered.
6769 *
6770 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6771 * action.
6772 *
6773 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6774 * this type.
6775 *
6776 * <p>If {@link #addCategory} has added any categories, the activity must
6777 * handle ALL of the categories specified.
6778 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006779 * <p>If {@link #getPackage} is non-NULL, only activity components in
6780 * that application package will be considered.
6781 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006782 * <p>If there are no activities that satisfy all of these conditions, a
6783 * null string is returned.
6784 *
6785 * <p>If multiple activities are found to satisfy the intent, the one with
6786 * the highest priority will be used. If there are multiple activities
6787 * with the same priority, the system will either pick the best activity
6788 * based on user preference, or resolve to a system class that will allow
6789 * the user to pick an activity and forward from there.
6790 *
6791 * <p>This method is implemented simply by calling
6792 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6793 * true.</p>
6794 * <p> This API is called for you as part of starting an activity from an
6795 * intent. You do not normally need to call it yourself.</p>
6796 *
6797 * @param pm The package manager with which to resolve the Intent.
6798 *
6799 * @return Name of the component implementing an activity that can
6800 * display the intent.
6801 *
6802 * @see #setComponent
6803 * @see #getComponent
6804 * @see #resolveActivityInfo
6805 */
6806 public ComponentName resolveActivity(PackageManager pm) {
6807 if (mComponent != null) {
6808 return mComponent;
6809 }
6810
6811 ResolveInfo info = pm.resolveActivity(
6812 this, PackageManager.MATCH_DEFAULT_ONLY);
6813 if (info != null) {
6814 return new ComponentName(
6815 info.activityInfo.applicationInfo.packageName,
6816 info.activityInfo.name);
6817 }
6818
6819 return null;
6820 }
6821
6822 /**
6823 * Resolve the Intent into an {@link ActivityInfo}
6824 * describing the activity that should execute the intent. Resolution
6825 * follows the same rules as described for {@link #resolveActivity}, but
6826 * you get back the completely information about the resolved activity
6827 * instead of just its class name.
6828 *
6829 * @param pm The package manager with which to resolve the Intent.
6830 * @param flags Addition information to retrieve as per
6831 * {@link PackageManager#getActivityInfo(ComponentName, int)
6832 * PackageManager.getActivityInfo()}.
6833 *
6834 * @return PackageManager.ActivityInfo
6835 *
6836 * @see #resolveActivity
6837 */
6838 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6839 ActivityInfo ai = null;
6840 if (mComponent != null) {
6841 try {
6842 ai = pm.getActivityInfo(mComponent, flags);
6843 } catch (PackageManager.NameNotFoundException e) {
6844 // ignore
6845 }
6846 } else {
6847 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006848 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006849 if (info != null) {
6850 ai = info.activityInfo;
6851 }
6852 }
6853
6854 return ai;
6855 }
6856
6857 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006858 * Special function for use by the system to resolve service
6859 * intents to system apps. Throws an exception if there are
6860 * multiple potential matches to the Intent. Returns null if
6861 * there are no matches.
6862 * @hide
6863 */
6864 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6865 if (mComponent != null) {
6866 return mComponent;
6867 }
6868
6869 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6870 if (results == null) {
6871 return null;
6872 }
6873 ComponentName comp = null;
6874 for (int i=0; i<results.size(); i++) {
6875 ResolveInfo ri = results.get(i);
6876 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6877 continue;
6878 }
6879 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6880 ri.serviceInfo.name);
6881 if (comp != null) {
6882 throw new IllegalStateException("Multiple system services handle " + this
6883 + ": " + comp + ", " + foundComp);
6884 }
6885 comp = foundComp;
6886 }
6887 return comp;
6888 }
6889
6890 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006891 * Set the general action to be performed.
6892 *
6893 * @param action An action name, such as ACTION_VIEW. Application-specific
6894 * actions should be prefixed with the vendor's package name.
6895 *
6896 * @return Returns the same Intent object, for chaining multiple calls
6897 * into a single statement.
6898 *
6899 * @see #getAction
6900 */
6901 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006902 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006903 return this;
6904 }
6905
6906 /**
6907 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006908 * clears any type that was previously set by {@link #setType} or
6909 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006910 *
Nick Pellyccae4122012-01-09 14:12:58 -08006911 * <p><em>Note: scheme matching in the Android framework is
6912 * case-sensitive, unlike the formal RFC. As a result,
6913 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006914 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006915 * {@link #setDataAndNormalize}
6916 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006917 *
Nick Pellyccae4122012-01-09 14:12:58 -08006918 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006919 *
6920 * @return Returns the same Intent object, for chaining multiple calls
6921 * into a single statement.
6922 *
6923 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006924 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006925 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006926 */
6927 public Intent setData(Uri data) {
6928 mData = data;
6929 mType = null;
6930 return this;
6931 }
6932
6933 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006934 * Normalize and set the data this intent is operating on.
6935 *
6936 * <p>This method automatically clears any type that was
6937 * previously set (for example, by {@link #setType}).
6938 *
6939 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006940 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006941 * so really this is just a convenience method for
6942 * <pre>
6943 * setData(data.normalize())
6944 * </pre>
6945 *
6946 * @param data The Uri of the data this intent is now targeting.
6947 *
6948 * @return Returns the same Intent object, for chaining multiple calls
6949 * into a single statement.
6950 *
6951 * @see #getData
6952 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006953 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006954 */
6955 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006956 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006957 }
6958
6959 /**
6960 * Set an explicit MIME data type.
6961 *
6962 * <p>This is used to create intents that only specify a type and not data,
6963 * for example to indicate the type of data to return.
6964 *
6965 * <p>This method automatically clears any data that was
6966 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006967 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006968 * <p><em>Note: MIME type matching in the Android framework is
6969 * case-sensitive, unlike formal RFC MIME types. As a result,
6970 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006971 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6972 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006973 *
6974 * @param type The MIME type of the data being handled by this intent.
6975 *
6976 * @return Returns the same Intent object, for chaining multiple calls
6977 * into a single statement.
6978 *
6979 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006980 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006981 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006982 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006983 */
6984 public Intent setType(String type) {
6985 mData = null;
6986 mType = type;
6987 return this;
6988 }
6989
6990 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006991 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006992 *
Nick Pellyccae4122012-01-09 14:12:58 -08006993 * <p>This is used to create intents that only specify a type and not data,
6994 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006995 *
Nick Pellyccae4122012-01-09 14:12:58 -08006996 * <p>This method automatically clears any data that was
6997 * previously set (for example by {@link #setData}).
6998 *
6999 * <p>The MIME type is normalized using
7000 * {@link #normalizeMimeType} before it is set,
7001 * so really this is just a convenience method for
7002 * <pre>
7003 * setType(Intent.normalizeMimeType(type))
7004 * </pre>
7005 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007006 * @param type The MIME type of the data being handled by this intent.
7007 *
7008 * @return Returns the same Intent object, for chaining multiple calls
7009 * into a single statement.
7010 *
Nick Pellyccae4122012-01-09 14:12:58 -08007011 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007012 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08007013 * @see #normalizeMimeType
7014 */
7015 public Intent setTypeAndNormalize(String type) {
7016 return setType(normalizeMimeType(type));
7017 }
7018
7019 /**
7020 * (Usually optional) Set the data for the intent along with an explicit
7021 * MIME data type. This method should very rarely be used -- it allows you
7022 * to override the MIME type that would ordinarily be inferred from the
7023 * data with your own type given here.
7024 *
7025 * <p><em>Note: MIME type and Uri scheme matching in the
7026 * Android framework is case-sensitive, unlike the formal RFC definitions.
7027 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007028 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08007029 * {@link #setDataAndTypeAndNormalize}
7030 * to ensure that they are converted to lower case.</em>
7031 *
7032 * @param data The Uri of the data this intent is now targeting.
7033 * @param type The MIME type of the data being handled by this intent.
7034 *
7035 * @return Returns the same Intent object, for chaining multiple calls
7036 * into a single statement.
7037 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007038 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08007039 * @see #setData
7040 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007041 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007042 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007043 */
7044 public Intent setDataAndType(Uri data, String type) {
7045 mData = data;
7046 mType = type;
7047 return this;
7048 }
7049
7050 /**
Nick Pellyccae4122012-01-09 14:12:58 -08007051 * (Usually optional) Normalize and set both the data Uri and an explicit
7052 * MIME data type. This method should very rarely be used -- it allows you
7053 * to override the MIME type that would ordinarily be inferred from the
7054 * data with your own type given here.
7055 *
7056 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007057 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08007058 * before they are set, so really this is just a convenience method for
7059 * <pre>
7060 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7061 * </pre>
7062 *
7063 * @param data The Uri of the data this intent is now targeting.
7064 * @param type The MIME type of the data being handled by this intent.
7065 *
7066 * @return Returns the same Intent object, for chaining multiple calls
7067 * into a single statement.
7068 *
7069 * @see #setType
7070 * @see #setData
7071 * @see #setDataAndType
7072 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007073 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007074 */
7075 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007076 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007077 }
7078
7079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007080 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007081 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007082 * activities that provide <em>all</em> of the requested categories will be
7083 * used.
7084 *
7085 * @param category The desired category. This can be either one of the
7086 * predefined Intent categories, or a custom category in your own
7087 * namespace.
7088 *
7089 * @return Returns the same Intent object, for chaining multiple calls
7090 * into a single statement.
7091 *
7092 * @see #hasCategory
7093 * @see #removeCategory
7094 */
7095 public Intent addCategory(String category) {
7096 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007097 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007098 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007099 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007100 return this;
7101 }
7102
7103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007104 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007105 *
7106 * @param category The category to remove.
7107 *
7108 * @see #addCategory
7109 */
7110 public void removeCategory(String category) {
7111 if (mCategories != null) {
7112 mCategories.remove(category);
7113 if (mCategories.size() == 0) {
7114 mCategories = null;
7115 }
7116 }
7117 }
7118
7119 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007120 * Set a selector for this Intent. This is a modification to the kinds of
7121 * things the Intent will match. If the selector is set, it will be used
7122 * when trying to find entities that can handle the Intent, instead of the
7123 * main contents of the Intent. This allows you build an Intent containing
7124 * a generic protocol while targeting it more specifically.
7125 *
7126 * <p>An example of where this may be used is with things like
7127 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7128 * Intent that will launch the Browser application. However, the correct
7129 * main entry point of an application is actually {@link #ACTION_MAIN}
7130 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7131 * used to specify the actual Activity to launch. If you launch the browser
7132 * with something different, undesired behavior may happen if the user has
7133 * previously or later launches it the normal way, since they do not match.
7134 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7135 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7136 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7137 *
7138 * <p>Setting a selector does not impact the behavior of
7139 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7140 * desired behavior of a selector -- it does not impact the base meaning
7141 * of the Intent, just what kinds of things will be matched against it
7142 * when determining who can handle it.</p>
7143 *
7144 * <p>You can not use both a selector and {@link #setPackage(String)} on
7145 * the same base Intent.</p>
7146 *
7147 * @param selector The desired selector Intent; set to null to not use
7148 * a special selector.
7149 */
7150 public void setSelector(Intent selector) {
7151 if (selector == this) {
7152 throw new IllegalArgumentException(
7153 "Intent being set as a selector of itself");
7154 }
7155 if (selector != null && mPackage != null) {
7156 throw new IllegalArgumentException(
7157 "Can't set selector when package name is already set");
7158 }
7159 mSelector = selector;
7160 }
7161
7162 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007163 * Set a {@link ClipData} associated with this Intent. This replaces any
7164 * previously set ClipData.
7165 *
7166 * <p>The ClipData in an intent is not used for Intent matching or other
7167 * such operations. Semantically it is like extras, used to transmit
7168 * additional data with the Intent. The main feature of using this over
7169 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7170 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7171 * items included in the clip data. This is useful, in particular, if
7172 * you want to transmit an Intent containing multiple <code>content:</code>
7173 * URIs for which the recipient may not have global permission to access the
7174 * content provider.
7175 *
7176 * <p>If the ClipData contains items that are themselves Intents, any
7177 * grant flags in those Intents will be ignored. Only the top-level flags
7178 * of the main Intent are respected, and will be applied to all Uri or
7179 * Intent items in the clip (or sub-items of the clip).
7180 *
7181 * <p>The MIME type, label, and icon in the ClipData object are not
7182 * directly used by Intent. Applications should generally rely on the
7183 * MIME type of the Intent itself, not what it may find in the ClipData.
7184 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007185 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007186 *
7187 * @param clip The new clip to set. May be null to clear the current clip.
7188 */
7189 public void setClipData(ClipData clip) {
7190 mClipData = clip;
7191 }
7192
7193 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007194 * This is NOT a secure mechanism to identify the user who sent the intent.
7195 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7196 * who sent the intent.
7197 * @hide
7198 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007199 public void prepareToLeaveUser(int userId) {
7200 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7201 // We want mContentUserHint to refer to the original user, so don't do anything.
7202 if (mContentUserHint == UserHandle.USER_CURRENT) {
7203 mContentUserHint = userId;
7204 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007205 }
7206
7207 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007208 * Add extended data to the intent. The name must include a package
7209 * prefix, for example the app com.android.contacts would use names
7210 * like "com.android.contacts.ShowAll".
7211 *
7212 * @param name The name of the extra data, with package prefix.
7213 * @param value The boolean data value.
7214 *
7215 * @return Returns the same Intent object, for chaining multiple calls
7216 * into a single statement.
7217 *
7218 * @see #putExtras
7219 * @see #removeExtra
7220 * @see #getBooleanExtra(String, boolean)
7221 */
7222 public Intent putExtra(String name, boolean value) {
7223 if (mExtras == null) {
7224 mExtras = new Bundle();
7225 }
7226 mExtras.putBoolean(name, value);
7227 return this;
7228 }
7229
7230 /**
7231 * Add extended data to the intent. The name must include a package
7232 * prefix, for example the app com.android.contacts would use names
7233 * like "com.android.contacts.ShowAll".
7234 *
7235 * @param name The name of the extra data, with package prefix.
7236 * @param value The byte data value.
7237 *
7238 * @return Returns the same Intent object, for chaining multiple calls
7239 * into a single statement.
7240 *
7241 * @see #putExtras
7242 * @see #removeExtra
7243 * @see #getByteExtra(String, byte)
7244 */
7245 public Intent putExtra(String name, byte value) {
7246 if (mExtras == null) {
7247 mExtras = new Bundle();
7248 }
7249 mExtras.putByte(name, value);
7250 return this;
7251 }
7252
7253 /**
7254 * Add extended data to the intent. The name must include a package
7255 * prefix, for example the app com.android.contacts would use names
7256 * like "com.android.contacts.ShowAll".
7257 *
7258 * @param name The name of the extra data, with package prefix.
7259 * @param value The char data value.
7260 *
7261 * @return Returns the same Intent object, for chaining multiple calls
7262 * into a single statement.
7263 *
7264 * @see #putExtras
7265 * @see #removeExtra
7266 * @see #getCharExtra(String, char)
7267 */
7268 public Intent putExtra(String name, char value) {
7269 if (mExtras == null) {
7270 mExtras = new Bundle();
7271 }
7272 mExtras.putChar(name, value);
7273 return this;
7274 }
7275
7276 /**
7277 * Add extended data to the intent. The name must include a package
7278 * prefix, for example the app com.android.contacts would use names
7279 * like "com.android.contacts.ShowAll".
7280 *
7281 * @param name The name of the extra data, with package prefix.
7282 * @param value The short data value.
7283 *
7284 * @return Returns the same Intent object, for chaining multiple calls
7285 * into a single statement.
7286 *
7287 * @see #putExtras
7288 * @see #removeExtra
7289 * @see #getShortExtra(String, short)
7290 */
7291 public Intent putExtra(String name, short value) {
7292 if (mExtras == null) {
7293 mExtras = new Bundle();
7294 }
7295 mExtras.putShort(name, value);
7296 return this;
7297 }
7298
7299 /**
7300 * Add extended data to the intent. The name must include a package
7301 * prefix, for example the app com.android.contacts would use names
7302 * like "com.android.contacts.ShowAll".
7303 *
7304 * @param name The name of the extra data, with package prefix.
7305 * @param value The integer data value.
7306 *
7307 * @return Returns the same Intent object, for chaining multiple calls
7308 * into a single statement.
7309 *
7310 * @see #putExtras
7311 * @see #removeExtra
7312 * @see #getIntExtra(String, int)
7313 */
7314 public Intent putExtra(String name, int value) {
7315 if (mExtras == null) {
7316 mExtras = new Bundle();
7317 }
7318 mExtras.putInt(name, value);
7319 return this;
7320 }
7321
7322 /**
7323 * Add extended data to the intent. The name must include a package
7324 * prefix, for example the app com.android.contacts would use names
7325 * like "com.android.contacts.ShowAll".
7326 *
7327 * @param name The name of the extra data, with package prefix.
7328 * @param value The long data value.
7329 *
7330 * @return Returns the same Intent object, for chaining multiple calls
7331 * into a single statement.
7332 *
7333 * @see #putExtras
7334 * @see #removeExtra
7335 * @see #getLongExtra(String, long)
7336 */
7337 public Intent putExtra(String name, long value) {
7338 if (mExtras == null) {
7339 mExtras = new Bundle();
7340 }
7341 mExtras.putLong(name, value);
7342 return this;
7343 }
7344
7345 /**
7346 * 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 float 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 #getFloatExtra(String, float)
7359 */
7360 public Intent putExtra(String name, float value) {
7361 if (mExtras == null) {
7362 mExtras = new Bundle();
7363 }
7364 mExtras.putFloat(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 double 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 #getDoubleExtra(String, double)
7382 */
7383 public Intent putExtra(String name, double value) {
7384 if (mExtras == null) {
7385 mExtras = new Bundle();
7386 }
7387 mExtras.putDouble(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 String 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 #getStringExtra(String)
7405 */
7406 public Intent putExtra(String name, String value) {
7407 if (mExtras == null) {
7408 mExtras = new Bundle();
7409 }
7410 mExtras.putString(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 CharSequence 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 #getCharSequenceExtra(String)
7428 */
7429 public Intent putExtra(String name, CharSequence value) {
7430 if (mExtras == null) {
7431 mExtras = new Bundle();
7432 }
7433 mExtras.putCharSequence(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 Parcelable 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 #getParcelableExtra(String)
7451 */
7452 public Intent putExtra(String name, Parcelable value) {
7453 if (mExtras == null) {
7454 mExtras = new Bundle();
7455 }
7456 mExtras.putParcelable(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 Parcelable[] 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 #getParcelableArrayExtra(String)
7474 */
7475 public Intent putExtra(String name, Parcelable[] value) {
7476 if (mExtras == null) {
7477 mExtras = new Bundle();
7478 }
7479 mExtras.putParcelableArray(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 ArrayList<Parcelable> 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 #getParcelableArrayListExtra(String)
7497 */
7498 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7499 if (mExtras == null) {
7500 mExtras = new Bundle();
7501 }
7502 mExtras.putParcelableArrayList(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 ArrayList<Integer> 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 #getIntegerArrayListExtra(String)
7520 */
7521 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7522 if (mExtras == null) {
7523 mExtras = new Bundle();
7524 }
7525 mExtras.putIntegerArrayList(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 ArrayList<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 #getStringArrayListExtra(String)
7543 */
7544 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7545 if (mExtras == null) {
7546 mExtras = new Bundle();
7547 }
7548 mExtras.putStringArrayList(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007558 * @param value The ArrayList<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 #getCharSequenceArrayListExtra(String)
7566 */
7567 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7568 if (mExtras == null) {
7569 mExtras = new Bundle();
7570 }
7571 mExtras.putCharSequenceArrayList(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007581 * @param value The Serializable 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 #getSerializableExtra(String)
7589 */
7590 public Intent putExtra(String name, Serializable value) {
7591 if (mExtras == null) {
7592 mExtras = new Bundle();
7593 }
7594 mExtras.putSerializable(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 boolean array 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 #getBooleanArrayExtra(String)
7612 */
7613 public Intent putExtra(String name, boolean[] value) {
7614 if (mExtras == null) {
7615 mExtras = new Bundle();
7616 }
7617 mExtras.putBooleanArray(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 byte array 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 #getByteArrayExtra(String)
7635 */
7636 public Intent putExtra(String name, byte[] value) {
7637 if (mExtras == null) {
7638 mExtras = new Bundle();
7639 }
7640 mExtras.putByteArray(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 short array 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 #getShortArrayExtra(String)
7658 */
7659 public Intent putExtra(String name, short[] value) {
7660 if (mExtras == null) {
7661 mExtras = new Bundle();
7662 }
7663 mExtras.putShortArray(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 char array 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 #getCharArrayExtra(String)
7681 */
7682 public Intent putExtra(String name, char[] value) {
7683 if (mExtras == null) {
7684 mExtras = new Bundle();
7685 }
7686 mExtras.putCharArray(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.
7696 * @param value The int array 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 #getIntArrayExtra(String)
7704 */
7705 public Intent putExtra(String name, int[] value) {
7706 if (mExtras == null) {
7707 mExtras = new Bundle();
7708 }
7709 mExtras.putIntArray(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.
7719 * @param value The byte array 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 #getLongArrayExtra(String)
7727 */
7728 public Intent putExtra(String name, long[] value) {
7729 if (mExtras == null) {
7730 mExtras = new Bundle();
7731 }
7732 mExtras.putLongArray(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 float 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 #getFloatArrayExtra(String)
7750 */
7751 public Intent putExtra(String name, float[] value) {
7752 if (mExtras == null) {
7753 mExtras = new Bundle();
7754 }
7755 mExtras.putFloatArray(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 double 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 #getDoubleArrayExtra(String)
7773 */
7774 public Intent putExtra(String name, double[] value) {
7775 if (mExtras == null) {
7776 mExtras = new Bundle();
7777 }
7778 mExtras.putDoubleArray(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 String 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 #getStringArrayExtra(String)
7796 */
7797 public Intent putExtra(String name, String[] value) {
7798 if (mExtras == null) {
7799 mExtras = new Bundle();
7800 }
7801 mExtras.putStringArray(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.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007811 * @param value The CharSequence 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 #getCharSequenceArrayExtra(String)
7819 */
7820 public Intent putExtra(String name, CharSequence[] value) {
7821 if (mExtras == null) {
7822 mExtras = new Bundle();
7823 }
7824 mExtras.putCharSequenceArray(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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007834 * @param value The Bundle 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 #getBundleExtra(String)
7842 */
7843 public Intent putExtra(String name, Bundle value) {
7844 if (mExtras == null) {
7845 mExtras = new Bundle();
7846 }
7847 mExtras.putBundle(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 IBinder 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 #getIBinderExtra(String)
7865 *
7866 * @deprecated
7867 * @hide
7868 */
7869 @Deprecated
7870 public Intent putExtra(String name, IBinder value) {
7871 if (mExtras == null) {
7872 mExtras = new Bundle();
7873 }
7874 mExtras.putIBinder(name, value);
7875 return this;
7876 }
7877
7878 /**
7879 * Copy all extras in 'src' in to this intent.
7880 *
7881 * @param src Contains the extras to copy.
7882 *
7883 * @see #putExtra
7884 */
7885 public Intent putExtras(Intent src) {
7886 if (src.mExtras != null) {
7887 if (mExtras == null) {
7888 mExtras = new Bundle(src.mExtras);
7889 } else {
7890 mExtras.putAll(src.mExtras);
7891 }
7892 }
7893 return this;
7894 }
7895
7896 /**
7897 * Add a set of extended data to the intent. The keys must include a package
7898 * prefix, for example the app com.android.contacts would use names
7899 * like "com.android.contacts.ShowAll".
7900 *
7901 * @param extras The Bundle of extras to add to this intent.
7902 *
7903 * @see #putExtra
7904 * @see #removeExtra
7905 */
7906 public Intent putExtras(Bundle extras) {
7907 if (mExtras == null) {
7908 mExtras = new Bundle();
7909 }
7910 mExtras.putAll(extras);
7911 return this;
7912 }
7913
7914 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007915 * Completely replace the extras in the Intent with the extras in the
7916 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007917 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007918 * @param src The exact extras contained in this Intent are copied
7919 * into the target intent, replacing any that were previously there.
7920 */
7921 public Intent replaceExtras(Intent src) {
7922 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7923 return this;
7924 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007925
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007926 /**
7927 * Completely replace the extras in the Intent with the given Bundle of
7928 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007929 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007930 * @param extras The new set of extras in the Intent, or null to erase
7931 * all extras.
7932 */
7933 public Intent replaceExtras(Bundle extras) {
7934 mExtras = extras != null ? new Bundle(extras) : null;
7935 return this;
7936 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007937
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007938 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007939 * Remove extended data from the intent.
7940 *
7941 * @see #putExtra
7942 */
7943 public void removeExtra(String name) {
7944 if (mExtras != null) {
7945 mExtras.remove(name);
7946 if (mExtras.size() == 0) {
7947 mExtras = null;
7948 }
7949 }
7950 }
7951
7952 /**
7953 * Set special flags controlling how this intent is handled. Most values
7954 * here depend on the type of component being executed by the Intent,
7955 * specifically the FLAG_ACTIVITY_* flags are all for use with
7956 * {@link Context#startActivity Context.startActivity()} and the
7957 * FLAG_RECEIVER_* flags are all for use with
7958 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7959 *
Scott Main7aee61f2011-02-08 11:25:01 -08007960 * <p>See the
7961 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7962 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007963 * the behavior of your application.
7964 *
7965 * @param flags The desired flags.
7966 *
7967 * @return Returns the same Intent object, for chaining multiple calls
7968 * into a single statement.
7969 *
7970 * @see #getFlags
7971 * @see #addFlags
7972 *
7973 * @see #FLAG_GRANT_READ_URI_PERMISSION
7974 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007975 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7976 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007977 * @see #FLAG_DEBUG_LOG_RESOLUTION
7978 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007979 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007980 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007981 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007982 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007983 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7984 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007985 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007986 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007987 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007988 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007989 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007990 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007991 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007992 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7993 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007994 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007995 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007996 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007997 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7998 */
7999 public Intent setFlags(int flags) {
8000 mFlags = flags;
8001 return this;
8002 }
8003
8004 /**
8005 * Add additional flags to the intent (or with existing flags
8006 * value).
8007 *
8008 * @param flags The new flags to set.
8009 *
8010 * @return Returns the same Intent object, for chaining multiple calls
8011 * into a single statement.
8012 *
8013 * @see #setFlags
8014 */
8015 public Intent addFlags(int flags) {
8016 mFlags |= flags;
8017 return this;
8018 }
8019
8020 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008021 * (Usually optional) Set an explicit application package name that limits
8022 * the components this Intent will resolve to. If left to the default
8023 * value of null, all components in all applications will considered.
8024 * If non-null, the Intent can only match the components in the given
8025 * application package.
8026 *
8027 * @param packageName The name of the application package to handle the
8028 * intent, or null to allow any application package.
8029 *
8030 * @return Returns the same Intent object, for chaining multiple calls
8031 * into a single statement.
8032 *
8033 * @see #getPackage
8034 * @see #resolveActivity
8035 */
8036 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008037 if (packageName != null && mSelector != null) {
8038 throw new IllegalArgumentException(
8039 "Can't set package name when selector is already set");
8040 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008041 mPackage = packageName;
8042 return this;
8043 }
8044
8045 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008046 * (Usually optional) Explicitly set the component to handle the intent.
8047 * If left with the default value of null, the system will determine the
8048 * appropriate class to use based on the other fields (action, data,
8049 * type, categories) in the Intent. If this class is defined, the
8050 * specified class will always be used regardless of the other fields. You
8051 * should only set this value when you know you absolutely want a specific
8052 * class to be used; otherwise it is better to let the system find the
8053 * appropriate class so that you will respect the installed applications
8054 * and user preferences.
8055 *
8056 * @param component The name of the application component to handle the
8057 * intent, or null to let the system find one for you.
8058 *
8059 * @return Returns the same Intent object, for chaining multiple calls
8060 * into a single statement.
8061 *
8062 * @see #setClass
8063 * @see #setClassName(Context, String)
8064 * @see #setClassName(String, String)
8065 * @see #getComponent
8066 * @see #resolveActivity
8067 */
8068 public Intent setComponent(ComponentName component) {
8069 mComponent = component;
8070 return this;
8071 }
8072
8073 /**
8074 * Convenience for calling {@link #setComponent} with an
8075 * explicit class name.
8076 *
8077 * @param packageContext A Context of the application package implementing
8078 * this class.
8079 * @param className The name of a class inside of the application package
8080 * that will be used as the component for this Intent.
8081 *
8082 * @return Returns the same Intent object, for chaining multiple calls
8083 * into a single statement.
8084 *
8085 * @see #setComponent
8086 * @see #setClass
8087 */
8088 public Intent setClassName(Context packageContext, String className) {
8089 mComponent = new ComponentName(packageContext, className);
8090 return this;
8091 }
8092
8093 /**
8094 * Convenience for calling {@link #setComponent} with an
8095 * explicit application package name and class name.
8096 *
8097 * @param packageName The name of the package implementing the desired
8098 * component.
8099 * @param className The name of a class inside of the application package
8100 * that will be used as the component for this Intent.
8101 *
8102 * @return Returns the same Intent object, for chaining multiple calls
8103 * into a single statement.
8104 *
8105 * @see #setComponent
8106 * @see #setClass
8107 */
8108 public Intent setClassName(String packageName, String className) {
8109 mComponent = new ComponentName(packageName, className);
8110 return this;
8111 }
8112
8113 /**
8114 * Convenience for calling {@link #setComponent(ComponentName)} with the
8115 * name returned by a {@link Class} object.
8116 *
8117 * @param packageContext A Context of the application package implementing
8118 * this class.
8119 * @param cls The class name to set, equivalent to
8120 * <code>setClassName(context, cls.getName())</code>.
8121 *
8122 * @return Returns the same Intent object, for chaining multiple calls
8123 * into a single statement.
8124 *
8125 * @see #setComponent
8126 */
8127 public Intent setClass(Context packageContext, Class<?> cls) {
8128 mComponent = new ComponentName(packageContext, cls);
8129 return this;
8130 }
8131
8132 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008133 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8134 * used as a hint to the receiver for animations and the like. Null means that there
8135 * is no source bounds.
8136 */
8137 public void setSourceBounds(Rect r) {
8138 if (r != null) {
8139 mSourceBounds = new Rect(r);
8140 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008141 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008142 }
8143 }
8144
Tor Norbyed9273d62013-05-30 15:59:53 -07008145 /** @hide */
8146 @IntDef(flag = true,
8147 value = {
8148 FILL_IN_ACTION,
8149 FILL_IN_DATA,
8150 FILL_IN_CATEGORIES,
8151 FILL_IN_COMPONENT,
8152 FILL_IN_PACKAGE,
8153 FILL_IN_SOURCE_BOUNDS,
8154 FILL_IN_SELECTOR,
8155 FILL_IN_CLIP_DATA
8156 })
8157 @Retention(RetentionPolicy.SOURCE)
8158 public @interface FillInFlags {}
8159
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008160 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008161 * Use with {@link #fillIn} to allow the current action value to be
8162 * overwritten, even if it is already set.
8163 */
8164 public static final int FILL_IN_ACTION = 1<<0;
8165
8166 /**
8167 * Use with {@link #fillIn} to allow the current data or type value
8168 * overwritten, even if it is already set.
8169 */
8170 public static final int FILL_IN_DATA = 1<<1;
8171
8172 /**
8173 * Use with {@link #fillIn} to allow the current categories to be
8174 * overwritten, even if they are already set.
8175 */
8176 public static final int FILL_IN_CATEGORIES = 1<<2;
8177
8178 /**
8179 * Use with {@link #fillIn} to allow the current component value to be
8180 * overwritten, even if it is already set.
8181 */
8182 public static final int FILL_IN_COMPONENT = 1<<3;
8183
8184 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008185 * Use with {@link #fillIn} to allow the current package value to be
8186 * overwritten, even if it is already set.
8187 */
8188 public static final int FILL_IN_PACKAGE = 1<<4;
8189
8190 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008191 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008192 * overwritten, even if it is already set.
8193 */
8194 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8195
8196 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008197 * Use with {@link #fillIn} to allow the current selector to be
8198 * overwritten, even if it is already set.
8199 */
8200 public static final int FILL_IN_SELECTOR = 1<<6;
8201
8202 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008203 * Use with {@link #fillIn} to allow the current ClipData to be
8204 * overwritten, even if it is already set.
8205 */
8206 public static final int FILL_IN_CLIP_DATA = 1<<7;
8207
8208 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008209 * Copy the contents of <var>other</var> in to this object, but only
8210 * where fields are not defined by this object. For purposes of a field
8211 * being defined, the following pieces of data in the Intent are
8212 * considered to be separate fields:
8213 *
8214 * <ul>
8215 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008216 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008217 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8218 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008219 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008220 * <li> component, as set by {@link #setComponent(ComponentName)} or
8221 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008222 * <li> source bounds, as set by {@link #setSourceBounds}.
8223 * <li> selector, as set by {@link #setSelector(Intent)}.
8224 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008225 * <li> each top-level name in the associated extras.
8226 * </ul>
8227 *
8228 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008229 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008230 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8231 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8232 * the restriction where the corresponding field will not be replaced if
8233 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008234 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008235 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8236 * is explicitly specified. The selector will only be copied if
8237 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008238 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008239 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8240 * and Intent B with {action="gotit", data-type="some/thing",
8241 * categories="one","two"}.
8242 *
8243 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8244 * containing: {action="gotit", data-type="some/thing",
8245 * categories="bar"}.
8246 *
8247 * @param other Another Intent whose values are to be used to fill in
8248 * the current one.
8249 * @param flags Options to control which fields can be filled in.
8250 *
8251 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008252 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008253 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8254 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8255 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008256 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008257 @FillInFlags
8258 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008259 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008260 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008261 if (other.mAction != null
8262 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008263 mAction = other.mAction;
8264 changes |= FILL_IN_ACTION;
8265 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008266 if ((other.mData != null || other.mType != null)
8267 && ((mData == null && mType == null)
8268 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008269 mData = other.mData;
8270 mType = other.mType;
8271 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008272 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008273 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008274 if (other.mCategories != null
8275 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008276 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008277 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008278 }
8279 changes |= FILL_IN_CATEGORIES;
8280 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008281 if (other.mPackage != null
8282 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008283 // Only do this if mSelector is not set.
8284 if (mSelector == null) {
8285 mPackage = other.mPackage;
8286 changes |= FILL_IN_PACKAGE;
8287 }
8288 }
8289 // Selector is special: it can only be set if explicitly allowed,
8290 // for the same reason as the component name.
8291 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8292 if (mPackage == null) {
8293 mSelector = new Intent(other.mSelector);
8294 mPackage = null;
8295 changes |= FILL_IN_SELECTOR;
8296 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008297 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008298 if (other.mClipData != null
8299 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8300 mClipData = other.mClipData;
8301 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008302 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008303 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008304 // Component is special: it can -only- be set if explicitly allowed,
8305 // since otherwise the sender could force the intent somewhere the
8306 // originator didn't intend.
8307 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008308 mComponent = other.mComponent;
8309 changes |= FILL_IN_COMPONENT;
8310 }
8311 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008312 if (other.mSourceBounds != null
8313 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8314 mSourceBounds = new Rect(other.mSourceBounds);
8315 changes |= FILL_IN_SOURCE_BOUNDS;
8316 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008317 if (mExtras == null) {
8318 if (other.mExtras != null) {
8319 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008320 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008321 }
8322 } else if (other.mExtras != null) {
8323 try {
8324 Bundle newb = new Bundle(other.mExtras);
8325 newb.putAll(mExtras);
8326 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008327 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008328 } catch (RuntimeException e) {
8329 // Modifying the extras can cause us to unparcel the contents
8330 // of the bundle, and if we do this in the system process that
8331 // may fail. We really should handle this (i.e., the Bundle
8332 // impl shouldn't be on top of a plain map), but for now just
8333 // ignore it and keep the original contents. :(
8334 Log.w("Intent", "Failure filling in extras", e);
8335 }
8336 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008337 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8338 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8339 mContentUserHint = other.mContentUserHint;
8340 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008341 return changes;
8342 }
8343
8344 /**
8345 * Wrapper class holding an Intent and implementing comparisons on it for
8346 * the purpose of filtering. The class implements its
8347 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8348 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8349 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8350 * on the wrapped Intent.
8351 */
8352 public static final class FilterComparison {
8353 private final Intent mIntent;
8354 private final int mHashCode;
8355
8356 public FilterComparison(Intent intent) {
8357 mIntent = intent;
8358 mHashCode = intent.filterHashCode();
8359 }
8360
8361 /**
8362 * Return the Intent that this FilterComparison represents.
8363 * @return Returns the Intent held by the FilterComparison. Do
8364 * not modify!
8365 */
8366 public Intent getIntent() {
8367 return mIntent;
8368 }
8369
8370 @Override
8371 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008372 if (obj instanceof FilterComparison) {
8373 Intent other = ((FilterComparison)obj).mIntent;
8374 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008375 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008376 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008377 }
8378
8379 @Override
8380 public int hashCode() {
8381 return mHashCode;
8382 }
8383 }
8384
8385 /**
8386 * Determine if two intents are the same for the purposes of intent
8387 * resolution (filtering). That is, if their action, data, type,
8388 * class, and categories are the same. This does <em>not</em> compare
8389 * any extra data included in the intents.
8390 *
8391 * @param other The other Intent to compare against.
8392 *
8393 * @return Returns true if action, data, type, class, and categories
8394 * are the same.
8395 */
8396 public boolean filterEquals(Intent other) {
8397 if (other == null) {
8398 return false;
8399 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008400 if (!Objects.equals(this.mAction, other.mAction)) return false;
8401 if (!Objects.equals(this.mData, other.mData)) return false;
8402 if (!Objects.equals(this.mType, other.mType)) return false;
8403 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8404 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8405 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008406
8407 return true;
8408 }
8409
8410 /**
8411 * Generate hash code that matches semantics of filterEquals().
8412 *
8413 * @return Returns the hash value of the action, data, type, class, and
8414 * categories.
8415 *
8416 * @see #filterEquals
8417 */
8418 public int filterHashCode() {
8419 int code = 0;
8420 if (mAction != null) {
8421 code += mAction.hashCode();
8422 }
8423 if (mData != null) {
8424 code += mData.hashCode();
8425 }
8426 if (mType != null) {
8427 code += mType.hashCode();
8428 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008429 if (mPackage != null) {
8430 code += mPackage.hashCode();
8431 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008432 if (mComponent != null) {
8433 code += mComponent.hashCode();
8434 }
8435 if (mCategories != null) {
8436 code += mCategories.hashCode();
8437 }
8438 return code;
8439 }
8440
8441 @Override
8442 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008443 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008444
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008445 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008446 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008447 b.append(" }");
8448
8449 return b.toString();
8450 }
8451
8452 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008453 public String toInsecureString() {
8454 StringBuilder b = new StringBuilder(128);
8455
8456 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008457 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008458 b.append(" }");
8459
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008460 return b.toString();
8461 }
Romain Guy4969af72009-06-17 10:53:19 -07008462
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008463 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008464 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008465 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008466
8467 b.append("Intent { ");
8468 toShortString(b, false, true, true, true);
8469 b.append(" }");
8470
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008471 return b.toString();
8472 }
8473
8474 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008475 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8476 StringBuilder b = new StringBuilder(128);
8477 toShortString(b, secure, comp, extras, clip);
8478 return b.toString();
8479 }
8480
8481 /** @hide */
8482 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8483 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008484 boolean first = true;
8485 if (mAction != null) {
8486 b.append("act=").append(mAction);
8487 first = false;
8488 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008489 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008490 if (!first) {
8491 b.append(' ');
8492 }
8493 first = false;
8494 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008495 for (int i=0; i<mCategories.size(); i++) {
8496 if (i > 0) b.append(',');
8497 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008498 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008499 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008500 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008501 if (mData != null) {
8502 if (!first) {
8503 b.append(' ');
8504 }
8505 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008506 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008507 if (secure) {
8508 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008509 } else {
8510 b.append(mData);
8511 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008512 }
8513 if (mType != null) {
8514 if (!first) {
8515 b.append(' ');
8516 }
8517 first = false;
8518 b.append("typ=").append(mType);
8519 }
8520 if (mFlags != 0) {
8521 if (!first) {
8522 b.append(' ');
8523 }
8524 first = false;
8525 b.append("flg=0x").append(Integer.toHexString(mFlags));
8526 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008527 if (mPackage != null) {
8528 if (!first) {
8529 b.append(' ');
8530 }
8531 first = false;
8532 b.append("pkg=").append(mPackage);
8533 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008534 if (comp && mComponent != null) {
8535 if (!first) {
8536 b.append(' ');
8537 }
8538 first = false;
8539 b.append("cmp=").append(mComponent.flattenToShortString());
8540 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008541 if (mSourceBounds != null) {
8542 if (!first) {
8543 b.append(' ');
8544 }
8545 first = false;
8546 b.append("bnds=").append(mSourceBounds.toShortString());
8547 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008548 if (mClipData != null) {
8549 if (!first) {
8550 b.append(' ');
8551 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008552 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008553 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008554 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008555 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008556 if (mClipData.getDescription() != null) {
8557 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8558 } else {
8559 first = true;
8560 }
8561 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008562 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008563 first = false;
8564 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008565 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008566 if (extras && mExtras != null) {
8567 if (!first) {
8568 b.append(' ');
8569 }
8570 first = false;
8571 b.append("(has extras)");
8572 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008573 if (mContentUserHint != UserHandle.USER_CURRENT) {
8574 if (!first) {
8575 b.append(' ');
8576 }
8577 first = false;
8578 b.append("u=").append(mContentUserHint);
8579 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008580 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008581 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008582 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008583 b.append("}");
8584 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 }
8586
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008587 /**
8588 * Call {@link #toUri} with 0 flags.
8589 * @deprecated Use {@link #toUri} instead.
8590 */
8591 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008592 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008593 return toUri(0);
8594 }
8595
8596 /**
8597 * Convert this Intent into a String holding a URI representation of it.
8598 * The returned URI string has been properly URI encoded, so it can be
8599 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8600 * Intent's data as the base URI, with an additional fragment describing
8601 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008602 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008603 * <p>You can convert the returned string back to an Intent with
8604 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008605 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008606 * @param flags Additional operating flags. Either 0,
8607 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008608 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008609 * @return Returns a URI encoding URI string describing the entire contents
8610 * of the Intent.
8611 */
8612 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008613 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008614 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8615 if (mPackage == null) {
8616 throw new IllegalArgumentException(
8617 "Intent must include an explicit package name to build an android-app: "
8618 + this);
8619 }
8620 uri.append("android-app://");
8621 uri.append(mPackage);
8622 String scheme = null;
8623 if (mData != null) {
8624 scheme = mData.getScheme();
8625 if (scheme != null) {
8626 uri.append('/');
8627 uri.append(scheme);
8628 String authority = mData.getEncodedAuthority();
8629 if (authority != null) {
8630 uri.append('/');
8631 uri.append(authority);
8632 String path = mData.getEncodedPath();
8633 if (path != null) {
8634 uri.append(path);
8635 }
8636 String queryParams = mData.getEncodedQuery();
8637 if (queryParams != null) {
8638 uri.append('?');
8639 uri.append(queryParams);
8640 }
8641 String fragment = mData.getEncodedFragment();
8642 if (fragment != null) {
8643 uri.append('#');
8644 uri.append(fragment);
8645 }
8646 }
8647 }
8648 }
8649 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8650 mPackage, flags);
8651 return uri.toString();
8652 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008653 String scheme = null;
8654 if (mData != null) {
8655 String data = mData.toString();
8656 if ((flags&URI_INTENT_SCHEME) != 0) {
8657 final int N = data.length();
8658 for (int i=0; i<N; i++) {
8659 char c = data.charAt(i);
8660 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8661 || c == '.' || c == '-') {
8662 continue;
8663 }
8664 if (c == ':' && i > 0) {
8665 // Valid scheme.
8666 scheme = data.substring(0, i);
8667 uri.append("intent:");
8668 data = data.substring(i+1);
8669 break;
8670 }
Tom Taylord4a47292009-12-21 13:59:18 -08008671
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008672 // No scheme.
8673 break;
8674 }
8675 }
8676 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008677
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008678 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8679 uri.append("intent:");
8680 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008681
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008682 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008683
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008684 return uri.toString();
8685 }
8686
8687 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8688 String defPackage, int flags) {
8689 StringBuilder frag = new StringBuilder(128);
8690
8691 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008692 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008693 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008694 // Note that for now we are not going to try to handle the
8695 // data part; not clear how to represent this as a URI, and
8696 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008697 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8698 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008699 }
8700
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008701 if (frag.length() > 0) {
8702 uri.append("#Intent;");
8703 uri.append(frag);
8704 uri.append("end");
8705 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008706 }
8707
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008708 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8709 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008710 if (scheme != null) {
8711 uri.append("scheme=").append(scheme).append(';');
8712 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008713 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008714 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008715 }
8716 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008717 for (int i=0; i<mCategories.size(); i++) {
8718 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008719 }
8720 }
8721 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008722 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008723 }
8724 if (mFlags != 0) {
8725 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8726 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008727 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008728 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8729 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008730 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008731 uri.append("component=").append(Uri.encode(
8732 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008733 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008734 if (mSourceBounds != null) {
8735 uri.append("sourceBounds=")
8736 .append(Uri.encode(mSourceBounds.flattenToString()))
8737 .append(';');
8738 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008739 if (mExtras != null) {
8740 for (String key : mExtras.keySet()) {
8741 final Object value = mExtras.get(key);
8742 char entryType =
8743 value instanceof String ? 'S' :
8744 value instanceof Boolean ? 'B' :
8745 value instanceof Byte ? 'b' :
8746 value instanceof Character ? 'c' :
8747 value instanceof Double ? 'd' :
8748 value instanceof Float ? 'f' :
8749 value instanceof Integer ? 'i' :
8750 value instanceof Long ? 'l' :
8751 value instanceof Short ? 's' :
8752 '\0';
8753
8754 if (entryType != '\0') {
8755 uri.append(entryType);
8756 uri.append('.');
8757 uri.append(Uri.encode(key));
8758 uri.append('=');
8759 uri.append(Uri.encode(value.toString()));
8760 uri.append(';');
8761 }
8762 }
8763 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008764 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008765
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008766 public int describeContents() {
8767 return (mExtras != null) ? mExtras.describeContents() : 0;
8768 }
8769
8770 public void writeToParcel(Parcel out, int flags) {
8771 out.writeString(mAction);
8772 Uri.writeToParcel(out, mData);
8773 out.writeString(mType);
8774 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008775 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008776 ComponentName.writeToParcel(mComponent, out);
8777
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008778 if (mSourceBounds != null) {
8779 out.writeInt(1);
8780 mSourceBounds.writeToParcel(out, flags);
8781 } else {
8782 out.writeInt(0);
8783 }
8784
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008785 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008786 final int N = mCategories.size();
8787 out.writeInt(N);
8788 for (int i=0; i<N; i++) {
8789 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008790 }
8791 } else {
8792 out.writeInt(0);
8793 }
8794
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008795 if (mSelector != null) {
8796 out.writeInt(1);
8797 mSelector.writeToParcel(out, flags);
8798 } else {
8799 out.writeInt(0);
8800 }
8801
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008802 if (mClipData != null) {
8803 out.writeInt(1);
8804 mClipData.writeToParcel(out, flags);
8805 } else {
8806 out.writeInt(0);
8807 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008808 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008809 out.writeBundle(mExtras);
8810 }
8811
8812 public static final Parcelable.Creator<Intent> CREATOR
8813 = new Parcelable.Creator<Intent>() {
8814 public Intent createFromParcel(Parcel in) {
8815 return new Intent(in);
8816 }
8817 public Intent[] newArray(int size) {
8818 return new Intent[size];
8819 }
8820 };
8821
Dianne Hackborneb034652009-09-07 00:49:58 -07008822 /** @hide */
8823 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008824 readFromParcel(in);
8825 }
8826
8827 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008828 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008829 mData = Uri.CREATOR.createFromParcel(in);
8830 mType = in.readString();
8831 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008832 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008833 mComponent = ComponentName.readFromParcel(in);
8834
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008835 if (in.readInt() != 0) {
8836 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8837 }
8838
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008839 int N = in.readInt();
8840 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008841 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008842 int i;
8843 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008844 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008845 }
8846 } else {
8847 mCategories = null;
8848 }
8849
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008850 if (in.readInt() != 0) {
8851 mSelector = new Intent(in);
8852 }
8853
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008854 if (in.readInt() != 0) {
8855 mClipData = new ClipData(in);
8856 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008857 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008858 mExtras = in.readBundle();
8859 }
8860
8861 /**
8862 * Parses the "intent" element (and its children) from XML and instantiates
8863 * an Intent object. The given XML parser should be located at the tag
8864 * where parsing should start (often named "intent"), from which the
8865 * basic action, data, type, and package and class name will be
8866 * retrieved. The function will then parse in to any child elements,
8867 * looking for <category android:name="xxx"> tags to add categories and
8868 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8869 * to the intent.
8870 *
8871 * @param resources The Resources to use when inflating resources.
8872 * @param parser The XML parser pointing at an "intent" tag.
8873 * @param attrs The AttributeSet interface for retrieving extended
8874 * attribute data at the current <var>parser</var> location.
8875 * @return An Intent object matching the XML data.
8876 * @throws XmlPullParserException If there was an XML parsing error.
8877 * @throws IOException If there was an I/O error.
8878 */
8879 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8880 throws XmlPullParserException, IOException {
8881 Intent intent = new Intent();
8882
8883 TypedArray sa = resources.obtainAttributes(attrs,
8884 com.android.internal.R.styleable.Intent);
8885
8886 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8887
8888 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8889 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8890 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8891
8892 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8893 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8894 if (packageName != null && className != null) {
8895 intent.setComponent(new ComponentName(packageName, className));
8896 }
8897
8898 sa.recycle();
8899
8900 int outerDepth = parser.getDepth();
8901 int type;
8902 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8903 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8904 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8905 continue;
8906 }
8907
8908 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008909 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008910 sa = resources.obtainAttributes(attrs,
8911 com.android.internal.R.styleable.IntentCategory);
8912 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8913 sa.recycle();
8914
8915 if (cat != null) {
8916 intent.addCategory(cat);
8917 }
8918 XmlUtils.skipCurrentTag(parser);
8919
Craig Mautner21d24a22014-04-23 11:45:37 -07008920 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008921 if (intent.mExtras == null) {
8922 intent.mExtras = new Bundle();
8923 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008924 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008925 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008926
8927 } else {
8928 XmlUtils.skipCurrentTag(parser);
8929 }
8930 }
8931
8932 return intent;
8933 }
Nick Pellyccae4122012-01-09 14:12:58 -08008934
Craig Mautner21d24a22014-04-23 11:45:37 -07008935 /** @hide */
8936 public void saveToXml(XmlSerializer out) throws IOException {
8937 if (mAction != null) {
8938 out.attribute(null, ATTR_ACTION, mAction);
8939 }
8940 if (mData != null) {
8941 out.attribute(null, ATTR_DATA, mData.toString());
8942 }
8943 if (mType != null) {
8944 out.attribute(null, ATTR_TYPE, mType);
8945 }
8946 if (mComponent != null) {
8947 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8948 }
8949 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8950
8951 if (mCategories != null) {
8952 out.startTag(null, TAG_CATEGORIES);
8953 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8954 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8955 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008956 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008957 }
8958 }
8959
8960 /** @hide */
8961 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8962 XmlPullParserException {
8963 Intent intent = new Intent();
8964 final int outerDepth = in.getDepth();
8965
8966 int attrCount = in.getAttributeCount();
8967 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8968 final String attrName = in.getAttributeName(attrNdx);
8969 final String attrValue = in.getAttributeValue(attrNdx);
8970 if (ATTR_ACTION.equals(attrName)) {
8971 intent.setAction(attrValue);
8972 } else if (ATTR_DATA.equals(attrName)) {
8973 intent.setData(Uri.parse(attrValue));
8974 } else if (ATTR_TYPE.equals(attrName)) {
8975 intent.setType(attrValue);
8976 } else if (ATTR_COMPONENT.equals(attrName)) {
8977 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8978 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008979 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008980 } else {
8981 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8982 }
8983 }
8984
8985 int event;
8986 String name;
8987 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8988 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8989 if (event == XmlPullParser.START_TAG) {
8990 name = in.getName();
8991 if (TAG_CATEGORIES.equals(name)) {
8992 attrCount = in.getAttributeCount();
8993 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8994 intent.addCategory(in.getAttributeValue(attrNdx));
8995 }
8996 } else {
8997 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8998 XmlUtils.skipCurrentTag(in);
8999 }
9000 }
9001 }
9002
9003 return intent;
9004 }
9005
Nick Pellyccae4122012-01-09 14:12:58 -08009006 /**
9007 * Normalize a MIME data type.
9008 *
9009 * <p>A normalized MIME type has white-space trimmed,
9010 * content-type parameters removed, and is lower-case.
9011 * This aligns the type with Android best practices for
9012 * intent filtering.
9013 *
9014 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
9015 * "text/x-vCard" becomes "text/x-vcard".
9016 *
9017 * <p>All MIME types received from outside Android (such as user input,
9018 * or external sources like Bluetooth, NFC, or the Internet) should
9019 * be normalized before they are used to create an Intent.
9020 *
9021 * @param type MIME data type to normalize
9022 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05009023 * @see #setType
9024 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08009025 */
9026 public static String normalizeMimeType(String type) {
9027 if (type == null) {
9028 return null;
9029 }
9030
Elliott Hughescb64d432013-08-02 10:00:44 -07009031 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08009032
9033 final int semicolonIndex = type.indexOf(';');
9034 if (semicolonIndex != -1) {
9035 type = type.substring(0, semicolonIndex);
9036 }
9037 return type;
9038 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009039
9040 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009041 * Prepare this {@link Intent} to leave an app process.
9042 *
9043 * @hide
9044 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07009045 public void prepareToLeaveProcess(Context context) {
9046 final boolean leavingPackage = (mComponent == null)
9047 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
9048 prepareToLeaveProcess(leavingPackage);
9049 }
9050
9051 /**
9052 * Prepare this {@link Intent} to leave an app process.
9053 *
9054 * @hide
9055 */
9056 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009057 setAllowFds(false);
9058
9059 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009060 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009061 }
9062 if (mClipData != null) {
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009063 mClipData.prepareToLeaveProcess(leavingPackage, getFlags());
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009064 }
9065
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009066 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9067 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009068 switch (mAction) {
9069 case ACTION_MEDIA_REMOVED:
9070 case ACTION_MEDIA_UNMOUNTED:
9071 case ACTION_MEDIA_CHECKING:
9072 case ACTION_MEDIA_NOFS:
9073 case ACTION_MEDIA_MOUNTED:
9074 case ACTION_MEDIA_SHARED:
9075 case ACTION_MEDIA_UNSHARED:
9076 case ACTION_MEDIA_BAD_REMOVAL:
9077 case ACTION_MEDIA_UNMOUNTABLE:
9078 case ACTION_MEDIA_EJECT:
9079 case ACTION_MEDIA_SCANNER_STARTED:
9080 case ACTION_MEDIA_SCANNER_FINISHED:
9081 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009082 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9083 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009084 // Ignore legacy actions
9085 break;
9086 default:
9087 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009088 }
9089 }
Jeff Sharkeyfb833f32016-12-01 14:59:59 -07009090
9091 if (mAction != null && mData != null && StrictMode.vmContentUriWithoutPermissionEnabled()
9092 && leavingPackage) {
9093 switch (mAction) {
9094 case ACTION_PROVIDER_CHANGED:
9095 // Ignore actions that don't need to grant
9096 break;
9097 default:
9098 mData.checkContentUriWithoutPermission("Intent.getData()", getFlags());
9099 }
9100 }
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009101 }
9102
9103 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009104 * @hide
9105 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009106 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009107 // We just entered destination process, so we should be able to read all
9108 // parcelables inside.
9109 setDefusable(true);
9110
9111 if (mSelector != null) {
9112 mSelector.prepareToEnterProcess();
9113 }
9114 if (mClipData != null) {
9115 mClipData.prepareToEnterProcess();
9116 }
9117
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009118 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009119 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9120 fixUris(mContentUserHint);
9121 mContentUserHint = UserHandle.USER_CURRENT;
9122 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009123 }
9124 }
9125
9126 /**
9127 * @hide
9128 */
9129 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009130 Uri data = getData();
9131 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009132 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009133 }
9134 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009135 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009136 }
9137 String action = getAction();
9138 if (ACTION_SEND.equals(action)) {
9139 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9140 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009141 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009142 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009143 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009144 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9145 if (streams != null) {
9146 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9147 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009148 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009149 }
9150 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9151 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009152 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9153 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9154 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9155 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9156 if (output != null) {
9157 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9158 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009159 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009160 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009161
9162 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009163 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009164 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9165 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009166 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009167 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009168 * @hide
9169 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009170 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009171 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009172 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009173
9174 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009175 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009176
9177 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009178 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009179 // Inspect contained intents to see if we need to migrate extras. We
9180 // don't promote ClipData to the parent, since ChooserActivity will
9181 // already start the picked item as the caller, and we can't combine
9182 // the flags in a safe way.
9183
9184 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009185 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009186 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9187 if (intent != null) {
9188 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009189 }
9190 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009191 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009192 try {
9193 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9194 if (intents != null) {
9195 for (int i = 0; i < intents.length; i++) {
9196 final Intent intent = (Intent) intents[i];
9197 if (intent != null) {
9198 migrated |= intent.migrateExtraStreamToClipData();
9199 }
9200 }
9201 }
9202 } catch (ClassCastException e) {
9203 }
9204 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009205
9206 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009207 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009208 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9209 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9210 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9211 if (stream != null || text != null || htmlText != null) {
9212 final ClipData clipData = new ClipData(
9213 null, new String[] { getType() },
9214 new ClipData.Item(text, htmlText, null, stream));
9215 setClipData(clipData);
9216 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009217 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009218 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009219 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009220 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009221
9222 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009223 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009224 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9225 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9226 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9227 int num = -1;
9228 if (streams != null) {
9229 num = streams.size();
9230 }
9231 if (texts != null) {
9232 if (num >= 0 && num != texts.size()) {
9233 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009234 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009235 }
9236 num = texts.size();
9237 }
9238 if (htmlTexts != null) {
9239 if (num >= 0 && num != htmlTexts.size()) {
9240 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009241 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009242 }
9243 num = htmlTexts.size();
9244 }
9245 if (num > 0) {
9246 final ClipData clipData = new ClipData(
9247 null, new String[] { getType() },
9248 makeClipItem(streams, texts, htmlTexts, 0));
9249
9250 for (int i = 1; i < num; i++) {
9251 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9252 }
9253
9254 setClipData(clipData);
9255 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009256 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009257 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009258 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009259 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009260 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9261 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9262 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9263 final Uri output;
9264 try {
9265 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9266 } catch (ClassCastException e) {
9267 return false;
9268 }
9269 if (output != null) {
9270 setClipData(ClipData.newRawUri("", output));
9271 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9272 return true;
9273 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009274 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009275
9276 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009277 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009278
9279 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9280 ArrayList<String> htmlTexts, int which) {
9281 Uri uri = streams != null ? streams.get(which) : null;
9282 CharSequence text = texts != null ? texts.get(which) : null;
9283 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9284 return new ClipData.Item(text, htmlText, null, uri);
9285 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009286
9287 /** @hide */
9288 public boolean isDocument() {
9289 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9290 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009291}