blob: df2c6fcd5c8d52b6a015fd7c01d0d8e0740f7841 [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
131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
132 * 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>
1451 * Input: The data must be a content: or file: 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
1559 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1560 * @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 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001716 * Intent extra: An extra for specifying whether a result is needed.
1717 * <p>
1718 * Type: boolean
1719 * </p>
1720 *
1721 * @hide
1722 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001723 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001724 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1725
1726 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001727 * Activity action: Launch UI to manage which apps have a given permission.
1728 * <p>
1729 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1730 * to which will be managed by the launched UI.
1731 * </p>
1732 * <p>
1733 * Output: Nothing.
1734 * </p>
1735 *
1736 * @see #EXTRA_PERMISSION_NAME
1737 *
1738 * @hide
1739 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001740 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001741 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1742 public static final String ACTION_MANAGE_PERMISSION_APPS =
1743 "android.intent.action.MANAGE_PERMISSION_APPS";
1744
1745 /**
1746 * Intent extra: The name of a permission.
1747 * <p>
1748 * Type: String
1749 * </p>
1750 *
1751 * @hide
1752 */
1753 @SystemApi
1754 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1755
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001756 // ---------------------------------------------------------------------
1757 // ---------------------------------------------------------------------
1758 // Standard intent broadcast actions (see action variable).
1759
1760 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001761 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1762 * <p>
1763 * For historical reasons, the name of this broadcast action refers to the power
1764 * state of the screen but it is actually sent in response to changes in the
1765 * overall interactive state of the device.
1766 * </p><p>
1767 * This broadcast is sent when the device becomes non-interactive which may have
1768 * nothing to do with the screen turning off. To determine the
1769 * actual state of the screen, use {@link android.view.Display#getState}.
1770 * </p><p>
1771 * See {@link android.os.PowerManager#isInteractive} for details.
1772 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001773 * You <em>cannot</em> receive this through components declared in
1774 * manifests, only by explicitly registering for it with
1775 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1776 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001777 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001778 * <p class="note">This is a protected intent that can only be sent
1779 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001780 */
1781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1782 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001784 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001785 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1786 * <p>
1787 * For historical reasons, the name of this broadcast action refers to the power
1788 * state of the screen but it is actually sent in response to changes in the
1789 * overall interactive state of the device.
1790 * </p><p>
1791 * This broadcast is sent when the device becomes interactive which may have
1792 * nothing to do with the screen turning on. To determine the
1793 * actual state of the screen, use {@link android.view.Display#getState}.
1794 * </p><p>
1795 * See {@link android.os.PowerManager#isInteractive} for details.
1796 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001797 * You <em>cannot</em> receive this through components declared in
1798 * manifests, only by explicitly registering for it with
1799 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1800 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001801 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001802 * <p class="note">This is a protected intent that can only be sent
1803 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001804 */
1805 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1806 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001807
1808 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001809 * Broadcast Action: Sent after the system stops dreaming.
1810 *
1811 * <p class="note">This is a protected intent that can only be sent by the system.
1812 * It is only sent to registered receivers.</p>
1813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1816
1817 /**
1818 * Broadcast Action: Sent after the system starts dreaming.
1819 *
1820 * <p class="note">This is a protected intent that can only be sent by the system.
1821 * It is only sent to registered receivers.</p>
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1825
1826 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001827 * 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 -07001828 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001829 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001830 * <p class="note">This is a protected intent that can only be sent
1831 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001834 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001835
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 /**
1837 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001838 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001839 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1841 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1848 /**
1849 * Broadcast Action: The time was set.
1850 */
1851 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1852 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1853 /**
1854 * Broadcast Action: The date has changed.
1855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1858 /**
1859 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1860 * <ul>
1861 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1862 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001863 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001864 * <p class="note">This is a protected intent that can only be sent
1865 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1869 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001870 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1871 * DNS entries should be tossed.
1872 * @hide
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1876 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001877 * Alarm Changed Action: This is broadcast when the AlarmClock
1878 * application's alarm is set or unset. It is used by the
1879 * AlarmClock application and the StatusBar service.
1880 * @hide
1881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001884
1885 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001886 * Broadcast Action: This is broadcast once, after the user has finished
1887 * booting, but while still in the "locked" state. It can be used to perform
1888 * application-specific initialization, such as installing alarms. You must
1889 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1890 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001891 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001892 * This broadcast is sent immediately at boot by all devices (regardless of
1893 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1894 * higher. Upon receipt of this broadcast, the user is still locked and only
1895 * device-protected storage can be accessed safely. If you want to access
1896 * credential-protected storage, you need to wait for the user to be
1897 * unlocked (typically by entering their lock pattern or PIN for the first
1898 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1899 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1900 * <p>
1901 * To receive this broadcast, your receiver component must be marked as
1902 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001903 * <p class="note">
1904 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001905 *
1906 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1910
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001912 * Broadcast Action: This is broadcast once, after the user has finished
1913 * booting. It can be used to perform application-specific initialization,
1914 * such as installing alarms. You must hold the
1915 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1916 * order to receive this broadcast.
1917 * <p>
1918 * This broadcast is sent at boot by all devices (both with and without
1919 * direct boot support). Upon receipt of this broadcast, the user is
1920 * unlocked and both device-protected and credential-protected storage can
1921 * accessed safely.
1922 * <p>
1923 * If you need to run while the user is still locked (before they've entered
1924 * their lock pattern or PIN for the first time), you can listen for the
1925 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1926 * <p class="note">
1927 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001931
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 /**
1933 * Broadcast Action: This is broadcast when a user action should request a
1934 * temporary system dialog to dismiss. Some examples of temporary system
1935 * dialogs are the notification window-shade and the recent tasks dialog.
1936 */
1937 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1938 /**
1939 * Broadcast Action: Trigger the download and eventual installation
1940 * of a package.
1941 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001942 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001943 * <p class="note">This is a protected intent that can only be sent
1944 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001945 *
1946 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001948 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1951 /**
1952 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001953 * device. The data contains the name of the package. Note that the
1954 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001955 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001956 * <ul>
1957 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1958 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1959 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1960 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001961 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001962 * <p class="note">This is a protected intent that can only be sent
1963 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1967 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001968 * Broadcast Action: A new version of an application package has been
1969 * installed, replacing an existing version that was previously installed.
1970 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001971 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001972 * <ul>
1973 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1974 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001975 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001976 * <p class="note">This is a protected intent that can only be sent
1977 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001978 */
1979 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1980 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1981 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001982 * Broadcast Action: A new version of your application has been installed
1983 * over an existing one. This is only sent to the application that was
1984 * replaced. It does not contain any additional data; to receive it, just
1985 * use an intent filter for this action.
1986 *
1987 * <p class="note">This is a protected intent that can only be sent
1988 * by the system.
1989 */
1990 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1991 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 * Broadcast Action: An existing application package has been removed from
1994 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07001995 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001996 * <ul>
1997 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1998 * to the package.
1999 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2000 * application -- data and code -- is being removed.
2001 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2002 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2003 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002004 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002005 * <p class="note">This is a protected intent that can only be sent
2006 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2010 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002011 * Broadcast Action: An existing application package has been completely
2012 * removed from the device. The data contains the name of the package.
2013 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2014 * {@link #EXTRA_DATA_REMOVED} is true and
2015 * {@link #EXTRA_REPLACING} is false of that broadcast.
2016 *
2017 * <ul>
2018 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2019 * to the package.
2020 * </ul>
2021 *
2022 * <p class="note">This is a protected intent that can only be sent
2023 * by the system.
2024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_PACKAGE_FULLY_REMOVED
2027 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2028 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002029 * Broadcast Action: An existing application package has been changed (for
2030 * example, a component has been enabled or disabled). The data contains
2031 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002032 * <ul>
2033 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002034 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002035 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002036 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2037 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002039 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002040 * <p class="note">This is a protected intent that can only be sent
2041 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002042 */
2043 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2044 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2045 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002046 * @hide
2047 * Broadcast Action: Ask system services if there is any reason to
2048 * restart the given package. The data contains the name of the
2049 * package.
2050 * <ul>
2051 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2052 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2053 * </ul>
2054 *
2055 * <p class="note">This is a protected intent that can only be sent
2056 * by the system.
2057 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002058 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2061 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002062 * Broadcast Action: The user has restarted a package, and all of its
2063 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002065 * be removed. Note that the restarted package does <em>not</em>
2066 * receive this broadcast.
2067 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002068 * <ul>
2069 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2070 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002071 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002072 * <p class="note">This is a protected intent that can only be sent
2073 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2077 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 * Broadcast Action: The user has cleared the data of a package. This should
2079 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002080 * its persistent data is erased and this broadcast sent.
2081 * Note that the cleared package does <em>not</em>
2082 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 * <ul>
2084 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2085 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002086 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2092 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002093 * Broadcast Action: Packages have been suspended.
2094 * <p>Includes the following extras:
2095 * <ul>
2096 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2097 * </ul>
2098 *
2099 * <p class="note">This is a protected intent that can only be sent
2100 * by the system. It is only sent to registered receivers.
2101 */
2102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2103 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2104 /**
2105 * Broadcast Action: Packages have been unsuspended.
2106 * <p>Includes the following extras:
2107 * <ul>
2108 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2109 * </ul>
2110 *
2111 * <p class="note">This is a protected intent that can only be sent
2112 * by the system. It is only sent to registered receivers.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2116 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002117 * Broadcast Action: A user ID has been removed from the system. The user
2118 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002119 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002122 */
2123 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2124 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002125
2126 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002127 * Broadcast Action: Sent to the installer package of an application when
2128 * that application is first launched (that is the first time it is moved
2129 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002130 *
2131 * <p class="note">This is a protected intent that can only be sent
2132 * by the system.
2133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2136
2137 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002138 * Broadcast Action: Sent to the system package verifier when a package
2139 * needs to be verified. The data contains the package URI.
2140 * <p class="note">
2141 * This is a protected intent that can only be sent by the system.
2142 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2146
2147 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002148 * Broadcast Action: Sent to the system package verifier when a package is
2149 * 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 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2155
2156 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002157 * Broadcast Action: Sent to the system intent filter verifier when an
2158 * intent filter needs to be verified. The data contains the filter data
2159 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002160 * <p class="note">
2161 * This is a protected intent that can only be sent by the system.
2162 * </p>
2163 *
2164 * @hide
2165 */
2166 @SystemApi
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2169
2170 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002171 * Broadcast Action: Resources for a set of packages (which were
2172 * previously unavailable) are currently
2173 * available since the media on which they exist is available.
2174 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2175 * list of packages whose availability changed.
2176 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2177 * list of uids of packages whose availability changed.
2178 * Note that the
2179 * packages in this list do <em>not</em> receive this broadcast.
2180 * The specified set of packages are now available on the system.
2181 * <p>Includes the following extras:
2182 * <ul>
2183 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2184 * whose resources(were previously unavailable) are currently available.
2185 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2186 * packages whose resources(were previously unavailable)
2187 * are currently available.
2188 * </ul>
2189 *
2190 * <p class="note">This is a protected intent that can only be sent
2191 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002192 */
2193 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002194 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2195 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002196
2197 /**
2198 * Broadcast Action: Resources for a set of packages are currently
2199 * unavailable since the media on which they exist is unavailable.
2200 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2201 * list of packages whose availability changed.
2202 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2203 * list of uids of packages whose availability changed.
2204 * The specified set of packages can no longer be
2205 * launched and are practically unavailable on the system.
2206 * <p>Inclues the following extras:
2207 * <ul>
2208 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2209 * whose resources are no longer available.
2210 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2211 * whose resources are no longer available.
2212 * </ul>
2213 *
2214 * <p class="note">This is a protected intent that can only be sent
2215 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002216 */
2217 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002218 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002219 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002220
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002221 /**
2222 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002223 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002224 * This should <em>only</em> be used to determine when the wallpaper
2225 * has changed to show the new wallpaper to the user. You should certainly
2226 * never, in response to this, change the wallpaper or other attributes of
2227 * it such as the suggested size. That would be crazy, right? You'd cause
2228 * all kinds of loops, especially if other apps are doing similar things,
2229 * right? Of course. So please don't do this.
2230 *
2231 * @deprecated Modern applications should use
2232 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2233 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2234 * shown behind their UI, rather than watching for this broadcast and
2235 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002236 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002237 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002238 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2239 /**
2240 * Broadcast Action: The current device {@link android.content.res.Configuration}
2241 * (orientation, locale, etc) has changed. When such a change happens, the
2242 * UIs (view hierarchy) will need to be rebuilt based on this new
2243 * information; for the most part, applications don't need to worry about
2244 * this, because the system will take care of stopping and restarting the
2245 * application to make sure it sees the new changes. Some system code that
2246 * can not be restarted will need to watch for this action and handle it
2247 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002248 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002249 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002250 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002251 * in manifests, only by explicitly registering for it with
2252 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2253 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002254 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002255 * <p class="note">This is a protected intent that can only be sent
2256 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002257 *
2258 * @see android.content.res.Configuration
2259 */
2260 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2261 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2262 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002263 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002264 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002265 * <p class="note">This is a protected intent that can only be sent
2266 * by the system.
2267 */
2268 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2269 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2270 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002271 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2272 * charging state, level, and other information about the battery.
2273 * See {@link android.os.BatteryManager} for documentation on the
2274 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002275 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002276 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002277 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002278 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002279 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002280 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2281 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2282 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2283 * broadcasts that are sent and can be received through manifest
2284 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002285 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002286 * <p class="note">This is a protected intent that can only be sent
2287 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 */
2289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2290 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2291 /**
2292 * Broadcast Action: Indicates low battery condition on the device.
2293 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002294 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002295 * <p class="note">This is a protected intent that can only be sent
2296 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 */
2298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2299 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2300 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002301 * Broadcast Action: Indicates the battery is now okay after being low.
2302 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2303 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002304 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002305 * <p class="note">This is a protected intent that can only be sent
2306 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002307 */
2308 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2309 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2310 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002311 * Broadcast Action: External power has been connected to the device.
2312 * This is intended for applications that wish to register specifically to this notification.
2313 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2314 * stay active to receive this notification. This action can be used to implement actions
2315 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002316 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002317 * <p class="note">This is a protected intent that can only be sent
2318 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002319 */
2320 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002321 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002322 /**
2323 * Broadcast Action: External power has been removed from the device.
2324 * This is intended for applications that wish to register specifically to this notification.
2325 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2326 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002327 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002328 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002329 * <p class="note">This is a protected intent that can only be sent
2330 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002331 */
2332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002333 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002334 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002335 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002336 * Broadcast Action: Device is shutting down.
2337 * This is broadcast when the device is being shut down (completely turned
2338 * off, not sleeping). Once the broadcast is complete, the final shutdown
2339 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002340 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002341 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002342 * <p class="note">This is a protected intent that can only be sent
2343 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002344 * <p>May include the following extras:
2345 * <ul>
2346 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2347 * shutdown is only for userspace processes. If not set, assumed to be false.
2348 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002349 */
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002351 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002352 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002353 * Activity Action: Start this activity to request system shutdown.
2354 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002355 * to request confirmation from the user before shutting down. The optional boolean
2356 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2357 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002358 *
2359 * <p class="note">This is a protected intent that can only be sent
2360 * by the system.
2361 *
2362 * {@hide}
2363 */
2364 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2365 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002366 * Broadcast Action: A sticky broadcast that indicates low memory
2367 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002369 * <p class="note">This is a protected intent that can only be sent
2370 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002371 */
2372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2373 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2374 /**
2375 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002376 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002377 * <p class="note">This is a protected intent that can only be sent
2378 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2381 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2382 /**
Jake Hambybb371632010-08-23 18:16:48 -07002383 * Broadcast Action: A sticky broadcast that indicates a memory full
2384 * condition on the device. This is intended for activities that want
2385 * to be able to fill the data partition completely, leaving only
2386 * enough free space to prevent system-wide SQLite failures.
2387 *
2388 * <p class="note">This is a protected intent that can only be sent
2389 * by the system.
2390 *
2391 * {@hide}
2392 */
2393 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2394 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2395 /**
2396 * Broadcast Action: Indicates memory full condition on the device
2397 * no longer exists.
2398 *
2399 * <p class="note">This is a protected intent that can only be sent
2400 * by the system.
2401 *
2402 * {@hide}
2403 */
2404 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2405 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2406 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002407 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2408 * and package management should be started.
2409 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2410 * notification.
2411 */
2412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2413 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2414 /**
2415 * Broadcast Action: The device has entered USB Mass Storage mode.
2416 * This is used mainly for the USB Settings panel.
2417 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2418 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002419 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002420 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002421 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002422 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2423
2424 /**
2425 * Broadcast Action: The device has exited USB Mass Storage mode.
2426 * This is used mainly for the USB Settings panel.
2427 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2428 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002429 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002430 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002431 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002432 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2433
2434 /**
2435 * Broadcast Action: External media has been removed.
2436 * The path to the mount point for the removed media is contained in the Intent.mData field.
2437 */
2438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2439 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2440
2441 /**
2442 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002443 * 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 -07002444 */
2445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2446 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2447
2448 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002449 * Broadcast Action: External media is present, and being disk-checked
2450 * 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 -08002451 */
2452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2453 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2454
2455 /**
2456 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2457 * 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 -08002458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2461
2462 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002464 * 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 -07002465 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2466 * media was mounted read only.
2467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2470
2471 /**
2472 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002473 * 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 -07002474 */
2475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2476 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2477
2478 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002479 * Broadcast Action: External media is no longer being shared via USB mass storage.
2480 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2481 *
2482 * @hide
2483 */
2484 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2485
2486 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002487 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2488 * The path to the mount point for the removed media is contained in the Intent.mData field.
2489 */
2490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2491 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2492
2493 /**
2494 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002495 * 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 -07002496 */
2497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2498 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2499
2500 /**
2501 * Broadcast Action: User has expressed the desire to remove the external storage media.
2502 * Applications should close all files they have open within the mount point when they receive this intent.
2503 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2504 */
2505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2506 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2507
2508 /**
2509 * Broadcast Action: The media scanner has started scanning a directory.
2510 * The path to the directory being scanned is contained in the Intent.mData field.
2511 */
2512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2513 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2514
2515 /**
2516 * Broadcast Action: The media scanner has finished scanning a directory.
2517 * The path to the scanned directory is contained in the Intent.mData field.
2518 */
2519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2520 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2521
2522 /**
2523 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2524 * The path to the file is contained in the Intent.mData field.
2525 */
2526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2527 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2528
2529 /**
2530 * Broadcast Action: The "Media Button" was pressed. Includes a single
2531 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2532 * caused the broadcast.
2533 */
2534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2535 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2536
2537 /**
2538 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2539 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2540 * caused the broadcast.
2541 */
2542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2543 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2544
2545 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2546 // location; they are not general-purpose actions.
2547
2548 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002549 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002550 */
2551 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2552 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2553 "android.intent.action.GTALK_CONNECTED";
2554
2555 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002556 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002557 */
2558 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2559 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2560 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002561
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002562 /**
2563 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002564 */
2565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2566 public static final String ACTION_INPUT_METHOD_CHANGED =
2567 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002568
2569 /**
2570 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2571 * more radios have been turned off or on. The intent will have the following extra value:</p>
2572 * <ul>
2573 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2574 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2575 * turned off</li>
2576 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002577 *
Peng Xua35b5532016-01-20 00:05:45 -08002578 * <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 -07002579 */
2580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2581 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2582
2583 /**
2584 * Broadcast Action: Some content providers have parts of their namespace
2585 * where they publish new events or items that the user may be especially
2586 * interested in. For these things, they may broadcast this action when the
2587 * set of interesting items change.
2588 *
2589 * For example, GmailProvider sends this notification when the set of unread
2590 * mail in the inbox changes.
2591 *
2592 * <p>The data of the intent identifies which part of which provider
2593 * changed. When queried through the content resolver, the data URI will
2594 * return the data set in question.
2595 *
2596 * <p>The intent will have the following extra values:
2597 * <ul>
2598 * <li><em>count</em> - The number of items in the data set. This is the
2599 * same as the number of items in the cursor returned by querying the
2600 * data URI. </li>
2601 * </ul>
2602 *
2603 * This intent will be sent at boot (if the count is non-zero) and when the
2604 * data set changes. It is possible for the data set to change without the
2605 * count changing (for example, if a new unread message arrives in the same
2606 * sync operation in which a message is archived). The phone should still
2607 * ring/vibrate/etc as normal in this case.
2608 */
2609 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2610 public static final String ACTION_PROVIDER_CHANGED =
2611 "android.intent.action.PROVIDER_CHANGED";
2612
2613 /**
2614 * Broadcast Action: Wired Headset plugged in or unplugged.
2615 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002616 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2617 * and documentation.
2618 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002619 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002620 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002623 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002624
2625 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002626 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2627 * <ul>
2628 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2629 * </ul>
2630 *
2631 * <p class="note">This is a protected intent that can only be sent
2632 * by the system.
2633 *
2634 * @hide
2635 */
2636 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2637 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2638 = "android.intent.action.ADVANCED_SETTINGS";
2639
2640 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002641 * Broadcast Action: Sent after application restrictions are changed.
2642 *
2643 * <p class="note">This is a protected intent that can only be sent
2644 * by the system.</p>
2645 */
2646 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2647 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2648 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2649
2650 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002651 * Broadcast Action: An outgoing call is about to be placed.
2652 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002653 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002654 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002655 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002656 * the phone number originally intended to be dialed.</li>
2657 * </ul>
2658 * <p>Once the broadcast is finished, the resultData is used as the actual
2659 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002660 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002661 * outgoing call in turn: for example, a parental control application
2662 * might verify that the user is authorized to place the call at that
2663 * time, then a number-rewriting application might add an area code if
2664 * one was not specified.</p>
2665 * <p>For consistency, any receiver whose purpose is to prohibit phone
2666 * calls should have a priority of 0, to ensure it will see the final
2667 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002668 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002669 * should have a positive priority.
2670 * Negative priorities are reserved for the system for this broadcast;
2671 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002672 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2673 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002674 * <p>Emergency calls cannot be intercepted using this mechanism, and
2675 * other calls cannot be modified to call emergency numbers using this
2676 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002677 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2678 * call to use their own service instead. Those apps should first prevent
2679 * the call from being placed by setting resultData to <code>null</code>
2680 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002681 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002682 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2683 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002684 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002685 * <p class="note">This is a protected intent that can only be sent
2686 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002687 */
2688 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2689 public static final String ACTION_NEW_OUTGOING_CALL =
2690 "android.intent.action.NEW_OUTGOING_CALL";
2691
2692 /**
2693 * Broadcast Action: Have the device reboot. This is only for use by
2694 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002695 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002696 * <p class="note">This is a protected intent that can only be sent
2697 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 */
2699 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2700 public static final String ACTION_REBOOT =
2701 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002702
Wei Huang97ecc9c2009-05-11 17:44:20 -07002703 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002704 * Broadcast Action: A sticky broadcast for changes in the physical
2705 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002706 *
2707 * <p>The intent will have the following extra values:
2708 * <ul>
2709 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002710 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002711 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002712 * <p>This is intended for monitoring the current physical dock state.
2713 * See {@link android.app.UiModeManager} for the normal API dealing with
2714 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002715 */
2716 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2717 public static final String ACTION_DOCK_EVENT =
2718 "android.intent.action.DOCK_EVENT";
2719
2720 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002721 * Broadcast Action: A broadcast when idle maintenance can be started.
2722 * This means that the user is not interacting with the device and is
2723 * not expected to do so soon. Typical use of the idle maintenance is
2724 * to perform somehow expensive tasks that can be postponed at a moment
2725 * when they will not degrade user experience.
2726 * <p>
2727 * <p class="note">In order to keep the device responsive in case of an
2728 * unexpected user interaction, implementations of a maintenance task
2729 * should be interruptible. In such a scenario a broadcast with action
2730 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2731 * should not do the maintenance work in
2732 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2733 * maintenance service by {@link Context#startService(Intent)}. Also
2734 * you should hold a wake lock while your maintenance service is running
2735 * to prevent the device going to sleep.
2736 * </p>
2737 * <p>
2738 * <p class="note">This is a protected intent that can only be sent by
2739 * the system.
2740 * </p>
2741 *
2742 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002743 *
2744 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002745 */
2746 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2747 public static final String ACTION_IDLE_MAINTENANCE_START =
2748 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2749
2750 /**
2751 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2752 * This means that the user was not interacting with the device as a result
2753 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2754 * was sent and now the user started interacting with the device. Typical
2755 * use of the idle maintenance is to perform somehow expensive tasks that
2756 * can be postponed at a moment when they will not degrade user experience.
2757 * <p>
2758 * <p class="note">In order to keep the device responsive in case of an
2759 * unexpected user interaction, implementations of a maintenance task
2760 * should be interruptible. Hence, on receiving a broadcast with this
2761 * action, the maintenance task should be interrupted as soon as possible.
2762 * In other words, you should not do the maintenance work in
2763 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2764 * maintenance service that was started on receiving of
2765 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2766 * lock you acquired when your maintenance service started.
2767 * </p>
2768 * <p class="note">This is a protected intent that can only be sent
2769 * by the system.
2770 *
2771 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002772 *
2773 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002774 */
2775 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2776 public static final String ACTION_IDLE_MAINTENANCE_END =
2777 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2778
2779 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002780 * Broadcast Action: a remote intent is to be broadcasted.
2781 *
2782 * A remote intent is used for remote RPC between devices. The remote intent
2783 * is serialized and sent from one device to another device. The receiving
2784 * device parses the remote intent and broadcasts it. Note that anyone can
2785 * broadcast a remote intent. However, if the intent receiver of the remote intent
2786 * does not trust intent broadcasts from arbitrary intent senders, it should require
2787 * the sender to hold certain permissions so only trusted sender's broadcast will be
2788 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002789 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002790 */
2791 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002792 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002793
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002794 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002795 * Broadcast Action: This is broadcast once when the user is booting after a
2796 * system update. It can be used to perform cleanup or upgrades after a
2797 * system update.
2798 * <p>
2799 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2800 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2801 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2802 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002803 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002804 * @hide
2805 */
2806 public static final String ACTION_PRE_BOOT_COMPLETED =
2807 "android.intent.action.PRE_BOOT_COMPLETED";
2808
Amith Yamasani13593602012-03-22 16:16:17 -07002809 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002810 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002811 * on restricted users. The broadcast intent contains an extra
2812 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2813 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2814 * String[] depending on the restriction type.<p/>
2815 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002816 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2817 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2818 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002819 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2820 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002821 * @see RestrictionEntry
2822 */
2823 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2824 "android.intent.action.GET_RESTRICTION_ENTRIES";
2825
2826 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002827 * Sent the first time a user is starting, to allow system apps to
2828 * perform one time initialization. (This will not be seen by third
2829 * party applications because a newly initialized user does not have any
2830 * third party applications installed for it.) This is sent early in
2831 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002832 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2833 * broadcast, since it is part of a visible user interaction; be as quick
2834 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002835 */
2836 public static final String ACTION_USER_INITIALIZE =
2837 "android.intent.action.USER_INITIALIZE";
2838
2839 /**
2840 * Sent when a user switch is happening, causing the process's user to be
2841 * brought to the foreground. This is only sent to receivers registered
2842 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2843 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002844 * foreground. This is sent as a foreground
2845 * broadcast, since it is part of a visible user interaction; be as quick
2846 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002847 */
2848 public static final String ACTION_USER_FOREGROUND =
2849 "android.intent.action.USER_FOREGROUND";
2850
2851 /**
2852 * Sent when a user switch is happening, causing the process's user to be
2853 * sent to the background. This is only sent to receivers registered
2854 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2855 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002856 * background. This is sent as a foreground
2857 * broadcast, since it is part of a visible user interaction; be as quick
2858 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002859 */
2860 public static final String ACTION_USER_BACKGROUND =
2861 "android.intent.action.USER_BACKGROUND";
2862
2863 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002864 * Broadcast sent to the system when a user is added. Carries an extra
2865 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2866 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002867 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002868 * @hide
2869 */
2870 public static final String ACTION_USER_ADDED =
2871 "android.intent.action.USER_ADDED";
2872
2873 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002874 * Broadcast sent by the system when a user is started. Carries an extra
2875 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002876 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002877 * that has been started. This is sent as a foreground
2878 * broadcast, since it is part of a visible user interaction; be as quick
2879 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002880 * @hide
2881 */
2882 public static final String ACTION_USER_STARTED =
2883 "android.intent.action.USER_STARTED";
2884
2885 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002886 * Broadcast sent when a user is in the process of starting. Carries an extra
2887 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2888 * sent to registered receivers, not manifest receivers. It is sent to all
2889 * users (including the one that is being started). You must hold
2890 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2891 * this broadcast. This is sent as a background broadcast, since
2892 * its result is not part of the primary UX flow; to safely keep track of
2893 * started/stopped state of a user you can use this in conjunction with
2894 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2895 * other user state broadcasts since those are foreground broadcasts so can
2896 * execute in a different order.
2897 * @hide
2898 */
2899 public static final String ACTION_USER_STARTING =
2900 "android.intent.action.USER_STARTING";
2901
2902 /**
2903 * Broadcast sent when a user is going to be stopped. Carries an extra
2904 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2905 * sent to registered receivers, not manifest receivers. It is sent to all
2906 * users (including the one that is being stopped). You must hold
2907 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2908 * this broadcast. The user will not stop until all receivers have
2909 * handled the broadcast. This is sent as a background broadcast, since
2910 * its result is not part of the primary UX flow; to safely keep track of
2911 * started/stopped state of a user you can use this in conjunction with
2912 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2913 * other user state broadcasts since those are foreground broadcasts so can
2914 * execute in a different order.
2915 * @hide
2916 */
2917 public static final String ACTION_USER_STOPPING =
2918 "android.intent.action.USER_STOPPING";
2919
2920 /**
2921 * Broadcast sent to the system when a user is stopped. Carries an extra
2922 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2923 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2924 * specific package. This is only sent to registered receivers, not manifest
2925 * receivers. It is sent to all running users <em>except</em> the one that
2926 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002927 * @hide
2928 */
2929 public static final String ACTION_USER_STOPPED =
2930 "android.intent.action.USER_STOPPED";
2931
2932 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002933 * 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 -07002934 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002935 * one that has been removed. The user will not be completely removed until all receivers have
2936 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002937 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002938 * @hide
2939 */
2940 public static final String ACTION_USER_REMOVED =
2941 "android.intent.action.USER_REMOVED";
2942
2943 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002944 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002945 * the userHandle of the user to become the current one. This is only sent to
2946 * registered receivers, not manifest receivers. It is sent to all running users.
2947 * You must hold
2948 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002949 * @hide
2950 */
2951 public static final String ACTION_USER_SWITCHED =
2952 "android.intent.action.USER_SWITCHED";
2953
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002954 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002955 * Broadcast Action: Sent when the credential-encrypted private storage has
2956 * become unlocked for the target user. This is only sent to registered
2957 * receivers, not manifest receivers.
2958 */
2959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2960 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2961
2962 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002963 * Broadcast sent to the system when a user's information changes. Carries an extra
2964 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002965 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002966 * @hide
2967 */
2968 public static final String ACTION_USER_INFO_CHANGED =
2969 "android.intent.action.USER_INFO_CHANGED";
2970
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002971 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002972 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2973 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002974 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2975 * that need to display merged content across both primary and managed profiles need to
2976 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002977 * not manifest receivers.
2978 */
2979 public static final String ACTION_MANAGED_PROFILE_ADDED =
2980 "android.intent.action.MANAGED_PROFILE_ADDED";
2981
2982 /**
2983 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002984 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2985 * Only applications (for example Launchers) that need to display merged content across both
2986 * primary and managed profiles need to worry about this broadcast. This is only sent to
2987 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002988 */
2989 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2990 "android.intent.action.MANAGED_PROFILE_REMOVED";
2991
2992 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00002993 * Broadcast sent to the primary user when the credential-encrypted private storage for
2994 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
2995 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
2996 * Launchers) that need to display merged content across both primary and managed profiles
2997 * need to worry about this broadcast. This is only sent to registered receivers,
2998 * not manifest receivers.
2999 */
3000 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3001 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3002
3003 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003004 * Broadcast sent to the primary user when an associated managed profile has become available.
3005 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003006 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3007 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3008 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003009 */
Rubin Xue95057a2016-04-01 16:49:25 +01003010 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3011 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3012
3013 /**
3014 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3015 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3016 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3017 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3018 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3019 */
3020 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3021 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003022
3023 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003024 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3025 */
3026 public static final String ACTION_QUICK_CLOCK =
3027 "android.intent.action.QUICK_CLOCK";
3028
Michael Wright0087a142013-02-05 16:29:39 -08003029 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003030 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003031 * @hide
3032 */
3033 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3034 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3035
Justin Kohd378ad72013-04-01 12:18:26 -07003036 /**
3037 * Broadcast Action: A global button was pressed. Includes a single
3038 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3039 * caused the broadcast.
3040 * @hide
3041 */
3042 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3043
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003044 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003045 * Broadcast Action: Sent when media resource is granted.
3046 * <p>
3047 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3048 * granted.
3049 * </p>
3050 * <p class="note">
3051 * This is a protected intent that can only be sent by the system.
3052 * </p>
3053 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003054 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003055 * </p>
3056 *
3057 * @hide
3058 */
3059 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3060 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3061
3062 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003063 * Activity Action: Allow the user to select and return one or more existing
3064 * documents. When invoked, the system will display the various
3065 * {@link DocumentsProvider} instances installed on the device, letting the
3066 * user interactively navigate through them. These documents include local
3067 * media, such as photos and video, and documents provided by installed
3068 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003069 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003070 * Each document is represented as a {@code content://} URI backed by a
3071 * {@link DocumentsProvider}, which can be opened as a stream with
3072 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3073 * {@link android.provider.DocumentsContract.Document} metadata.
3074 * <p>
3075 * All selected documents are returned to the calling application with
3076 * persistable read and write permission grants. If you want to maintain
3077 * access to the documents across device reboots, you need to explicitly
3078 * take the persistable permissions using
3079 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3080 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003081 * Callers must indicate the acceptable document MIME types through
3082 * {@link #setType(String)}. For example, to select photos, use
3083 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3084 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3085 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003086 * <p>
3087 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003088 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3089 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003090 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003091 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3092 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003093 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003094 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003095 * Output: The URI of the item that was picked, returned in
3096 * {@link #getData()}. This must be a {@code content://} URI so that any
3097 * receiver can access it. If multiple documents were selected, they are
3098 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003099 *
3100 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003101 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003102 * @see #ACTION_CREATE_DOCUMENT
3103 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003104 */
3105 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3106 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3107
3108 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003109 * Activity Action: Allow the user to create a new document. When invoked,
3110 * the system will display the various {@link DocumentsProvider} instances
3111 * installed on the device, letting the user navigate through them. The
3112 * returned document may be a newly created document with no content, or it
3113 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003114 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003115 * Each document is represented as a {@code content://} URI backed by a
3116 * {@link DocumentsProvider}, which can be opened as a stream with
3117 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3118 * {@link android.provider.DocumentsContract.Document} metadata.
3119 * <p>
3120 * Callers must indicate the concrete MIME type of the document being
3121 * created by setting {@link #setType(String)}. This MIME type cannot be
3122 * changed after the document is created.
3123 * <p>
3124 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3125 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003126 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003127 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3128 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003129 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003130 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003131 * Output: The URI of the item that was created. This must be a
3132 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003133 *
3134 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003135 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003136 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003137 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003138 */
3139 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3140 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3141
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003142 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003143 * Activity Action: Allow the user to pick a directory subtree. When
3144 * invoked, the system will display the various {@link DocumentsProvider}
3145 * instances installed on the device, letting the user navigate through
3146 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003147 * <p>
3148 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003149 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3150 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3151 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003152 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003153 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003154 *
3155 * @see DocumentsContract
3156 */
3157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003158 public static final String
3159 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003160
Felipe Lemec7b1f892016-01-15 15:02:31 -08003161 /**
Peng Xua35b5532016-01-20 00:05:45 -08003162 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3163 * exisiting sensor being disconnected.
3164 *
3165 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3166 *
3167 * {@hide}
3168 */
3169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3170 public static final String
3171 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3172
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003173 /** {@hide} */
3174 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3175
Christopher Tate6597e342015-02-17 12:15:25 -08003176 /**
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003177 * Boolean intent extra to be used with {@link ACTION_MASTER_CLEAR} in order to force a factory
3178 * reset even if {@link android.os.UserManager.DISALLOW_FACTORY_RESET} is set.
3179 * @hide
3180 */
3181 public static final String EXTRA_FORCE_MASTER_CLEAR =
3182 "android.intent.extra.FORCE_MASTER_CLEAR";
3183
3184 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003185 * Broadcast action: report that a settings element is being restored from backup. The intent
3186 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3187 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3188 * is the value of that settings entry prior to the restore operation. All of these values are
3189 * represented as strings.
3190 *
3191 * <p>This broadcast is sent only for settings provider entries known to require special handling
3192 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3193 * the provider's backup agent implementation.
3194 *
3195 * @see #EXTRA_SETTING_NAME
3196 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3197 * @see #EXTRA_SETTING_NEW_VALUE
3198 * {@hide}
3199 */
3200 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3201
3202 /** {@hide} */
3203 public static final String EXTRA_SETTING_NAME = "setting_name";
3204 /** {@hide} */
3205 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3206 /** {@hide} */
3207 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3208
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003209 /**
3210 * Activity Action: Process a piece of text.
3211 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3212 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3213 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3214 */
3215 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3216 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3217 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003218 * The name of the extra used to define the text to be processed, as a
3219 * CharSequence. Note that this may be a styled CharSequence, so you must use
3220 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003221 */
3222 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3223 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003224 * 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 +00003225 */
3226 public static final String EXTRA_PROCESS_TEXT_READONLY =
3227 "android.intent.extra.PROCESS_TEXT_READONLY";
3228
Bryce Leebc58f592015-09-25 16:43:01 -07003229 /**
3230 * Broadcast action: reports when a new thermal event has been reached. When the device
3231 * is reaching its maximum temperatue, the thermal level reported
3232 * {@hide}
3233 */
3234 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3235 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3236
3237 /** {@hide} */
3238 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3239
3240 /**
3241 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003242 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003243 * {@hide}
3244 */
3245 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3246
3247 /**
3248 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003249 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003250 * {@hide}
3251 */
3252 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3253
3254 /**
3255 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003256 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003257 * {@hide}
3258 */
3259 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3260
3261
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003262 // ---------------------------------------------------------------------
3263 // ---------------------------------------------------------------------
3264 // Standard intent categories (see addCategory()).
3265
3266 /**
3267 * Set if the activity should be an option for the default action
3268 * (center press) to perform on a piece of data. Setting this will
3269 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003270 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003271 * Intent when initiating an action -- it is for use in intent filters
3272 * specified in packages.
3273 */
3274 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3275 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3276 /**
3277 * Activities that can be safely invoked from a browser must support this
3278 * category. For example, if the user is viewing a web page or an e-mail
3279 * and clicks on a link in the text, the Intent generated execute that
3280 * link will require the BROWSABLE category, so that only activities
3281 * supporting this category will be considered as possible actions. By
3282 * supporting this category, you are promising that there is nothing
3283 * damaging (without user intervention) that can happen by invoking any
3284 * matching Intent.
3285 */
3286 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3287 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3288 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003289 * Categories for activities that can participate in voice interaction.
3290 * An activity that supports this category must be prepared to run with
3291 * no UI shown at all (though in some case it may have a UI shown), and
3292 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3293 */
3294 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3295 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3296 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003297 * Set if the activity should be considered as an alternative action to
3298 * the data the user is currently viewing. See also
3299 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3300 * applies to the selection in a list of items.
3301 *
3302 * <p>Supporting this category means that you would like your activity to be
3303 * displayed in the set of alternative things the user can do, usually as
3304 * part of the current activity's options menu. You will usually want to
3305 * include a specific label in the &lt;intent-filter&gt; of this action
3306 * describing to the user what it does.
3307 *
3308 * <p>The action of IntentFilter with this category is important in that it
3309 * describes the specific action the target will perform. This generally
3310 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3311 * a specific name such as "com.android.camera.action.CROP. Only one
3312 * alternative of any particular action will be shown to the user, so using
3313 * a specific action like this makes sure that your alternative will be
3314 * displayed while also allowing other applications to provide their own
3315 * overrides of that particular action.
3316 */
3317 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3318 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3319 /**
3320 * Set if the activity should be considered as an alternative selection
3321 * action to the data the user has currently selected. This is like
3322 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3323 * of items from which the user can select, giving them alternatives to the
3324 * default action that will be performed on it.
3325 */
3326 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3327 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3328 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003329 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003330 */
3331 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3332 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3333 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003334 * Should be displayed in the top-level launcher.
3335 */
3336 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3337 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3338 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003339 * Indicates an activity optimized for Leanback mode, and that should
3340 * be displayed in the Leanback launcher.
3341 */
3342 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3343 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3344 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003345 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3346 * @hide
3347 */
3348 @SystemApi
3349 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3350 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003351 * Provides information about the package it is in; typically used if
3352 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3353 * a front-door to the user without having to be shown in the all apps list.
3354 */
3355 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3356 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3357 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003358 * This is the home activity, that is the first activity that is displayed
3359 * when the device boots.
3360 */
3361 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3362 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3363 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003364 * This is the home activity that is displayed when the device is finished setting up and ready
3365 * for use.
3366 * @hide
3367 */
3368 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3369 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3370 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003371 * This is the setup wizard activity, that is the first activity that is displayed
3372 * when the user sets up the device for the first time.
3373 * @hide
3374 */
3375 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3376 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3377 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003378 * This activity is a preference panel.
3379 */
3380 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3381 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3382 /**
3383 * This activity is a development preference panel.
3384 */
3385 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3386 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3387 /**
3388 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003389 */
3390 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3391 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3392 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003393 * This activity allows the user to browse and download new applications.
3394 */
3395 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3396 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3397 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003398 * This activity may be exercised by the monkey or other automated test tools.
3399 */
3400 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3401 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3402 /**
3403 * To be used as a test (not part of the normal user experience).
3404 */
3405 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3406 /**
3407 * To be used as a unit test (run through the Test Harness).
3408 */
3409 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3410 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003411 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003412 * experience).
3413 */
3414 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003415
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003416 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003417 * Used to indicate that an intent only wants URIs that can be opened with
3418 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3419 * must support at least the columns defined in {@link OpenableColumns} when
3420 * queried.
3421 *
3422 * @see #ACTION_GET_CONTENT
3423 * @see #ACTION_OPEN_DOCUMENT
3424 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003425 */
3426 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3427 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3428
3429 /**
3430 * To be used as code under test for framework instrumentation tests.
3431 */
3432 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3433 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003434 /**
3435 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003436 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3437 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003438 */
3439 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3440 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3441 /**
3442 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003443 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3444 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003445 */
3446 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3447 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003448 /**
3449 * An activity to run when device is inserted into a analog (low end) dock.
3450 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3451 * information, see {@link android.app.UiModeManager}.
3452 */
3453 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3454 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3455
3456 /**
3457 * An activity to run when device is inserted into a digital (high end) dock.
3458 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3459 * information, see {@link android.app.UiModeManager}.
3460 */
3461 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3462 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003463
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003464 /**
3465 * Used to indicate that the activity can be used in a car environment.
3466 */
3467 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3468 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3469
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003470 // ---------------------------------------------------------------------
3471 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003472 // Application launch intent categories (see addCategory()).
3473
3474 /**
3475 * Used with {@link #ACTION_MAIN} to launch the browser application.
3476 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003477 * <p>NOTE: This should not be used as the primary key of an Intent,
3478 * since it will not result in the app launching with the correct
3479 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003480 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003481 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003482 */
3483 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3484 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3485
3486 /**
3487 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3488 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003489 * <p>NOTE: This should not be used as the primary key of an Intent,
3490 * since it will not result in the app launching with the correct
3491 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003492 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003493 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003494 */
3495 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3496 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3497
3498 /**
3499 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3500 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003501 * <p>NOTE: This should not be used as the primary key of an Intent,
3502 * since it will not result in the app launching with the correct
3503 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003504 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003505 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003506 */
3507 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3508 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3509
3510 /**
3511 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3512 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003513 * <p>NOTE: This should not be used as the primary key of an Intent,
3514 * since it will not result in the app launching with the correct
3515 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003516 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003517 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003518 */
3519 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3520 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3521
3522 /**
3523 * Used with {@link #ACTION_MAIN} to launch the email application.
3524 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003525 * <p>NOTE: This should not be used as the primary key of an Intent,
3526 * since it will not result in the app launching with the correct
3527 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003528 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003529 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003530 */
3531 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3532 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3533
3534 /**
3535 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3536 * The activity should be able to view and manipulate image and video files
3537 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003538 * <p>NOTE: This should not be used as the primary key of an Intent,
3539 * since it will not result in the app launching with the correct
3540 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003541 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003542 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003543 */
3544 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3545 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3546
3547 /**
3548 * Used with {@link #ACTION_MAIN} to launch the maps application.
3549 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003550 * <p>NOTE: This should not be used as the primary key of an Intent,
3551 * since it will not result in the app launching with the correct
3552 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003553 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003554 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003555 */
3556 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3557 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3558
3559 /**
3560 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3561 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003562 * <p>NOTE: This should not be used as the primary key of an Intent,
3563 * since it will not result in the app launching with the correct
3564 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003565 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003566 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003567 */
3568 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3569 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3570
3571 /**
3572 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003573 * The activity should be able to play, browse, or manipulate music files
3574 * stored on the device.
3575 * <p>NOTE: This should not be used as the primary key of an Intent,
3576 * since it will not result in the app launching with the correct
3577 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003578 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003579 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003580 */
3581 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3582 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3583
3584 // ---------------------------------------------------------------------
3585 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003586 // Standard extra data keys.
3587
3588 /**
3589 * The initial data to place in a newly created record. Use with
3590 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3591 * fields as would be given to the underlying ContentProvider.insert()
3592 * call.
3593 */
3594 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3595
3596 /**
3597 * A constant CharSequence that is associated with the Intent, used with
3598 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3599 * this may be a styled CharSequence, so you must use
3600 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3601 * retrieve it.
3602 */
3603 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3604
3605 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003606 * A constant String that is associated with the Intent, used with
3607 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3608 * as HTML formatted text. Note that you <em>must</em> also supply
3609 * {@link #EXTRA_TEXT}.
3610 */
3611 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3612
3613 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003614 * A content: URI holding a stream of data associated with the Intent,
3615 * used with {@link #ACTION_SEND} to supply the data being sent.
3616 */
3617 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3618
3619 /**
3620 * A String[] holding e-mail addresses that should be delivered to.
3621 */
3622 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3623
3624 /**
3625 * A String[] holding e-mail addresses that should be carbon copied.
3626 */
3627 public static final String EXTRA_CC = "android.intent.extra.CC";
3628
3629 /**
3630 * A String[] holding e-mail addresses that should be blind carbon copied.
3631 */
3632 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3633
3634 /**
3635 * A constant string holding the desired subject line of a message.
3636 */
3637 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3638
3639 /**
3640 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003641 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003642 */
3643 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3644
3645 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003646 * An int representing the user id to be used.
3647 *
3648 * @hide
3649 */
3650 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3651
3652 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003653 * An int representing the task id to be retrieved. This is used when a launch from recents is
3654 * intercepted by another action such as credentials confirmation to remember which task should
3655 * be resumed when complete.
3656 *
3657 * @hide
3658 */
3659 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3660
3661 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003662 * An Intent[] describing additional, alternate choices you would like shown with
3663 * {@link #ACTION_CHOOSER}.
3664 *
3665 * <p>An app may be capable of providing several different payload types to complete a
3666 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3667 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3668 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3669 * photo data or a hosted link where the photos can be viewed.</p>
3670 *
3671 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3672 * first/primary/preferred intent in the set. Additional intents specified in
3673 * this extra are ordered; by default intents that appear earlier in the array will be
3674 * preferred over intents that appear later in the array as matches for the same
3675 * target component. To alter this preference, a calling app may also supply
3676 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3677 */
3678 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3679
3680 /**
Adam Powell52c39212016-04-07 15:14:18 -07003681 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3682 * and omitted from a list of components presented to the user.
3683 *
3684 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3685 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3686 * from your own package or other apps from your organization if the idea of sending to those
3687 * targets would be redundant with other app functionality. Filtered components will not
3688 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3689 */
3690 public static final String EXTRA_EXCLUDE_COMPONENTS
3691 = "android.intent.extra.EXCLUDE_COMPONENTS";
3692
3693 /**
3694 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3695 * describing additional high-priority deep-link targets for the chooser to present to the user.
3696 *
3697 * <p>Targets provided in this way will be presented inline with all other targets provided
3698 * by services from other apps. They will be prioritized before other service targets, but
3699 * after those targets provided by sources that the user has manually pinned to the front.</p>
3700 *
3701 * @see #ACTION_CHOOSER
3702 */
3703 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3704
3705 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003706 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3707 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3708 *
3709 * <p>An app preparing an action for another app to complete may wish to allow the user to
3710 * disambiguate between several options for completing the action based on the chosen target
3711 * or otherwise refine the action before it is invoked.
3712 * </p>
3713 *
3714 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3715 * <ul>
3716 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3717 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3718 * chosen target beyond the first</li>
3719 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3720 * should fill in and send once the disambiguation is complete</li>
3721 * </ul>
3722 */
3723 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3724 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3725
3726 /**
3727 * A {@link ResultReceiver} used to return data back to the sender.
3728 *
3729 * <p>Used to complete an app-specific
3730 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3731 *
3732 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3733 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3734 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3735 * when the user selects a target component from the chooser. It is up to the recipient
3736 * to send a result to this ResultReceiver to signal that disambiguation is complete
3737 * and that the chooser should invoke the user's choice.</p>
3738 *
3739 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3740 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3741 * to match and fill in the final Intent or ChooserTarget before starting it.
3742 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3743 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3744 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3745 *
3746 * <p>The result code passed to the ResultReceiver should be
3747 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3748 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3749 * the chooser should finish without starting a target.</p>
3750 */
3751 public static final String EXTRA_RESULT_RECEIVER
3752 = "android.intent.extra.RESULT_RECEIVER";
3753
3754 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003755 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003756 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003757 */
3758 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3759
3760 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003761 * A Parcelable[] of {@link Intent} or
3762 * {@link android.content.pm.LabeledIntent} objects as set with
3763 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3764 * a the front of the list of choices, when shown to the user with a
3765 * {@link #ACTION_CHOOSER}.
3766 */
3767 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3768
3769 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003770 * A {@link IntentSender} to start after ephemeral installation success.
3771 * @hide
3772 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003773 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3774
3775 /**
3776 * A {@link IntentSender} to start after ephemeral installation failure.
3777 * @hide
3778 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003779 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3780
3781 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003782 * A Bundle forming a mapping of potential target package names to different extras Bundles
3783 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3784 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3785 * be currently installed on the device.
3786 *
3787 * <p>An application may choose to provide alternate extras for the case where a user
3788 * selects an activity from a predetermined set of target packages. If the activity
3789 * the user selects from the chooser belongs to a package with its package name as
3790 * a key in this bundle, the corresponding extras for that package will be merged with
3791 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3792 * extra has the same key as an extra already present in the intent it will overwrite
3793 * the extra from the intent.</p>
3794 *
3795 * <p><em>Examples:</em>
3796 * <ul>
3797 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3798 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3799 * parameters for that target.</li>
3800 * <li>An application may offer additional metadata for known targets of a given intent
3801 * to pass along information only relevant to that target such as account or content
3802 * identifiers already known to that application.</li>
3803 * </ul></p>
3804 */
3805 public static final String EXTRA_REPLACEMENT_EXTRAS =
3806 "android.intent.extra.REPLACEMENT_EXTRAS";
3807
3808 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003809 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3810 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3811 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3812 * {@link ComponentName} of the chosen component.
3813 *
3814 * <p>In some situations this callback may never come, for example if the user abandons
3815 * the chooser, switches to another task or any number of other reasons. Apps should not
3816 * be written assuming that this callback will always occur.</p>
3817 */
3818 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3819 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3820
3821 /**
3822 * The {@link ComponentName} chosen by the user to complete an action.
3823 *
3824 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3825 */
3826 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3827
3828 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003829 * A {@link android.view.KeyEvent} object containing the event that
3830 * triggered the creation of the Intent it is in.
3831 */
3832 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3833
3834 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003835 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3836 * before shutting down.
3837 *
3838 * {@hide}
3839 */
3840 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3841
3842 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003843 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3844 * requested by the user.
3845 *
3846 * {@hide}
3847 */
3848 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3849 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3850
3851 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003852 * 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 -07003853 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3854 * of restarting the application.
3855 */
3856 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3857
3858 /**
3859 * A String holding the phone number originally entered in
3860 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3861 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3862 */
3863 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003864
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003865 /**
3866 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3867 * intents to supply the uid the package had been assigned. Also an optional
3868 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3869 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3870 * purpose.
3871 */
3872 public static final String EXTRA_UID = "android.intent.extra.UID";
3873
3874 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003875 * @hide String array of package names.
3876 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003877 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003878 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3879
3880 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003881 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3882 * intents to indicate whether this represents a full uninstall (removing
3883 * both the code and its data) or a partial uninstall (leaving its data,
3884 * implying that this is an update).
3885 */
3886 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003887
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003888 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003889 * @hide
3890 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3891 * intents to indicate that at this point the package has been removed for
3892 * all users on the device.
3893 */
3894 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3895 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3896
3897 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003898 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3899 * intents to indicate that this is a replacement of the package, so this
3900 * broadcast will immediately be followed by an add broadcast for a
3901 * different version of the same package.
3902 */
3903 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003904
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003905 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003906 * Used as an int extra field in {@link android.app.AlarmManager} intents
3907 * to tell the application being invoked how many pending alarms are being
3908 * delievered with the intent. For one-shot alarms this will always be 1.
3909 * For recurring alarms, this might be greater than 1 if the device was
3910 * asleep or powered off at the time an earlier alarm would have been
3911 * delivered.
3912 */
3913 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003914
Jacek Surazski86b6c532009-05-13 14:38:28 +02003915 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003916 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3917 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003918 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3919 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003920 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3921 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3922 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003923 */
3924 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3925
3926 /**
3927 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3928 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003929 */
3930 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3931
3932 /**
3933 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3934 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003935 */
3936 public static final int EXTRA_DOCK_STATE_DESK = 1;
3937
3938 /**
3939 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3940 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003941 */
3942 public static final int EXTRA_DOCK_STATE_CAR = 2;
3943
3944 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003945 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3946 * to represent that the phone is in a analog (low end) dock.
3947 */
3948 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3949
3950 /**
3951 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3952 * to represent that the phone is in a digital (high end) dock.
3953 */
3954 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3955
3956 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003957 * Boolean that can be supplied as meta-data with a dock activity, to
3958 * indicate that the dock should take over the home key when it is active.
3959 */
3960 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003961
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003962 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003963 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3964 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003965 */
3966 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3967
3968 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003969 * Used in the extra field in the remote intent. It's astring token passed with the
3970 * remote intent.
3971 */
3972 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3973 "android.intent.extra.remote_intent_token";
3974
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003975 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003976 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003977 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003978 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003979 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003980 "android.intent.extra.changed_component_name";
3981
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003982 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003983 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003984 * and contains a string array of all of the components that have changed. If
3985 * the state of the overall package has changed, then it will contain an entry
3986 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003987 */
3988 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3989 "android.intent.extra.changed_component_name_list";
3990
3991 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003992 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003993 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00003994 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
3995 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
3996 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003997 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003998 */
3999 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4000 "android.intent.extra.changed_package_list";
4001
4002 /**
4003 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004004 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4005 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004006 * and contains an integer array of uids of all of the components
4007 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004008 */
4009 public static final String EXTRA_CHANGED_UID_LIST =
4010 "android.intent.extra.changed_uid_list";
4011
4012 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004013 * @hide
4014 * Magic extra system code can use when binding, to give a label for
4015 * who it is that has bound to a service. This is an integer giving
4016 * a framework string resource that can be displayed to the user.
4017 */
4018 public static final String EXTRA_CLIENT_LABEL =
4019 "android.intent.extra.client_label";
4020
4021 /**
4022 * @hide
4023 * Magic extra system code can use when binding, to give a PendingIntent object
4024 * that can be launched for the user to disable the system's use of this
4025 * service.
4026 */
4027 public static final String EXTRA_CLIENT_INTENT =
4028 "android.intent.extra.client_intent";
4029
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004030 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004031 * Extra used to indicate that an intent should only return data that is on
4032 * the local device. This is a boolean extra; the default is false. If true,
4033 * an implementation should only allow the user to select data that is
4034 * already on the device, not requiring it be downloaded from a remote
4035 * service when opened.
4036 *
4037 * @see #ACTION_GET_CONTENT
4038 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004039 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004040 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004041 */
4042 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004043 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004044
Amith Yamasani13593602012-03-22 16:16:17 -07004045 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004046 * Extra used to indicate that an intent can allow the user to select and
4047 * return multiple items. This is a boolean extra; the default is false. If
4048 * true, an implementation is allowed to present the user with a UI where
4049 * they can pick multiple items that are all returned to the caller. When
4050 * this happens, they should be returned as the {@link #getClipData()} part
4051 * of the result Intent.
4052 *
4053 * @see #ACTION_GET_CONTENT
4054 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004055 */
4056 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004057 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004058
4059 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004060 * The integer userHandle carried with broadcast intents related to addition, removal and
4061 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4062 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4063 *
Amith Yamasani13593602012-03-22 16:16:17 -07004064 * @hide
4065 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004066 public static final String EXTRA_USER_HANDLE =
4067 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004068
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004069 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004070 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4071 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4072 */
4073 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004074 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004075
4076 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004077 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004078 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4079 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004080 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004081 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4082
4083 /**
4084 * Extra sent in the intent to the BroadcastReceiver that handles
4085 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4086 * the restrictions as key/value pairs.
4087 */
4088 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4089 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004090
Amith Yamasani86118ba2013-03-28 14:33:16 -07004091 /**
4092 * Extra used in the response from a BroadcastReceiver that handles
4093 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4094 */
4095 public static final String EXTRA_RESTRICTIONS_INTENT =
4096 "android.intent.extra.restrictions_intent";
4097
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004098 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004099 * Extra used to communicate a set of acceptable MIME types. The type of the
4100 * extra is {@code String[]}. Values may be a combination of concrete MIME
4101 * types (such as "image/png") and/or partial MIME types (such as
4102 * "audio/*").
4103 *
4104 * @see #ACTION_GET_CONTENT
4105 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004106 */
4107 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4108
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004109 /**
4110 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4111 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004112 * When this is true, hardware devices can use this information to determine that
4113 * they shouldn't do a complete shutdown of their device since this is not a
4114 * complete shutdown down to the kernel, but only user space restarting.
4115 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004116 */
4117 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4118 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4119
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004120 /**
4121 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4122 * user has set their time format preferences to the 24 hour format.
4123 *
4124 * @hide for internal use only.
4125 */
4126 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4127 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4128
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004129 /** {@hide} */
4130 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4131
Rubin Xue8490f12015-06-25 12:17:48 +01004132 /** {@hide} */
4133 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4134
Santos Cordon15a13782015-03-31 18:32:31 -07004135 /**
4136 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4137 * activation request.
4138 * TODO: Add information about the structure and response data used with the pending intent.
4139 * @hide
4140 */
4141 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4142 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4143
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004144 /**
4145 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004146 *
4147 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004148 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004149 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4150
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004151 /**
4152 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004153 * When a profile goes into quiet mode, all apps in the profile are killed and the
4154 * profile user is stopped. Widgets originating from the profile are masked, and app
4155 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004156 */
4157 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004158
4159 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004160 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004161 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004162 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4163 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004164 *
4165 * @hide
4166 */
4167 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4168 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4169
4170 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004171 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004172 * to represent that a video codec is allowed to use.
4173 *
4174 * @hide
4175 */
4176 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4177
4178 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004179 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004180 * to represent that a audio codec is allowed to use.
4181 *
4182 * @hide
4183 */
4184 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4185
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004186 // ---------------------------------------------------------------------
4187 // ---------------------------------------------------------------------
4188 // Intent flags (see mFlags variable).
4189
Tor Norbyed9273d62013-05-30 15:59:53 -07004190 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004191 @IntDef(flag = true, value = {
4192 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4193 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004194 @Retention(RetentionPolicy.SOURCE)
4195 public @interface GrantUriMode {}
4196
Jeff Sharkey846318a2014-04-04 12:12:41 -07004197 /** @hide */
4198 @IntDef(flag = true, value = {
4199 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4200 @Retention(RetentionPolicy.SOURCE)
4201 public @interface AccessUriMode {}
4202
4203 /**
4204 * Test if given mode flags specify an access mode, which must be at least
4205 * read and/or write.
4206 *
4207 * @hide
4208 */
4209 public static boolean isAccessUriMode(int modeFlags) {
4210 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4211 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4212 }
4213
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004214 /**
4215 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004216 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004217 * specified in its ClipData. When applying to an Intent's ClipData,
4218 * all URIs as well as recursive traversals through data or other ClipData
4219 * in Intent items will be granted; only the grant flags of the top-level
4220 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004221 */
4222 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4223 /**
4224 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004225 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004226 * specified in its ClipData. When applying to an Intent's ClipData,
4227 * all URIs as well as recursive traversals through data or other ClipData
4228 * in Intent items will be granted; only the grant flags of the top-level
4229 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004230 */
4231 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4232 /**
4233 * Can be set by the caller to indicate that this Intent is coming from
4234 * a background operation, not from direct user interaction.
4235 */
4236 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4237 /**
4238 * A flag you can enable for debugging: when set, log messages will be
4239 * printed during the resolution of this intent to show you what has
4240 * been found to create the final resolved list.
4241 */
4242 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004243 /**
4244 * If set, this intent will not match any components in packages that
4245 * are currently stopped. If this is not set, then the default behavior
4246 * is to include such applications in the result.
4247 */
4248 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4249 /**
4250 * If set, this intent will always match any components in packages that
4251 * are currently stopped. This is the default behavior when
4252 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4253 * flags are set, this one wins (it allows overriding of exclude for
4254 * places where the framework may automatically set the exclude flag).
4255 */
4256 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004257
4258 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004259 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004260 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004261 * persisted across device reboots until explicitly revoked with
4262 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4263 * grant for possible persisting; the receiving application must call
4264 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4265 * actually persist.
4266 *
4267 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4268 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4269 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004270 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004271 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004272 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004273
4274 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004275 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4276 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4277 * applies to any URI that is a prefix match against the original granted
4278 * URI. (Without this flag, the URI must match exactly for access to be
4279 * granted.) Another URI is considered a prefix match only when scheme,
4280 * authority, and all path segments defined by the prefix are an exact
4281 * match.
4282 */
4283 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4284
4285 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004286 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004287 * homework and verified that they correctly handle packages and components
4288 * that come and go over time. In particular:
4289 * <ul>
4290 * <li>Apps installed on external storage, which will appear to be
4291 * uninstalled while the the device is ejected.
4292 * <li>Apps with encryption unaware components, which will appear to not
4293 * exist while the device is locked.
4294 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004295 *
4296 * @hide
4297 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004298 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004299
4300 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004301 * If set, the new activity is not kept in the history stack. As soon as
4302 * the user navigates away from it, the activity is finished. This may also
4303 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4304 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004305 *
4306 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4307 * is never invoked when the current activity starts a new activity which
4308 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004309 */
4310 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4311 /**
4312 * If set, the activity will not be launched if it is already running
4313 * at the top of the history stack.
4314 */
4315 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4316 /**
4317 * If set, this activity will become the start of a new task on this
4318 * history stack. A task (from the activity that started it to the
4319 * next task activity) defines an atomic group of activities that the
4320 * user can move to. Tasks can be moved to the foreground and background;
4321 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004322 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004323 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4324 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004325 *
4326 * <p>This flag is generally used by activities that want
4327 * to present a "launcher" style behavior: they give the user a list of
4328 * separate things that can be done, which otherwise run completely
4329 * independently of the activity launching them.
4330 *
4331 * <p>When using this flag, if a task is already running for the activity
4332 * you are now starting, then a new activity will not be started; instead,
4333 * the current task will simply be brought to the front of the screen with
4334 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4335 * to disable this behavior.
4336 *
4337 * <p>This flag can not be used when the caller is requesting a result from
4338 * the activity being launched.
4339 */
4340 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4341 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004342 * This flag is used to create a new task and launch an activity into it.
4343 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4344 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4345 * search through existing tasks for ones matching this Intent. Only if no such
4346 * task is found would a new task be created. When paired with
4347 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4348 * the search for a matching task and unconditionally start a new task.
4349 *
4350 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4351 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004352 * top-level application launcher.</strong> Used in conjunction with
4353 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4354 * behavior of bringing an existing task to the foreground. When set,
4355 * a new task is <em>always</em> started to host the Activity for the
4356 * Intent, regardless of whether there is already an existing task running
4357 * the same thing.
4358 *
4359 * <p><strong>Because the default system does not include graphical task management,
4360 * you should not use this flag unless you provide some way for a user to
4361 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004362 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004363 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4364 * creating new document tasks.
4365 *
4366 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004367 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004368 *
Scott Main7aee61f2011-02-08 11:25:01 -08004369 * <p>See
4370 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4371 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004372 *
4373 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4374 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004375 */
4376 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4377 /**
4378 * If set, and the activity being launched is already running in the
4379 * current task, then instead of launching a new instance of that activity,
4380 * all of the other activities on top of it will be closed and this Intent
4381 * will be delivered to the (now on top) old activity as a new Intent.
4382 *
4383 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4384 * If D calls startActivity() with an Intent that resolves to the component
4385 * of activity B, then C and D will be finished and B receive the given
4386 * Intent, resulting in the stack now being: A, B.
4387 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004388 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004389 * either receive the new intent you are starting here in its
4390 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004391 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004392 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4393 * the same intent, then it will be finished and re-created; for all other
4394 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4395 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004396 *
4397 * <p>This launch mode can also be used to good effect in conjunction with
4398 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4399 * of a task, it will bring any currently running instance of that task
4400 * to the foreground, and then clear it to its root state. This is
4401 * especially useful, for example, when launching an activity from the
4402 * notification manager.
4403 *
Scott Main7aee61f2011-02-08 11:25:01 -08004404 * <p>See
4405 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4406 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004407 */
4408 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4409 /**
4410 * If set and this intent is being used to launch a new activity from an
4411 * existing one, then the reply target of the existing activity will be
4412 * transfered to the new activity. This way the new activity can call
4413 * {@link android.app.Activity#setResult} and have that result sent back to
4414 * the reply target of the original activity.
4415 */
4416 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4417 /**
4418 * If set and this intent is being used to launch a new activity from an
4419 * existing one, the current activity will not be counted as the top
4420 * activity for deciding whether the new intent should be delivered to
4421 * the top instead of starting a new one. The previous activity will
4422 * be used as the top, with the assumption being that the current activity
4423 * will finish itself immediately.
4424 */
4425 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4426 /**
4427 * If set, the new activity is not kept in the list of recently launched
4428 * activities.
4429 */
4430 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4431 /**
4432 * This flag is not normally set by application code, but set for you by
4433 * the system as described in the
4434 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4435 * launchMode} documentation for the singleTask mode.
4436 */
4437 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4438 /**
4439 * If set, and this activity is either being started in a new task or
4440 * bringing to the top an existing task, then it will be launched as
4441 * the front door of the task. This will result in the application of
4442 * any affinities needed to have that task in the proper state (either
4443 * moving activities to or from it), or simply resetting that task to
4444 * its initial state if needed.
4445 */
4446 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4447 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004448 * This flag is not normally set by application code, but set for you by
4449 * the system if this activity is being launched from history
4450 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004451 */
4452 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004453 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004454 * @deprecated As of API 21 this performs identically to
4455 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004456 */
4457 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004458 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004459 * This flag is used to open a document into a new task rooted at the activity launched
4460 * by this Intent. Through the use of this flag, or its equivalent attribute,
4461 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004462 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004463 *
Craig Mautner026596b2014-05-21 15:35:44 -07004464 * <p>The use of the activity attribute form of this,
4465 * {@link android.R.attr#documentLaunchMode}, is
4466 * preferred over the Intent flag described here. The attribute form allows the
4467 * Activity to specify multiple document behavior for all launchers of the Activity
4468 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004469 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004470 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4471 * it is kept after the activity is finished is different than the use of
4472 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4473 * this flag is being used to create a new recents entry, then by default that entry
4474 * will be removed once the activity is finished. You can modify this behavior with
4475 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4476 *
Craig Mautner026596b2014-05-21 15:35:44 -07004477 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4478 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4479 * equivalent of the Activity manifest specifying {@link
4480 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4481 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4482 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004483 *
Craig Mautner026596b2014-05-21 15:35:44 -07004484 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004485 *
Craig Mautner026596b2014-05-21 15:35:44 -07004486 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004487 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4488 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004489 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004490 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004491 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004492 * callback from occurring on the current frontmost activity before it is
4493 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004494 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004495 * <p>Typically, an activity can rely on that callback to indicate that an
4496 * explicit user action has caused their activity to be moved out of the
4497 * foreground. The callback marks an appropriate point in the activity's
4498 * lifecycle for it to dismiss any notifications that it intends to display
4499 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004500 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004501 * <p>If an activity is ever started via any non-user-driven events such as
4502 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4503 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004504 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004505 */
4506 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004507 /**
4508 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4509 * this flag will cause the launched activity to be brought to the front of its
4510 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004511 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004512 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4513 * If D calls startActivity() with an Intent that resolves to the component
4514 * of activity B, then B will be brought to the front of the history stack,
4515 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004516 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004517 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004518 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004519 */
4520 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004521 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004522 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4523 * this flag will prevent the system from applying an activity transition
4524 * animation to go to the next activity state. This doesn't mean an
4525 * animation will never run -- if another activity change happens that doesn't
4526 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004527 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004528 * when you are going to do a series of activity operations but the
4529 * animation seen by the user shouldn't be driven by the first activity
4530 * change but rather a later one.
4531 */
4532 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4533 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004534 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4535 * this flag will cause any existing task that would be associated with the
4536 * activity to be cleared before the activity is started. That is, the activity
4537 * becomes the new root of an otherwise empty task, and any old activities
4538 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4539 */
4540 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4541 /**
4542 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4543 * this flag will cause a newly launching task to be placed on top of the current
4544 * home activity task (if there is one). That is, pressing back from the task
4545 * will always return the user to home even if that was not the last activity they
4546 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4547 */
4548 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4549 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004550 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4551 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004552 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004553 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004554 * this flag. When set and the task's activity is finished, the recents
4555 * entry will remain in the interface for the user to re-launch it, like a
4556 * recents entry for a top-level application.
4557 * <p>
4558 * The receiving activity can override this request with
4559 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4560 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004561 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004562 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004563 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004564
4565 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004566 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4567 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004568 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4569 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004570 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004571 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004572
4573 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004574 * If set, when sending a broadcast only registered receivers will be
4575 * called -- no BroadcastReceiver components will be launched.
4576 */
4577 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004578 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004579 * If set, when sending a broadcast the new broadcast will replace
4580 * any existing pending broadcast that matches it. Matching is defined
4581 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4582 * true for the intents of the two broadcasts. When a match is found,
4583 * the new broadcast (and receivers associated with it) will replace the
4584 * existing one in the pending broadcast list, remaining at the same
4585 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004586 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004587 * <p>This flag is most typically used with sticky broadcasts, which
4588 * only care about delivering the most recent values of the broadcast
4589 * to their receivers.
4590 */
4591 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4592 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004593 * If set, when sending a broadcast the recipient is allowed to run at
4594 * foreground priority, with a shorter timeout interval. During normal
4595 * broadcasts the receivers are not automatically hoisted out of the
4596 * background priority class.
4597 */
4598 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4599 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004600 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4601 * They can still propagate results through to later receivers, but they can not prevent
4602 * later receivers from seeing the broadcast.
4603 */
4604 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4605 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004606 * If set, when sending a broadcast <i>before boot has completed</i> only
4607 * registered receivers will be called -- no BroadcastReceiver components
4608 * will be launched. Sticky intent state will be recorded properly even
4609 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4610 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004611 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004612 * <p>This flag is only for use by system sevices as a convenience to
4613 * avoid having to implement a more complex mechanism around detection
4614 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004615 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004616 * @hide
4617 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004618 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004619 /**
4620 * Set when this broadcast is for a boot upgrade, a special mode that
4621 * allows the broadcast to be sent before the system is ready and launches
4622 * the app process with no providers running in it.
4623 * @hide
4624 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004625 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004626 /**
4627 * If set, the broadcast will always go to manifest receivers in background (cached
4628 * or not running) apps, regardless of whether that would be done by default. By
4629 * default they will only receive broadcasts if the broadcast has specified an
4630 * explicit component or package name.
4631 * @hide
4632 */
4633 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4634 /**
4635 * If set, the broadcast will never go to manifest receivers in background (cached
4636 * or not running) apps, regardless of whether that would be done by default. By
4637 * default they will receive broadcasts if the broadcast has specified an
4638 * explicit component or package name.
4639 * @hide
4640 */
4641 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004643 /**
4644 * @hide Flags that can't be changed with PendingIntent.
4645 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004646 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4647 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4648 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004650 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004651 // ---------------------------------------------------------------------
4652 // toUri() and parseUri() options.
4653
4654 /**
4655 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4656 * always has the "intent:" scheme. This syntax can be used when you want
4657 * to later disambiguate between URIs that are intended to describe an
4658 * Intent vs. all others that should be treated as raw URIs. When used
4659 * with {@link #parseUri}, any other scheme will result in a generic
4660 * VIEW action for that raw URI.
4661 */
4662 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004663
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004664 /**
4665 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4666 * always has the "android-app:" scheme. This is a variation of
4667 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4668 * http/https URI being delivered to a specific package name. The format
4669 * is:
4670 *
4671 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004672 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004673 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004674 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4675 * you must also include a scheme; including a path also requires both a host and a scheme.
4676 * The final #Intent; fragment can be used without a scheme, host, or path.
4677 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004678 * used with intents that have a {@link #setSelector}, since the base intent
4679 * will always have an explicit package name.</p>
4680 *
4681 * <p>Some examples of how this scheme maps to Intent objects:</p>
4682 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4683 * <colgroup align="left" />
4684 * <colgroup align="left" />
4685 * <thead>
4686 * <tr><th>URI</th> <th>Intent</th></tr>
4687 * </thead>
4688 *
4689 * <tbody>
4690 * <tr><td><code>android-app://com.example.app</code></td>
4691 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4692 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4693 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4694 * </table></td>
4695 * </tr>
4696 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4697 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4698 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4699 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4700 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4701 * </table></td>
4702 * </tr>
4703 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4704 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4705 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4706 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4707 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4708 * </table></td>
4709 * </tr>
4710 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4711 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4712 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4713 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4714 * </table></td>
4715 * </tr>
4716 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4717 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4718 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4719 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4720 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4721 * </table></td>
4722 * </tr>
4723 * <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>
4724 * <td><table border="" style="margin:0" >
4725 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4726 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4727 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4728 * </table></td>
4729 * </tr>
4730 * </tbody>
4731 * </table>
4732 */
4733 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4734
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004735 /**
4736 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4737 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4738 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4739 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4740 * generated Intent can not cause unexpected data access to happen.
4741 *
4742 * <p>If you do not trust the source of the URI being parsed, you should still do further
4743 * processing to protect yourself from it. In particular, when using it to start an
4744 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4745 * that can handle it.</p>
4746 */
4747 public static final int URI_ALLOW_UNSAFE = 1<<2;
4748
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004749 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004750
4751 private String mAction;
4752 private Uri mData;
4753 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004754 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004755 private ComponentName mComponent;
4756 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004757 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004758 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004759 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004760 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004761 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004762 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004763
4764 // ---------------------------------------------------------------------
4765
4766 /**
4767 * Create an empty intent.
4768 */
4769 public Intent() {
4770 }
4771
4772 /**
4773 * Copy constructor.
4774 */
4775 public Intent(Intent o) {
4776 this.mAction = o.mAction;
4777 this.mData = o.mData;
4778 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004779 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004780 this.mComponent = o.mComponent;
4781 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004782 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004783 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004784 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004785 }
4786 if (o.mExtras != null) {
4787 this.mExtras = new Bundle(o.mExtras);
4788 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004789 if (o.mSourceBounds != null) {
4790 this.mSourceBounds = new Rect(o.mSourceBounds);
4791 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004792 if (o.mSelector != null) {
4793 this.mSelector = new Intent(o.mSelector);
4794 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004795 if (o.mClipData != null) {
4796 this.mClipData = new ClipData(o.mClipData);
4797 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004798 }
4799
4800 @Override
4801 public Object clone() {
4802 return new Intent(this);
4803 }
4804
4805 private Intent(Intent o, boolean all) {
4806 this.mAction = o.mAction;
4807 this.mData = o.mData;
4808 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004809 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004810 this.mComponent = o.mComponent;
4811 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004812 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004813 }
4814 }
4815
4816 /**
4817 * Make a clone of only the parts of the Intent that are relevant for
4818 * filter matching: the action, data, type, component, and categories.
4819 */
4820 public Intent cloneFilter() {
4821 return new Intent(this, false);
4822 }
4823
4824 /**
4825 * Create an intent with a given action. All other fields (data, type,
4826 * class) are null. Note that the action <em>must</em> be in a
4827 * namespace because Intents are used globally in the system -- for
4828 * example the system VIEW action is android.intent.action.VIEW; an
4829 * application's custom action would be something like
4830 * com.google.app.myapp.CUSTOM_ACTION.
4831 *
4832 * @param action The Intent action, such as ACTION_VIEW.
4833 */
4834 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004835 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836 }
4837
4838 /**
4839 * Create an intent with a given action and for a given data url. Note
4840 * that the action <em>must</em> be in a namespace because Intents are
4841 * used globally in the system -- for example the system VIEW action is
4842 * android.intent.action.VIEW; an application's custom action would be
4843 * something like com.google.app.myapp.CUSTOM_ACTION.
4844 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004845 * <p><em>Note: scheme and host name matching in the Android framework is
4846 * case-sensitive, unlike the formal RFC. As a result,
4847 * you should always ensure that you write your Uri with these elements
4848 * using lower case letters, and normalize any Uris you receive from
4849 * outside of Android to ensure the scheme and host is lower case.</em></p>
4850 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004851 * @param action The Intent action, such as ACTION_VIEW.
4852 * @param uri The Intent data URI.
4853 */
4854 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004855 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004856 mData = uri;
4857 }
4858
4859 /**
4860 * Create an intent for a specific component. All other fields (action, data,
4861 * type, class) are null, though they can be modified later with explicit
4862 * calls. This provides a convenient way to create an intent that is
4863 * intended to execute a hard-coded class name, rather than relying on the
4864 * system to find an appropriate class for you; see {@link #setComponent}
4865 * for more information on the repercussions of this.
4866 *
4867 * @param packageContext A Context of the application package implementing
4868 * this class.
4869 * @param cls The component class that is to be used for the intent.
4870 *
4871 * @see #setClass
4872 * @see #setComponent
4873 * @see #Intent(String, android.net.Uri , Context, Class)
4874 */
4875 public Intent(Context packageContext, Class<?> cls) {
4876 mComponent = new ComponentName(packageContext, cls);
4877 }
4878
4879 /**
4880 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004881 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004882 * construct the Intent and then calling {@link #setClass} to set its
4883 * class.
4884 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004885 * <p><em>Note: scheme and host name matching in the Android framework is
4886 * case-sensitive, unlike the formal RFC. As a result,
4887 * you should always ensure that you write your Uri with these elements
4888 * using lower case letters, and normalize any Uris you receive from
4889 * outside of Android to ensure the scheme and host is lower case.</em></p>
4890 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004891 * @param action The Intent action, such as ACTION_VIEW.
4892 * @param uri The Intent data URI.
4893 * @param packageContext A Context of the application package implementing
4894 * this class.
4895 * @param cls The component class that is to be used for the intent.
4896 *
4897 * @see #Intent(String, android.net.Uri)
4898 * @see #Intent(Context, Class)
4899 * @see #setClass
4900 * @see #setComponent
4901 */
4902 public Intent(String action, Uri uri,
4903 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004904 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004905 mData = uri;
4906 mComponent = new ComponentName(packageContext, cls);
4907 }
4908
4909 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004910 * Create an intent to launch the main (root) activity of a task. This
4911 * is the Intent that is started when the application's is launched from
4912 * Home. For anything else that wants to launch an application in the
4913 * same way, it is important that they use an Intent structured the same
4914 * way, and can use this function to ensure this is the case.
4915 *
4916 * <p>The returned Intent has the given Activity component as its explicit
4917 * component, {@link #ACTION_MAIN} as its action, and includes the
4918 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4919 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4920 * to do that through {@link #addFlags(int)} on the returned Intent.
4921 *
4922 * @param mainActivity The main activity component that this Intent will
4923 * launch.
4924 * @return Returns a newly created Intent that can be used to launch the
4925 * activity as a main application entry.
4926 *
4927 * @see #setClass
4928 * @see #setComponent
4929 */
4930 public static Intent makeMainActivity(ComponentName mainActivity) {
4931 Intent intent = new Intent(ACTION_MAIN);
4932 intent.setComponent(mainActivity);
4933 intent.addCategory(CATEGORY_LAUNCHER);
4934 return intent;
4935 }
4936
4937 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004938 * Make an Intent for the main activity of an application, without
4939 * specifying a specific activity to run but giving a selector to find
4940 * the activity. This results in a final Intent that is structured
4941 * the same as when the application is launched from
4942 * Home. For anything else that wants to launch an application in the
4943 * same way, it is important that they use an Intent structured the same
4944 * way, and can use this function to ensure this is the case.
4945 *
4946 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4947 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4948 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4949 * to do that through {@link #addFlags(int)} on the returned Intent.
4950 *
4951 * @param selectorAction The action name of the Intent's selector.
4952 * @param selectorCategory The name of a category to add to the Intent's
4953 * selector.
4954 * @return Returns a newly created Intent that can be used to launch the
4955 * activity as a main application entry.
4956 *
4957 * @see #setSelector(Intent)
4958 */
4959 public static Intent makeMainSelectorActivity(String selectorAction,
4960 String selectorCategory) {
4961 Intent intent = new Intent(ACTION_MAIN);
4962 intent.addCategory(CATEGORY_LAUNCHER);
4963 Intent selector = new Intent();
4964 selector.setAction(selectorAction);
4965 selector.addCategory(selectorCategory);
4966 intent.setSelector(selector);
4967 return intent;
4968 }
4969
4970 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004971 * Make an Intent that can be used to re-launch an application's task
4972 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4973 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4974 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4975 *
4976 * @param mainActivity The activity component that is the root of the
4977 * task; this is the activity that has been published in the application's
4978 * manifest as the main launcher icon.
4979 *
4980 * @return Returns a newly created Intent that can be used to relaunch the
4981 * activity's task in its root state.
4982 */
4983 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4984 Intent intent = makeMainActivity(mainActivity);
4985 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4986 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4987 return intent;
4988 }
4989
4990 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004991 * Call {@link #parseUri} with 0 flags.
4992 * @deprecated Use {@link #parseUri} instead.
4993 */
4994 @Deprecated
4995 public static Intent getIntent(String uri) throws URISyntaxException {
4996 return parseUri(uri, 0);
4997 }
Tom Taylord4a47292009-12-21 13:59:18 -08004998
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004999 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005000 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005001 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005002 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005003 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005004 *
5005 * <p>The URI given here must not be relative -- that is, it must include
5006 * the scheme and full path.
5007 *
5008 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005009 * @param flags Additional processing flags. Either 0,
5010 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005011 *
5012 * @return Intent The newly created Intent object.
5013 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005014 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5015 * it bad (as parsed by the Uri class) or the Intent data within the
5016 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005017 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005018 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005019 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005020 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 int i = 0;
5022 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005023 final boolean androidApp = uri.startsWith("android-app:");
5024
5025 // Validate intent scheme if requested.
5026 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5027 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005028 Intent intent = new Intent(ACTION_VIEW);
5029 try {
5030 intent.setData(Uri.parse(uri));
5031 } catch (IllegalArgumentException e) {
5032 throw new URISyntaxException(uri, e.getMessage());
5033 }
5034 return intent;
5035 }
5036 }
Tom Taylord4a47292009-12-21 13:59:18 -08005037
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005038 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005039 // simple case
5040 if (i == -1) {
5041 if (!androidApp) {
5042 return new Intent(ACTION_VIEW, Uri.parse(uri));
5043 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005044
5045 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005046 } else if (!uri.startsWith("#Intent;", i)) {
5047 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005048 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005049 } else {
5050 i = -1;
5051 }
5052 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005053
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005054 // new format
5055 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005056 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005057 boolean explicitAction = false;
5058 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005059
5060 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005061 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005062 String data;
5063 if (i >= 0) {
5064 data = uri.substring(0, i);
5065 i += 8; // length of "#Intent;"
5066 } else {
5067 data = uri;
5068 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005069
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005070 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005071 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005072 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005073 if (eq < 0) eq = i-1;
5074 int semi = uri.indexOf(';', i);
5075 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005076
5077 // action
5078 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005079 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005080 if (!inSelector) {
5081 explicitAction = true;
5082 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005083 }
5084
5085 // categories
5086 else if (uri.startsWith("category=", i)) {
5087 intent.addCategory(value);
5088 }
5089
5090 // type
5091 else if (uri.startsWith("type=", i)) {
5092 intent.mType = value;
5093 }
5094
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005095 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005096 else if (uri.startsWith("launchFlags=", i)) {
5097 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005098 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5099 intent.mFlags &= ~IMMUTABLE_FLAGS;
5100 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005101 }
5102
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005103 // package
5104 else if (uri.startsWith("package=", i)) {
5105 intent.mPackage = value;
5106 }
5107
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005108 // component
5109 else if (uri.startsWith("component=", i)) {
5110 intent.mComponent = ComponentName.unflattenFromString(value);
5111 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005112
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005113 // scheme
5114 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005115 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005116 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005117 } else {
5118 scheme = value;
5119 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005120 }
5121
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005122 // source bounds
5123 else if (uri.startsWith("sourceBounds=", i)) {
5124 intent.mSourceBounds = Rect.unflattenFromString(value);
5125 }
5126
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005127 // selector
5128 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5129 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005130 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005131 }
5132
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005133 // extra
5134 else {
5135 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005136 // create Bundle if it doesn't already exist
5137 if (intent.mExtras == null) intent.mExtras = new Bundle();
5138 Bundle b = intent.mExtras;
5139 // add EXTRA
5140 if (uri.startsWith("S.", i)) b.putString(key, value);
5141 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5142 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5143 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5144 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5145 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5146 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5147 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5148 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5149 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5150 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005151
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005152 // move to the next item
5153 i = semi + 1;
5154 }
5155
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005156 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005157 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005158 if (baseIntent.mPackage == null) {
5159 baseIntent.setSelector(intent);
5160 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005161 intent = baseIntent;
5162 }
5163
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005164 if (data != null) {
5165 if (data.startsWith("intent:")) {
5166 data = data.substring(7);
5167 if (scheme != null) {
5168 data = scheme + ':' + data;
5169 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005170 } else if (data.startsWith("android-app:")) {
5171 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5172 // Correctly formed android-app, first part is package name.
5173 int end = data.indexOf('/', 14);
5174 if (end < 0) {
5175 // All we have is a package name.
5176 intent.mPackage = data.substring(14);
5177 if (!explicitAction) {
5178 intent.setAction(ACTION_MAIN);
5179 }
5180 data = "";
5181 } else {
5182 // Target the Intent at the given package name always.
5183 String authority = null;
5184 intent.mPackage = data.substring(14, end);
5185 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005186 if ((end+1) < data.length()) {
5187 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5188 // Found a scheme, remember it.
5189 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005190 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005191 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5192 // Found a authority, remember it.
5193 authority = data.substring(end+1, newEnd);
5194 end = newEnd;
5195 }
5196 } else {
5197 // All we have is a scheme.
5198 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005199 }
5200 }
5201 if (scheme == null) {
5202 // If there was no scheme, then this just targets the package.
5203 if (!explicitAction) {
5204 intent.setAction(ACTION_MAIN);
5205 }
5206 data = "";
5207 } else if (authority == null) {
5208 data = scheme + ":";
5209 } else {
5210 data = scheme + "://" + authority + data.substring(end);
5211 }
5212 }
5213 } else {
5214 data = "";
5215 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005216 }
Tom Taylord4a47292009-12-21 13:59:18 -08005217
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005218 if (data.length() > 0) {
5219 try {
5220 intent.mData = Uri.parse(data);
5221 } catch (IllegalArgumentException e) {
5222 throw new URISyntaxException(uri, e.getMessage());
5223 }
5224 }
5225 }
Tom Taylord4a47292009-12-21 13:59:18 -08005226
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005227 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005228
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005229 } catch (IndexOutOfBoundsException e) {
5230 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5231 }
5232 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005233
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005234 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005235 return getIntentOld(uri, 0);
5236 }
5237
5238 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005239 Intent intent;
5240
5241 int i = uri.lastIndexOf('#');
5242 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005243 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005244 final int intentFragmentStart = i;
5245 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005246
5247 i++;
5248
5249 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005250 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005251 i += 7;
5252 int j = uri.indexOf(')', i);
5253 action = uri.substring(i, j);
5254 i = j + 1;
5255 }
5256
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005257 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005258
5259 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005260 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261 i += 11;
5262 int j = uri.indexOf(')', i);
5263 while (i < j) {
5264 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005265 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266 if (i < sep) {
5267 intent.addCategory(uri.substring(i, sep));
5268 }
5269 i = sep + 1;
5270 }
5271 i = j + 1;
5272 }
5273
5274 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005275 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005276 i += 5;
5277 int j = uri.indexOf(')', i);
5278 intent.mType = uri.substring(i, j);
5279 i = j + 1;
5280 }
5281
5282 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005283 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005284 i += 12;
5285 int j = uri.indexOf(')', i);
5286 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005287 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5288 intent.mFlags &= ~IMMUTABLE_FLAGS;
5289 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005290 i = j + 1;
5291 }
5292
5293 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005294 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005295 i += 10;
5296 int j = uri.indexOf(')', i);
5297 int sep = uri.indexOf('!', i);
5298 if (sep >= 0 && sep < j) {
5299 String pkg = uri.substring(i, sep);
5300 String cls = uri.substring(sep + 1, j);
5301 intent.mComponent = new ComponentName(pkg, cls);
5302 }
5303 i = j + 1;
5304 }
5305
5306 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005307 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005308 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005309
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005310 final int closeParen = uri.indexOf(')', i);
5311 if (closeParen == -1) throw new URISyntaxException(uri,
5312 "EXTRA missing trailing ')'", i);
5313
5314 while (i < closeParen) {
5315 // fetch the key value
5316 int j = uri.indexOf('=', i);
5317 if (j <= i + 1 || i >= closeParen) {
5318 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5319 }
5320 char type = uri.charAt(i);
5321 i++;
5322 String key = uri.substring(i, j);
5323 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005324
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005325 // get type-value
5326 j = uri.indexOf('!', i);
5327 if (j == -1 || j >= closeParen) j = closeParen;
5328 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5329 String value = uri.substring(i, j);
5330 i = j;
5331
5332 // create Bundle if it doesn't already exist
5333 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005334
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005335 // add item to bundle
5336 try {
5337 switch (type) {
5338 case 'S':
5339 intent.mExtras.putString(key, Uri.decode(value));
5340 break;
5341 case 'B':
5342 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5343 break;
5344 case 'b':
5345 intent.mExtras.putByte(key, Byte.parseByte(value));
5346 break;
5347 case 'c':
5348 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5349 break;
5350 case 'd':
5351 intent.mExtras.putDouble(key, Double.parseDouble(value));
5352 break;
5353 case 'f':
5354 intent.mExtras.putFloat(key, Float.parseFloat(value));
5355 break;
5356 case 'i':
5357 intent.mExtras.putInt(key, Integer.parseInt(value));
5358 break;
5359 case 'l':
5360 intent.mExtras.putLong(key, Long.parseLong(value));
5361 break;
5362 case 's':
5363 intent.mExtras.putShort(key, Short.parseShort(value));
5364 break;
5365 default:
5366 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5367 }
5368 } catch (NumberFormatException e) {
5369 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5370 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005371
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005372 char ch = uri.charAt(i);
5373 if (ch == ')') break;
5374 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5375 i++;
5376 }
5377 }
5378
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005379 if (isIntentFragment) {
5380 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5381 } else {
5382 intent.mData = Uri.parse(uri);
5383 }
Tom Taylord4a47292009-12-21 13:59:18 -08005384
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005385 if (intent.mAction == null) {
5386 // By default, if no action is specified, then use VIEW.
5387 intent.mAction = ACTION_VIEW;
5388 }
5389
5390 } else {
5391 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5392 }
5393
5394 return intent;
5395 }
5396
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005397 /** @hide */
5398 public interface CommandOptionHandler {
5399 boolean handleOption(String opt, ShellCommand cmd);
5400 }
5401
5402 /** @hide */
5403 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5404 throws URISyntaxException {
5405 Intent intent = new Intent();
5406 Intent baseIntent = intent;
5407 boolean hasIntentInfo = false;
5408
5409 Uri data = null;
5410 String type = null;
5411
5412 String opt;
5413 while ((opt=cmd.getNextOption()) != null) {
5414 switch (opt) {
5415 case "-a":
5416 intent.setAction(cmd.getNextArgRequired());
5417 if (intent == baseIntent) {
5418 hasIntentInfo = true;
5419 }
5420 break;
5421 case "-d":
5422 data = Uri.parse(cmd.getNextArgRequired());
5423 if (intent == baseIntent) {
5424 hasIntentInfo = true;
5425 }
5426 break;
5427 case "-t":
5428 type = cmd.getNextArgRequired();
5429 if (intent == baseIntent) {
5430 hasIntentInfo = true;
5431 }
5432 break;
5433 case "-c":
5434 intent.addCategory(cmd.getNextArgRequired());
5435 if (intent == baseIntent) {
5436 hasIntentInfo = true;
5437 }
5438 break;
5439 case "-e":
5440 case "--es": {
5441 String key = cmd.getNextArgRequired();
5442 String value = cmd.getNextArgRequired();
5443 intent.putExtra(key, value);
5444 }
5445 break;
5446 case "--esn": {
5447 String key = cmd.getNextArgRequired();
5448 intent.putExtra(key, (String) null);
5449 }
5450 break;
5451 case "--ei": {
5452 String key = cmd.getNextArgRequired();
5453 String value = cmd.getNextArgRequired();
5454 intent.putExtra(key, Integer.decode(value));
5455 }
5456 break;
5457 case "--eu": {
5458 String key = cmd.getNextArgRequired();
5459 String value = cmd.getNextArgRequired();
5460 intent.putExtra(key, Uri.parse(value));
5461 }
5462 break;
5463 case "--ecn": {
5464 String key = cmd.getNextArgRequired();
5465 String value = cmd.getNextArgRequired();
5466 ComponentName cn = ComponentName.unflattenFromString(value);
5467 if (cn == null)
5468 throw new IllegalArgumentException("Bad component name: " + value);
5469 intent.putExtra(key, cn);
5470 }
5471 break;
5472 case "--eia": {
5473 String key = cmd.getNextArgRequired();
5474 String value = cmd.getNextArgRequired();
5475 String[] strings = value.split(",");
5476 int[] list = new int[strings.length];
5477 for (int i = 0; i < strings.length; i++) {
5478 list[i] = Integer.decode(strings[i]);
5479 }
5480 intent.putExtra(key, list);
5481 }
5482 break;
5483 case "--eial": {
5484 String key = cmd.getNextArgRequired();
5485 String value = cmd.getNextArgRequired();
5486 String[] strings = value.split(",");
5487 ArrayList<Integer> list = new ArrayList<>(strings.length);
5488 for (int i = 0; i < strings.length; i++) {
5489 list.add(Integer.decode(strings[i]));
5490 }
5491 intent.putExtra(key, list);
5492 }
5493 break;
5494 case "--el": {
5495 String key = cmd.getNextArgRequired();
5496 String value = cmd.getNextArgRequired();
5497 intent.putExtra(key, Long.valueOf(value));
5498 }
5499 break;
5500 case "--ela": {
5501 String key = cmd.getNextArgRequired();
5502 String value = cmd.getNextArgRequired();
5503 String[] strings = value.split(",");
5504 long[] list = new long[strings.length];
5505 for (int i = 0; i < strings.length; i++) {
5506 list[i] = Long.valueOf(strings[i]);
5507 }
5508 intent.putExtra(key, list);
5509 hasIntentInfo = true;
5510 }
5511 break;
5512 case "--elal": {
5513 String key = cmd.getNextArgRequired();
5514 String value = cmd.getNextArgRequired();
5515 String[] strings = value.split(",");
5516 ArrayList<Long> list = new ArrayList<>(strings.length);
5517 for (int i = 0; i < strings.length; i++) {
5518 list.add(Long.valueOf(strings[i]));
5519 }
5520 intent.putExtra(key, list);
5521 hasIntentInfo = true;
5522 }
5523 break;
5524 case "--ef": {
5525 String key = cmd.getNextArgRequired();
5526 String value = cmd.getNextArgRequired();
5527 intent.putExtra(key, Float.valueOf(value));
5528 hasIntentInfo = true;
5529 }
5530 break;
5531 case "--efa": {
5532 String key = cmd.getNextArgRequired();
5533 String value = cmd.getNextArgRequired();
5534 String[] strings = value.split(",");
5535 float[] list = new float[strings.length];
5536 for (int i = 0; i < strings.length; i++) {
5537 list[i] = Float.valueOf(strings[i]);
5538 }
5539 intent.putExtra(key, list);
5540 hasIntentInfo = true;
5541 }
5542 break;
5543 case "--efal": {
5544 String key = cmd.getNextArgRequired();
5545 String value = cmd.getNextArgRequired();
5546 String[] strings = value.split(",");
5547 ArrayList<Float> list = new ArrayList<>(strings.length);
5548 for (int i = 0; i < strings.length; i++) {
5549 list.add(Float.valueOf(strings[i]));
5550 }
5551 intent.putExtra(key, list);
5552 hasIntentInfo = true;
5553 }
5554 break;
5555 case "--esa": {
5556 String key = cmd.getNextArgRequired();
5557 String value = cmd.getNextArgRequired();
5558 // Split on commas unless they are preceeded by an escape.
5559 // The escape character must be escaped for the string and
5560 // again for the regex, thus four escape characters become one.
5561 String[] strings = value.split("(?<!\\\\),");
5562 intent.putExtra(key, strings);
5563 hasIntentInfo = true;
5564 }
5565 break;
5566 case "--esal": {
5567 String key = cmd.getNextArgRequired();
5568 String value = cmd.getNextArgRequired();
5569 // Split on commas unless they are preceeded by an escape.
5570 // The escape character must be escaped for the string and
5571 // again for the regex, thus four escape characters become one.
5572 String[] strings = value.split("(?<!\\\\),");
5573 ArrayList<String> list = new ArrayList<>(strings.length);
5574 for (int i = 0; i < strings.length; i++) {
5575 list.add(strings[i]);
5576 }
5577 intent.putExtra(key, list);
5578 hasIntentInfo = true;
5579 }
5580 break;
5581 case "--ez": {
5582 String key = cmd.getNextArgRequired();
5583 String value = cmd.getNextArgRequired().toLowerCase();
5584 // Boolean.valueOf() results in false for anything that is not "true", which is
5585 // error-prone in shell commands
5586 boolean arg;
5587 if ("true".equals(value) || "t".equals(value)) {
5588 arg = true;
5589 } else if ("false".equals(value) || "f".equals(value)) {
5590 arg = false;
5591 } else {
5592 try {
5593 arg = Integer.decode(value) != 0;
5594 } catch (NumberFormatException ex) {
5595 throw new IllegalArgumentException("Invalid boolean value: " + value);
5596 }
5597 }
5598
5599 intent.putExtra(key, arg);
5600 }
5601 break;
5602 case "-n": {
5603 String str = cmd.getNextArgRequired();
5604 ComponentName cn = ComponentName.unflattenFromString(str);
5605 if (cn == null)
5606 throw new IllegalArgumentException("Bad component name: " + str);
5607 intent.setComponent(cn);
5608 if (intent == baseIntent) {
5609 hasIntentInfo = true;
5610 }
5611 }
5612 break;
5613 case "-p": {
5614 String str = cmd.getNextArgRequired();
5615 intent.setPackage(str);
5616 if (intent == baseIntent) {
5617 hasIntentInfo = true;
5618 }
5619 }
5620 break;
5621 case "-f":
5622 String str = cmd.getNextArgRequired();
5623 intent.setFlags(Integer.decode(str).intValue());
5624 break;
5625 case "--grant-read-uri-permission":
5626 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5627 break;
5628 case "--grant-write-uri-permission":
5629 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5630 break;
5631 case "--grant-persistable-uri-permission":
5632 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5633 break;
5634 case "--grant-prefix-uri-permission":
5635 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5636 break;
5637 case "--exclude-stopped-packages":
5638 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5639 break;
5640 case "--include-stopped-packages":
5641 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5642 break;
5643 case "--debug-log-resolution":
5644 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5645 break;
5646 case "--activity-brought-to-front":
5647 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5648 break;
5649 case "--activity-clear-top":
5650 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5651 break;
5652 case "--activity-clear-when-task-reset":
5653 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5654 break;
5655 case "--activity-exclude-from-recents":
5656 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5657 break;
5658 case "--activity-launched-from-history":
5659 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5660 break;
5661 case "--activity-multiple-task":
5662 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5663 break;
5664 case "--activity-no-animation":
5665 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5666 break;
5667 case "--activity-no-history":
5668 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5669 break;
5670 case "--activity-no-user-action":
5671 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5672 break;
5673 case "--activity-previous-is-top":
5674 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5675 break;
5676 case "--activity-reorder-to-front":
5677 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5678 break;
5679 case "--activity-reset-task-if-needed":
5680 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5681 break;
5682 case "--activity-single-top":
5683 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5684 break;
5685 case "--activity-clear-task":
5686 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5687 break;
5688 case "--activity-task-on-home":
5689 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5690 break;
5691 case "--receiver-registered-only":
5692 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5693 break;
5694 case "--receiver-replace-pending":
5695 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5696 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005697 case "--receiver-foreground":
5698 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5699 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005700 case "--selector":
5701 intent.setDataAndType(data, type);
5702 intent = new Intent();
5703 break;
5704 default:
5705 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5706 // Okay, caller handled this option.
5707 } else {
5708 throw new IllegalArgumentException("Unknown option: " + opt);
5709 }
5710 break;
5711 }
5712 }
5713 intent.setDataAndType(data, type);
5714
5715 final boolean hasSelector = intent != baseIntent;
5716 if (hasSelector) {
5717 // A selector was specified; fix up.
5718 baseIntent.setSelector(intent);
5719 intent = baseIntent;
5720 }
5721
5722 String arg = cmd.getNextArg();
5723 baseIntent = null;
5724 if (arg == null) {
5725 if (hasSelector) {
5726 // If a selector has been specified, and no arguments
5727 // have been supplied for the main Intent, then we can
5728 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5729 // need to have a component name specified yet, the
5730 // selector will take care of that.
5731 baseIntent = new Intent(Intent.ACTION_MAIN);
5732 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5733 }
5734 } else if (arg.indexOf(':') >= 0) {
5735 // The argument is a URI. Fully parse it, and use that result
5736 // to fill in any data not specified so far.
5737 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5738 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5739 } else if (arg.indexOf('/') >= 0) {
5740 // The argument is a component name. Build an Intent to launch
5741 // it.
5742 baseIntent = new Intent(Intent.ACTION_MAIN);
5743 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5744 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5745 } else {
5746 // Assume the argument is a package name.
5747 baseIntent = new Intent(Intent.ACTION_MAIN);
5748 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5749 baseIntent.setPackage(arg);
5750 }
5751 if (baseIntent != null) {
5752 Bundle extras = intent.getExtras();
5753 intent.replaceExtras((Bundle)null);
5754 Bundle uriExtras = baseIntent.getExtras();
5755 baseIntent.replaceExtras((Bundle)null);
5756 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5757 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5758 for (String c : cats) {
5759 baseIntent.removeCategory(c);
5760 }
5761 }
5762 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5763 if (extras == null) {
5764 extras = uriExtras;
5765 } else if (uriExtras != null) {
5766 uriExtras.putAll(extras);
5767 extras = uriExtras;
5768 }
5769 intent.replaceExtras(extras);
5770 hasIntentInfo = true;
5771 }
5772
5773 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5774 return intent;
5775 }
5776
5777 /** @hide */
5778 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5779 final String[] lines = new String[] {
5780 "<INTENT> specifications include these flags and arguments:",
5781 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5782 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5783 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5784 " [--esn <EXTRA_KEY> ...]",
5785 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5786 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5787 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5788 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5789 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5790 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5791 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5792 " (mutiple extras passed as Integer[])",
5793 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5794 " (mutiple extras passed as List<Integer>)",
5795 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5796 " (mutiple extras passed as Long[])",
5797 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5798 " (mutiple extras passed as List<Long>)",
5799 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5800 " (mutiple extras passed as Float[])",
5801 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5802 " (mutiple extras passed as List<Float>)",
5803 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5804 " (mutiple extras passed as String[]; to embed a comma into a string,",
5805 " escape it using \"\\,\")",
5806 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5807 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5808 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005809 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005810 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5811 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5812 " [--debug-log-resolution] [--exclude-stopped-packages]",
5813 " [--include-stopped-packages]",
5814 " [--activity-brought-to-front] [--activity-clear-top]",
5815 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5816 " [--activity-launched-from-history] [--activity-multiple-task]",
5817 " [--activity-no-animation] [--activity-no-history]",
5818 " [--activity-no-user-action] [--activity-previous-is-top]",
5819 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5820 " [--activity-single-top] [--activity-clear-task]",
5821 " [--activity-task-on-home]",
5822 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005823 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005824 " [--selector]",
5825 " [<URI> | <PACKAGE> | <COMPONENT>]"
5826 };
5827 for (String line : lines) {
5828 pw.print(prefix);
5829 pw.println(line);
5830 }
5831 }
5832
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005833 /**
5834 * Retrieve the general action to be performed, such as
5835 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5836 * the information in the intent should be interpreted -- most importantly,
5837 * what to do with the data returned by {@link #getData}.
5838 *
5839 * @return The action of this intent or null if none is specified.
5840 *
5841 * @see #setAction
5842 */
5843 public String getAction() {
5844 return mAction;
5845 }
5846
5847 /**
5848 * Retrieve data this intent is operating on. This URI specifies the name
5849 * of the data; often it uses the content: scheme, specifying data in a
5850 * content provider. Other schemes may be handled by specific activities,
5851 * such as http: by the web browser.
5852 *
5853 * @return The URI of the data this intent is targeting or null.
5854 *
5855 * @see #getScheme
5856 * @see #setData
5857 */
5858 public Uri getData() {
5859 return mData;
5860 }
5861
5862 /**
5863 * The same as {@link #getData()}, but returns the URI as an encoded
5864 * String.
5865 */
5866 public String getDataString() {
5867 return mData != null ? mData.toString() : null;
5868 }
5869
5870 /**
5871 * Return the scheme portion of the intent's data. If the data is null or
5872 * does not include a scheme, null is returned. Otherwise, the scheme
5873 * prefix without the final ':' is returned, i.e. "http".
5874 *
5875 * <p>This is the same as calling getData().getScheme() (and checking for
5876 * null data).
5877 *
5878 * @return The scheme of this intent.
5879 *
5880 * @see #getData
5881 */
5882 public String getScheme() {
5883 return mData != null ? mData.getScheme() : null;
5884 }
5885
5886 /**
5887 * Retrieve any explicit MIME type included in the intent. This is usually
5888 * null, as the type is determined by the intent data.
5889 *
5890 * @return If a type was manually set, it is returned; else null is
5891 * returned.
5892 *
5893 * @see #resolveType(ContentResolver)
5894 * @see #setType
5895 */
5896 public String getType() {
5897 return mType;
5898 }
5899
5900 /**
5901 * Return the MIME data type of this intent. If the type field is
5902 * explicitly set, that is simply returned. Otherwise, if the data is set,
5903 * the type of that data is returned. If neither fields are set, a null is
5904 * returned.
5905 *
5906 * @return The MIME type of this intent.
5907 *
5908 * @see #getType
5909 * @see #resolveType(ContentResolver)
5910 */
5911 public String resolveType(Context context) {
5912 return resolveType(context.getContentResolver());
5913 }
5914
5915 /**
5916 * Return the MIME data type of this intent. If the type field is
5917 * explicitly set, that is simply returned. Otherwise, if the data is set,
5918 * the type of that data is returned. If neither fields are set, a null is
5919 * returned.
5920 *
5921 * @param resolver A ContentResolver that can be used to determine the MIME
5922 * type of the intent's data.
5923 *
5924 * @return The MIME type of this intent.
5925 *
5926 * @see #getType
5927 * @see #resolveType(Context)
5928 */
5929 public String resolveType(ContentResolver resolver) {
5930 if (mType != null) {
5931 return mType;
5932 }
5933 if (mData != null) {
5934 if ("content".equals(mData.getScheme())) {
5935 return resolver.getType(mData);
5936 }
5937 }
5938 return null;
5939 }
5940
5941 /**
5942 * Return the MIME data type of this intent, only if it will be needed for
5943 * intent resolution. This is not generally useful for application code;
5944 * it is used by the frameworks for communicating with back-end system
5945 * services.
5946 *
5947 * @param resolver A ContentResolver that can be used to determine the MIME
5948 * type of the intent's data.
5949 *
5950 * @return The MIME type of this intent, or null if it is unknown or not
5951 * needed.
5952 */
5953 public String resolveTypeIfNeeded(ContentResolver resolver) {
5954 if (mComponent != null) {
5955 return mType;
5956 }
5957 return resolveType(resolver);
5958 }
5959
5960 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005961 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005962 *
5963 * @param category The category to check.
5964 *
5965 * @return boolean True if the intent contains the category, else false.
5966 *
5967 * @see #getCategories
5968 * @see #addCategory
5969 */
5970 public boolean hasCategory(String category) {
5971 return mCategories != null && mCategories.contains(category);
5972 }
5973
5974 /**
5975 * Return the set of all categories in the intent. If there are no categories,
5976 * returns NULL.
5977 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005978 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005979 *
5980 * @see #hasCategory
5981 * @see #addCategory
5982 */
5983 public Set<String> getCategories() {
5984 return mCategories;
5985 }
5986
5987 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005988 * Return the specific selector associated with this Intent. If there is
5989 * none, returns null. See {@link #setSelector} for more information.
5990 *
5991 * @see #setSelector
5992 */
5993 public Intent getSelector() {
5994 return mSelector;
5995 }
5996
5997 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005998 * Return the {@link ClipData} associated with this Intent. If there is
5999 * none, returns null. See {@link #setClipData} for more information.
6000 *
John Spurlock125d1332013-11-25 11:58:37 -05006001 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006002 */
6003 public ClipData getClipData() {
6004 return mClipData;
6005 }
6006
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006007 /** @hide */
6008 public int getContentUserHint() {
6009 return mContentUserHint;
6010 }
6011
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006012 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006013 * Sets the ClassLoader that will be used when unmarshalling
6014 * any Parcelable values from the extras of this Intent.
6015 *
6016 * @param loader a ClassLoader, or null to use the default loader
6017 * at the time of unmarshalling.
6018 */
6019 public void setExtrasClassLoader(ClassLoader loader) {
6020 if (mExtras != null) {
6021 mExtras.setClassLoader(loader);
6022 }
6023 }
6024
6025 /**
6026 * Returns true if an extra value is associated with the given name.
6027 * @param name the extra's name
6028 * @return true if the given extra is present.
6029 */
6030 public boolean hasExtra(String name) {
6031 return mExtras != null && mExtras.containsKey(name);
6032 }
6033
6034 /**
6035 * Returns true if the Intent's extras contain a parcelled file descriptor.
6036 * @return true if the Intent contains a parcelled file descriptor.
6037 */
6038 public boolean hasFileDescriptors() {
6039 return mExtras != null && mExtras.hasFileDescriptors();
6040 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006041
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006042 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006043 public void setAllowFds(boolean allowFds) {
6044 if (mExtras != null) {
6045 mExtras.setAllowFds(allowFds);
6046 }
6047 }
6048
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006049 /** {@hide} */
6050 public void setDefusable(boolean defusable) {
6051 if (mExtras != null) {
6052 mExtras.setDefusable(defusable);
6053 }
6054 }
6055
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006056 /**
6057 * Retrieve extended data from the intent.
6058 *
6059 * @param name The name of the desired item.
6060 *
6061 * @return the value of an item that previously added with putExtra()
6062 * or null if none was found.
6063 *
6064 * @deprecated
6065 * @hide
6066 */
6067 @Deprecated
6068 public Object getExtra(String name) {
6069 return getExtra(name, null);
6070 }
6071
6072 /**
6073 * Retrieve extended data from the intent.
6074 *
6075 * @param name The name of the desired item.
6076 * @param defaultValue the value to be returned if no value of the desired
6077 * type is stored with the given name.
6078 *
6079 * @return the value of an item that previously added with putExtra()
6080 * or the default value if none was found.
6081 *
6082 * @see #putExtra(String, boolean)
6083 */
6084 public boolean getBooleanExtra(String name, boolean defaultValue) {
6085 return mExtras == null ? defaultValue :
6086 mExtras.getBoolean(name, defaultValue);
6087 }
6088
6089 /**
6090 * Retrieve extended data from the intent.
6091 *
6092 * @param name The name of the desired item.
6093 * @param defaultValue the value to be returned if no value of the desired
6094 * type is stored with the given name.
6095 *
6096 * @return the value of an item that previously added with putExtra()
6097 * or the default value if none was found.
6098 *
6099 * @see #putExtra(String, byte)
6100 */
6101 public byte getByteExtra(String name, byte defaultValue) {
6102 return mExtras == null ? defaultValue :
6103 mExtras.getByte(name, defaultValue);
6104 }
6105
6106 /**
6107 * Retrieve extended data from the intent.
6108 *
6109 * @param name The name of the desired item.
6110 * @param defaultValue the value to be returned if no value of the desired
6111 * type is stored with the given name.
6112 *
6113 * @return the value of an item that previously added with putExtra()
6114 * or the default value if none was found.
6115 *
6116 * @see #putExtra(String, short)
6117 */
6118 public short getShortExtra(String name, short defaultValue) {
6119 return mExtras == null ? defaultValue :
6120 mExtras.getShort(name, defaultValue);
6121 }
6122
6123 /**
6124 * Retrieve extended data from the intent.
6125 *
6126 * @param name The name of the desired item.
6127 * @param defaultValue the value to be returned if no value of the desired
6128 * type is stored with the given name.
6129 *
6130 * @return the value of an item that previously added with putExtra()
6131 * or the default value if none was found.
6132 *
6133 * @see #putExtra(String, char)
6134 */
6135 public char getCharExtra(String name, char defaultValue) {
6136 return mExtras == null ? defaultValue :
6137 mExtras.getChar(name, defaultValue);
6138 }
6139
6140 /**
6141 * Retrieve extended data from the intent.
6142 *
6143 * @param name The name of the desired item.
6144 * @param defaultValue the value to be returned if no value of the desired
6145 * type is stored with the given name.
6146 *
6147 * @return the value of an item that previously added with putExtra()
6148 * or the default value if none was found.
6149 *
6150 * @see #putExtra(String, int)
6151 */
6152 public int getIntExtra(String name, int defaultValue) {
6153 return mExtras == null ? defaultValue :
6154 mExtras.getInt(name, defaultValue);
6155 }
6156
6157 /**
6158 * Retrieve extended data from the intent.
6159 *
6160 * @param name The name of the desired item.
6161 * @param defaultValue the value to be returned if no value of the desired
6162 * type is stored with the given name.
6163 *
6164 * @return the value of an item that previously added with putExtra()
6165 * or the default value if none was found.
6166 *
6167 * @see #putExtra(String, long)
6168 */
6169 public long getLongExtra(String name, long defaultValue) {
6170 return mExtras == null ? defaultValue :
6171 mExtras.getLong(name, defaultValue);
6172 }
6173
6174 /**
6175 * Retrieve extended data from the intent.
6176 *
6177 * @param name The name of the desired item.
6178 * @param defaultValue the value to be returned if no value of the desired
6179 * type is stored with the given name.
6180 *
6181 * @return the value of an item that previously added with putExtra(),
6182 * or the default value if no such item is present
6183 *
6184 * @see #putExtra(String, float)
6185 */
6186 public float getFloatExtra(String name, float defaultValue) {
6187 return mExtras == null ? defaultValue :
6188 mExtras.getFloat(name, defaultValue);
6189 }
6190
6191 /**
6192 * Retrieve extended data from the intent.
6193 *
6194 * @param name The name of the desired item.
6195 * @param defaultValue the value to be returned if no value of the desired
6196 * type is stored with the given name.
6197 *
6198 * @return the value of an item that previously added with putExtra()
6199 * or the default value if none was found.
6200 *
6201 * @see #putExtra(String, double)
6202 */
6203 public double getDoubleExtra(String name, double defaultValue) {
6204 return mExtras == null ? defaultValue :
6205 mExtras.getDouble(name, defaultValue);
6206 }
6207
6208 /**
6209 * Retrieve extended data from the intent.
6210 *
6211 * @param name The name of the desired item.
6212 *
6213 * @return the value of an item that previously added with putExtra()
6214 * or null if no String value was found.
6215 *
6216 * @see #putExtra(String, String)
6217 */
6218 public String getStringExtra(String name) {
6219 return mExtras == null ? null : mExtras.getString(name);
6220 }
6221
6222 /**
6223 * Retrieve extended data from the intent.
6224 *
6225 * @param name The name of the desired item.
6226 *
6227 * @return the value of an item that previously added with putExtra()
6228 * or null if no CharSequence value was found.
6229 *
6230 * @see #putExtra(String, CharSequence)
6231 */
6232 public CharSequence getCharSequenceExtra(String name) {
6233 return mExtras == null ? null : mExtras.getCharSequence(name);
6234 }
6235
6236 /**
6237 * Retrieve extended data from the intent.
6238 *
6239 * @param name The name of the desired item.
6240 *
6241 * @return the value of an item that previously added with putExtra()
6242 * or null if no Parcelable value was found.
6243 *
6244 * @see #putExtra(String, Parcelable)
6245 */
6246 public <T extends Parcelable> T getParcelableExtra(String name) {
6247 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6248 }
6249
6250 /**
6251 * Retrieve extended data from the intent.
6252 *
6253 * @param name The name of the desired item.
6254 *
6255 * @return the value of an item that previously added with putExtra()
6256 * or null if no Parcelable[] value was found.
6257 *
6258 * @see #putExtra(String, Parcelable[])
6259 */
6260 public Parcelable[] getParcelableArrayExtra(String name) {
6261 return mExtras == null ? null : mExtras.getParcelableArray(name);
6262 }
6263
6264 /**
6265 * Retrieve extended data from the intent.
6266 *
6267 * @param name The name of the desired item.
6268 *
6269 * @return the value of an item that previously added with putExtra()
6270 * or null if no ArrayList<Parcelable> value was found.
6271 *
6272 * @see #putParcelableArrayListExtra(String, ArrayList)
6273 */
6274 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6275 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6276 }
6277
6278 /**
6279 * Retrieve extended data from the intent.
6280 *
6281 * @param name The name of the desired item.
6282 *
6283 * @return the value of an item that previously added with putExtra()
6284 * or null if no Serializable value was found.
6285 *
6286 * @see #putExtra(String, Serializable)
6287 */
6288 public Serializable getSerializableExtra(String name) {
6289 return mExtras == null ? null : mExtras.getSerializable(name);
6290 }
6291
6292 /**
6293 * Retrieve extended data from the intent.
6294 *
6295 * @param name The name of the desired item.
6296 *
6297 * @return the value of an item that previously added with putExtra()
6298 * or null if no ArrayList<Integer> value was found.
6299 *
6300 * @see #putIntegerArrayListExtra(String, ArrayList)
6301 */
6302 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6303 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6304 }
6305
6306 /**
6307 * Retrieve extended data from the intent.
6308 *
6309 * @param name The name of the desired item.
6310 *
6311 * @return the value of an item that previously added with putExtra()
6312 * or null if no ArrayList<String> value was found.
6313 *
6314 * @see #putStringArrayListExtra(String, ArrayList)
6315 */
6316 public ArrayList<String> getStringArrayListExtra(String name) {
6317 return mExtras == null ? null : mExtras.getStringArrayList(name);
6318 }
6319
6320 /**
6321 * Retrieve extended data from the intent.
6322 *
6323 * @param name The name of the desired item.
6324 *
6325 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006326 * or null if no ArrayList<CharSequence> value was found.
6327 *
6328 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6329 */
6330 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6331 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6332 }
6333
6334 /**
6335 * Retrieve extended data from the intent.
6336 *
6337 * @param name The name of the desired item.
6338 *
6339 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006340 * or null if no boolean array value was found.
6341 *
6342 * @see #putExtra(String, boolean[])
6343 */
6344 public boolean[] getBooleanArrayExtra(String name) {
6345 return mExtras == null ? null : mExtras.getBooleanArray(name);
6346 }
6347
6348 /**
6349 * Retrieve extended data from the intent.
6350 *
6351 * @param name The name of the desired item.
6352 *
6353 * @return the value of an item that previously added with putExtra()
6354 * or null if no byte array value was found.
6355 *
6356 * @see #putExtra(String, byte[])
6357 */
6358 public byte[] getByteArrayExtra(String name) {
6359 return mExtras == null ? null : mExtras.getByteArray(name);
6360 }
6361
6362 /**
6363 * Retrieve extended data from the intent.
6364 *
6365 * @param name The name of the desired item.
6366 *
6367 * @return the value of an item that previously added with putExtra()
6368 * or null if no short array value was found.
6369 *
6370 * @see #putExtra(String, short[])
6371 */
6372 public short[] getShortArrayExtra(String name) {
6373 return mExtras == null ? null : mExtras.getShortArray(name);
6374 }
6375
6376 /**
6377 * Retrieve extended data from the intent.
6378 *
6379 * @param name The name of the desired item.
6380 *
6381 * @return the value of an item that previously added with putExtra()
6382 * or null if no char array value was found.
6383 *
6384 * @see #putExtra(String, char[])
6385 */
6386 public char[] getCharArrayExtra(String name) {
6387 return mExtras == null ? null : mExtras.getCharArray(name);
6388 }
6389
6390 /**
6391 * Retrieve extended data from the intent.
6392 *
6393 * @param name The name of the desired item.
6394 *
6395 * @return the value of an item that previously added with putExtra()
6396 * or null if no int array value was found.
6397 *
6398 * @see #putExtra(String, int[])
6399 */
6400 public int[] getIntArrayExtra(String name) {
6401 return mExtras == null ? null : mExtras.getIntArray(name);
6402 }
6403
6404 /**
6405 * Retrieve extended data from the intent.
6406 *
6407 * @param name The name of the desired item.
6408 *
6409 * @return the value of an item that previously added with putExtra()
6410 * or null if no long array value was found.
6411 *
6412 * @see #putExtra(String, long[])
6413 */
6414 public long[] getLongArrayExtra(String name) {
6415 return mExtras == null ? null : mExtras.getLongArray(name);
6416 }
6417
6418 /**
6419 * Retrieve extended data from the intent.
6420 *
6421 * @param name The name of the desired item.
6422 *
6423 * @return the value of an item that previously added with putExtra()
6424 * or null if no float array value was found.
6425 *
6426 * @see #putExtra(String, float[])
6427 */
6428 public float[] getFloatArrayExtra(String name) {
6429 return mExtras == null ? null : mExtras.getFloatArray(name);
6430 }
6431
6432 /**
6433 * Retrieve extended data from the intent.
6434 *
6435 * @param name The name of the desired item.
6436 *
6437 * @return the value of an item that previously added with putExtra()
6438 * or null if no double array value was found.
6439 *
6440 * @see #putExtra(String, double[])
6441 */
6442 public double[] getDoubleArrayExtra(String name) {
6443 return mExtras == null ? null : mExtras.getDoubleArray(name);
6444 }
6445
6446 /**
6447 * Retrieve extended data from the intent.
6448 *
6449 * @param name The name of the desired item.
6450 *
6451 * @return the value of an item that previously added with putExtra()
6452 * or null if no String array value was found.
6453 *
6454 * @see #putExtra(String, String[])
6455 */
6456 public String[] getStringArrayExtra(String name) {
6457 return mExtras == null ? null : mExtras.getStringArray(name);
6458 }
6459
6460 /**
6461 * Retrieve extended data from the intent.
6462 *
6463 * @param name The name of the desired item.
6464 *
6465 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006466 * or null if no CharSequence array value was found.
6467 *
6468 * @see #putExtra(String, CharSequence[])
6469 */
6470 public CharSequence[] getCharSequenceArrayExtra(String name) {
6471 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6472 }
6473
6474 /**
6475 * Retrieve extended data from the intent.
6476 *
6477 * @param name The name of the desired item.
6478 *
6479 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006480 * or null if no Bundle value was found.
6481 *
6482 * @see #putExtra(String, Bundle)
6483 */
6484 public Bundle getBundleExtra(String name) {
6485 return mExtras == null ? null : mExtras.getBundle(name);
6486 }
6487
6488 /**
6489 * Retrieve extended data from the intent.
6490 *
6491 * @param name The name of the desired item.
6492 *
6493 * @return the value of an item that previously added with putExtra()
6494 * or null if no IBinder value was found.
6495 *
6496 * @see #putExtra(String, IBinder)
6497 *
6498 * @deprecated
6499 * @hide
6500 */
6501 @Deprecated
6502 public IBinder getIBinderExtra(String name) {
6503 return mExtras == null ? null : mExtras.getIBinder(name);
6504 }
6505
6506 /**
6507 * Retrieve extended data from the intent.
6508 *
6509 * @param name The name of the desired item.
6510 * @param defaultValue The default value to return in case no item is
6511 * associated with the key 'name'
6512 *
6513 * @return the value of an item that previously added with putExtra()
6514 * or defaultValue if none was found.
6515 *
6516 * @see #putExtra
6517 *
6518 * @deprecated
6519 * @hide
6520 */
6521 @Deprecated
6522 public Object getExtra(String name, Object defaultValue) {
6523 Object result = defaultValue;
6524 if (mExtras != null) {
6525 Object result2 = mExtras.get(name);
6526 if (result2 != null) {
6527 result = result2;
6528 }
6529 }
6530
6531 return result;
6532 }
6533
6534 /**
6535 * Retrieves a map of extended data from the intent.
6536 *
6537 * @return the map of all extras previously added with putExtra(),
6538 * or null if none have been added.
6539 */
6540 public Bundle getExtras() {
6541 return (mExtras != null)
6542 ? new Bundle(mExtras)
6543 : null;
6544 }
6545
6546 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006547 * Filter extras to only basic types.
6548 * @hide
6549 */
6550 public void removeUnsafeExtras() {
6551 if (mExtras != null) {
6552 mExtras.filterValues();
6553 }
6554 }
6555
6556 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006557 * Retrieve any special flags associated with this intent. You will
6558 * normally just set them with {@link #setFlags} and let the system
6559 * take the appropriate action with them.
6560 *
6561 * @return int The currently set flags.
6562 *
6563 * @see #setFlags
6564 */
6565 public int getFlags() {
6566 return mFlags;
6567 }
6568
Dianne Hackborne7f97212011-02-24 14:40:20 -08006569 /** @hide */
6570 public boolean isExcludingStopped() {
6571 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6572 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6573 }
6574
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006575 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006576 * Retrieve the application package name this Intent is limited to. When
6577 * resolving an Intent, if non-null this limits the resolution to only
6578 * components in the given application package.
6579 *
6580 * @return The name of the application package for the Intent.
6581 *
6582 * @see #resolveActivity
6583 * @see #setPackage
6584 */
6585 public String getPackage() {
6586 return mPackage;
6587 }
6588
6589 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006590 * Retrieve the concrete component associated with the intent. When receiving
6591 * an intent, this is the component that was found to best handle it (that is,
6592 * yourself) and will always be non-null; in all other cases it will be
6593 * null unless explicitly set.
6594 *
6595 * @return The name of the application component to handle the intent.
6596 *
6597 * @see #resolveActivity
6598 * @see #setComponent
6599 */
6600 public ComponentName getComponent() {
6601 return mComponent;
6602 }
6603
6604 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006605 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6606 * used as a hint to the receiver for animations and the like. Null means that there
6607 * is no source bounds.
6608 */
6609 public Rect getSourceBounds() {
6610 return mSourceBounds;
6611 }
6612
6613 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006614 * Return the Activity component that should be used to handle this intent.
6615 * The appropriate component is determined based on the information in the
6616 * intent, evaluated as follows:
6617 *
6618 * <p>If {@link #getComponent} returns an explicit class, that is returned
6619 * without any further consideration.
6620 *
6621 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6622 * category to be considered.
6623 *
6624 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6625 * action.
6626 *
6627 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6628 * this type.
6629 *
6630 * <p>If {@link #addCategory} has added any categories, the activity must
6631 * handle ALL of the categories specified.
6632 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006633 * <p>If {@link #getPackage} is non-NULL, only activity components in
6634 * that application package will be considered.
6635 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006636 * <p>If there are no activities that satisfy all of these conditions, a
6637 * null string is returned.
6638 *
6639 * <p>If multiple activities are found to satisfy the intent, the one with
6640 * the highest priority will be used. If there are multiple activities
6641 * with the same priority, the system will either pick the best activity
6642 * based on user preference, or resolve to a system class that will allow
6643 * the user to pick an activity and forward from there.
6644 *
6645 * <p>This method is implemented simply by calling
6646 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6647 * true.</p>
6648 * <p> This API is called for you as part of starting an activity from an
6649 * intent. You do not normally need to call it yourself.</p>
6650 *
6651 * @param pm The package manager with which to resolve the Intent.
6652 *
6653 * @return Name of the component implementing an activity that can
6654 * display the intent.
6655 *
6656 * @see #setComponent
6657 * @see #getComponent
6658 * @see #resolveActivityInfo
6659 */
6660 public ComponentName resolveActivity(PackageManager pm) {
6661 if (mComponent != null) {
6662 return mComponent;
6663 }
6664
6665 ResolveInfo info = pm.resolveActivity(
6666 this, PackageManager.MATCH_DEFAULT_ONLY);
6667 if (info != null) {
6668 return new ComponentName(
6669 info.activityInfo.applicationInfo.packageName,
6670 info.activityInfo.name);
6671 }
6672
6673 return null;
6674 }
6675
6676 /**
6677 * Resolve the Intent into an {@link ActivityInfo}
6678 * describing the activity that should execute the intent. Resolution
6679 * follows the same rules as described for {@link #resolveActivity}, but
6680 * you get back the completely information about the resolved activity
6681 * instead of just its class name.
6682 *
6683 * @param pm The package manager with which to resolve the Intent.
6684 * @param flags Addition information to retrieve as per
6685 * {@link PackageManager#getActivityInfo(ComponentName, int)
6686 * PackageManager.getActivityInfo()}.
6687 *
6688 * @return PackageManager.ActivityInfo
6689 *
6690 * @see #resolveActivity
6691 */
6692 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6693 ActivityInfo ai = null;
6694 if (mComponent != null) {
6695 try {
6696 ai = pm.getActivityInfo(mComponent, flags);
6697 } catch (PackageManager.NameNotFoundException e) {
6698 // ignore
6699 }
6700 } else {
6701 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006702 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006703 if (info != null) {
6704 ai = info.activityInfo;
6705 }
6706 }
6707
6708 return ai;
6709 }
6710
6711 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006712 * Special function for use by the system to resolve service
6713 * intents to system apps. Throws an exception if there are
6714 * multiple potential matches to the Intent. Returns null if
6715 * there are no matches.
6716 * @hide
6717 */
6718 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6719 if (mComponent != null) {
6720 return mComponent;
6721 }
6722
6723 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6724 if (results == null) {
6725 return null;
6726 }
6727 ComponentName comp = null;
6728 for (int i=0; i<results.size(); i++) {
6729 ResolveInfo ri = results.get(i);
6730 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6731 continue;
6732 }
6733 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6734 ri.serviceInfo.name);
6735 if (comp != null) {
6736 throw new IllegalStateException("Multiple system services handle " + this
6737 + ": " + comp + ", " + foundComp);
6738 }
6739 comp = foundComp;
6740 }
6741 return comp;
6742 }
6743
6744 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006745 * Set the general action to be performed.
6746 *
6747 * @param action An action name, such as ACTION_VIEW. Application-specific
6748 * actions should be prefixed with the vendor's package name.
6749 *
6750 * @return Returns the same Intent object, for chaining multiple calls
6751 * into a single statement.
6752 *
6753 * @see #getAction
6754 */
6755 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006756 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006757 return this;
6758 }
6759
6760 /**
6761 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006762 * clears any type that was previously set by {@link #setType} or
6763 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006764 *
Nick Pellyccae4122012-01-09 14:12:58 -08006765 * <p><em>Note: scheme matching in the Android framework is
6766 * case-sensitive, unlike the formal RFC. As a result,
6767 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006768 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006769 * {@link #setDataAndNormalize}
6770 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006771 *
Nick Pellyccae4122012-01-09 14:12:58 -08006772 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006773 *
6774 * @return Returns the same Intent object, for chaining multiple calls
6775 * into a single statement.
6776 *
6777 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006778 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006779 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006780 */
6781 public Intent setData(Uri data) {
6782 mData = data;
6783 mType = null;
6784 return this;
6785 }
6786
6787 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006788 * Normalize and set the data this intent is operating on.
6789 *
6790 * <p>This method automatically clears any type that was
6791 * previously set (for example, by {@link #setType}).
6792 *
6793 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006794 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006795 * so really this is just a convenience method for
6796 * <pre>
6797 * setData(data.normalize())
6798 * </pre>
6799 *
6800 * @param data The Uri of the data this intent is now targeting.
6801 *
6802 * @return Returns the same Intent object, for chaining multiple calls
6803 * into a single statement.
6804 *
6805 * @see #getData
6806 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006807 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006808 */
6809 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006810 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006811 }
6812
6813 /**
6814 * Set an explicit MIME data type.
6815 *
6816 * <p>This is used to create intents that only specify a type and not data,
6817 * for example to indicate the type of data to return.
6818 *
6819 * <p>This method automatically clears any data that was
6820 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006821 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006822 * <p><em>Note: MIME type matching in the Android framework is
6823 * case-sensitive, unlike formal RFC MIME types. As a result,
6824 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006825 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6826 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006827 *
6828 * @param type The MIME type of the data being handled by this intent.
6829 *
6830 * @return Returns the same Intent object, for chaining multiple calls
6831 * into a single statement.
6832 *
6833 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006834 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006835 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006836 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006837 */
6838 public Intent setType(String type) {
6839 mData = null;
6840 mType = type;
6841 return this;
6842 }
6843
6844 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006845 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006846 *
Nick Pellyccae4122012-01-09 14:12:58 -08006847 * <p>This is used to create intents that only specify a type and not data,
6848 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006849 *
Nick Pellyccae4122012-01-09 14:12:58 -08006850 * <p>This method automatically clears any data that was
6851 * previously set (for example by {@link #setData}).
6852 *
6853 * <p>The MIME type is normalized using
6854 * {@link #normalizeMimeType} before it is set,
6855 * so really this is just a convenience method for
6856 * <pre>
6857 * setType(Intent.normalizeMimeType(type))
6858 * </pre>
6859 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006860 * @param type The MIME type of the data being handled by this intent.
6861 *
6862 * @return Returns the same Intent object, for chaining multiple calls
6863 * into a single statement.
6864 *
Nick Pellyccae4122012-01-09 14:12:58 -08006865 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006866 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006867 * @see #normalizeMimeType
6868 */
6869 public Intent setTypeAndNormalize(String type) {
6870 return setType(normalizeMimeType(type));
6871 }
6872
6873 /**
6874 * (Usually optional) Set the data for the intent along with an explicit
6875 * MIME data type. This method should very rarely be used -- it allows you
6876 * to override the MIME type that would ordinarily be inferred from the
6877 * data with your own type given here.
6878 *
6879 * <p><em>Note: MIME type and Uri scheme matching in the
6880 * Android framework is case-sensitive, unlike the formal RFC definitions.
6881 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006882 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006883 * {@link #setDataAndTypeAndNormalize}
6884 * to ensure that they are converted to lower case.</em>
6885 *
6886 * @param data The Uri of the data this intent is now targeting.
6887 * @param type The MIME type of the data being handled by this intent.
6888 *
6889 * @return Returns the same Intent object, for chaining multiple calls
6890 * into a single statement.
6891 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006892 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006893 * @see #setData
6894 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006895 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006896 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006897 */
6898 public Intent setDataAndType(Uri data, String type) {
6899 mData = data;
6900 mType = type;
6901 return this;
6902 }
6903
6904 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006905 * (Usually optional) Normalize and set both the data Uri and an explicit
6906 * MIME data type. This method should very rarely be used -- it allows you
6907 * to override the MIME type that would ordinarily be inferred from the
6908 * data with your own type given here.
6909 *
6910 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006911 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006912 * before they are set, so really this is just a convenience method for
6913 * <pre>
6914 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6915 * </pre>
6916 *
6917 * @param data The Uri of the data this intent is now targeting.
6918 * @param type The MIME type of the data being handled by this intent.
6919 *
6920 * @return Returns the same Intent object, for chaining multiple calls
6921 * into a single statement.
6922 *
6923 * @see #setType
6924 * @see #setData
6925 * @see #setDataAndType
6926 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006927 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006928 */
6929 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006930 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006931 }
6932
6933 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006934 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006935 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006936 * activities that provide <em>all</em> of the requested categories will be
6937 * used.
6938 *
6939 * @param category The desired category. This can be either one of the
6940 * predefined Intent categories, or a custom category in your own
6941 * namespace.
6942 *
6943 * @return Returns the same Intent object, for chaining multiple calls
6944 * into a single statement.
6945 *
6946 * @see #hasCategory
6947 * @see #removeCategory
6948 */
6949 public Intent addCategory(String category) {
6950 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006951 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006952 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006953 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006954 return this;
6955 }
6956
6957 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006958 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006959 *
6960 * @param category The category to remove.
6961 *
6962 * @see #addCategory
6963 */
6964 public void removeCategory(String category) {
6965 if (mCategories != null) {
6966 mCategories.remove(category);
6967 if (mCategories.size() == 0) {
6968 mCategories = null;
6969 }
6970 }
6971 }
6972
6973 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006974 * Set a selector for this Intent. This is a modification to the kinds of
6975 * things the Intent will match. If the selector is set, it will be used
6976 * when trying to find entities that can handle the Intent, instead of the
6977 * main contents of the Intent. This allows you build an Intent containing
6978 * a generic protocol while targeting it more specifically.
6979 *
6980 * <p>An example of where this may be used is with things like
6981 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6982 * Intent that will launch the Browser application. However, the correct
6983 * main entry point of an application is actually {@link #ACTION_MAIN}
6984 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6985 * used to specify the actual Activity to launch. If you launch the browser
6986 * with something different, undesired behavior may happen if the user has
6987 * previously or later launches it the normal way, since they do not match.
6988 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6989 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6990 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6991 *
6992 * <p>Setting a selector does not impact the behavior of
6993 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6994 * desired behavior of a selector -- it does not impact the base meaning
6995 * of the Intent, just what kinds of things will be matched against it
6996 * when determining who can handle it.</p>
6997 *
6998 * <p>You can not use both a selector and {@link #setPackage(String)} on
6999 * the same base Intent.</p>
7000 *
7001 * @param selector The desired selector Intent; set to null to not use
7002 * a special selector.
7003 */
7004 public void setSelector(Intent selector) {
7005 if (selector == this) {
7006 throw new IllegalArgumentException(
7007 "Intent being set as a selector of itself");
7008 }
7009 if (selector != null && mPackage != null) {
7010 throw new IllegalArgumentException(
7011 "Can't set selector when package name is already set");
7012 }
7013 mSelector = selector;
7014 }
7015
7016 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007017 * Set a {@link ClipData} associated with this Intent. This replaces any
7018 * previously set ClipData.
7019 *
7020 * <p>The ClipData in an intent is not used for Intent matching or other
7021 * such operations. Semantically it is like extras, used to transmit
7022 * additional data with the Intent. The main feature of using this over
7023 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7024 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7025 * items included in the clip data. This is useful, in particular, if
7026 * you want to transmit an Intent containing multiple <code>content:</code>
7027 * URIs for which the recipient may not have global permission to access the
7028 * content provider.
7029 *
7030 * <p>If the ClipData contains items that are themselves Intents, any
7031 * grant flags in those Intents will be ignored. Only the top-level flags
7032 * of the main Intent are respected, and will be applied to all Uri or
7033 * Intent items in the clip (or sub-items of the clip).
7034 *
7035 * <p>The MIME type, label, and icon in the ClipData object are not
7036 * directly used by Intent. Applications should generally rely on the
7037 * MIME type of the Intent itself, not what it may find in the ClipData.
7038 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007039 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007040 *
7041 * @param clip The new clip to set. May be null to clear the current clip.
7042 */
7043 public void setClipData(ClipData clip) {
7044 mClipData = clip;
7045 }
7046
7047 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007048 * This is NOT a secure mechanism to identify the user who sent the intent.
7049 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7050 * who sent the intent.
7051 * @hide
7052 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007053 public void prepareToLeaveUser(int userId) {
7054 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7055 // We want mContentUserHint to refer to the original user, so don't do anything.
7056 if (mContentUserHint == UserHandle.USER_CURRENT) {
7057 mContentUserHint = userId;
7058 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007059 }
7060
7061 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007062 * Add extended data to the intent. The name must include a package
7063 * prefix, for example the app com.android.contacts would use names
7064 * like "com.android.contacts.ShowAll".
7065 *
7066 * @param name The name of the extra data, with package prefix.
7067 * @param value The boolean data value.
7068 *
7069 * @return Returns the same Intent object, for chaining multiple calls
7070 * into a single statement.
7071 *
7072 * @see #putExtras
7073 * @see #removeExtra
7074 * @see #getBooleanExtra(String, boolean)
7075 */
7076 public Intent putExtra(String name, boolean value) {
7077 if (mExtras == null) {
7078 mExtras = new Bundle();
7079 }
7080 mExtras.putBoolean(name, value);
7081 return this;
7082 }
7083
7084 /**
7085 * Add extended data to the intent. The name must include a package
7086 * prefix, for example the app com.android.contacts would use names
7087 * like "com.android.contacts.ShowAll".
7088 *
7089 * @param name The name of the extra data, with package prefix.
7090 * @param value The byte data value.
7091 *
7092 * @return Returns the same Intent object, for chaining multiple calls
7093 * into a single statement.
7094 *
7095 * @see #putExtras
7096 * @see #removeExtra
7097 * @see #getByteExtra(String, byte)
7098 */
7099 public Intent putExtra(String name, byte value) {
7100 if (mExtras == null) {
7101 mExtras = new Bundle();
7102 }
7103 mExtras.putByte(name, value);
7104 return this;
7105 }
7106
7107 /**
7108 * Add extended data to the intent. The name must include a package
7109 * prefix, for example the app com.android.contacts would use names
7110 * like "com.android.contacts.ShowAll".
7111 *
7112 * @param name The name of the extra data, with package prefix.
7113 * @param value The char data value.
7114 *
7115 * @return Returns the same Intent object, for chaining multiple calls
7116 * into a single statement.
7117 *
7118 * @see #putExtras
7119 * @see #removeExtra
7120 * @see #getCharExtra(String, char)
7121 */
7122 public Intent putExtra(String name, char value) {
7123 if (mExtras == null) {
7124 mExtras = new Bundle();
7125 }
7126 mExtras.putChar(name, value);
7127 return this;
7128 }
7129
7130 /**
7131 * Add extended data to the intent. The name must include a package
7132 * prefix, for example the app com.android.contacts would use names
7133 * like "com.android.contacts.ShowAll".
7134 *
7135 * @param name The name of the extra data, with package prefix.
7136 * @param value The short data value.
7137 *
7138 * @return Returns the same Intent object, for chaining multiple calls
7139 * into a single statement.
7140 *
7141 * @see #putExtras
7142 * @see #removeExtra
7143 * @see #getShortExtra(String, short)
7144 */
7145 public Intent putExtra(String name, short value) {
7146 if (mExtras == null) {
7147 mExtras = new Bundle();
7148 }
7149 mExtras.putShort(name, value);
7150 return this;
7151 }
7152
7153 /**
7154 * Add extended data to the intent. The name must include a package
7155 * prefix, for example the app com.android.contacts would use names
7156 * like "com.android.contacts.ShowAll".
7157 *
7158 * @param name The name of the extra data, with package prefix.
7159 * @param value The integer data value.
7160 *
7161 * @return Returns the same Intent object, for chaining multiple calls
7162 * into a single statement.
7163 *
7164 * @see #putExtras
7165 * @see #removeExtra
7166 * @see #getIntExtra(String, int)
7167 */
7168 public Intent putExtra(String name, int value) {
7169 if (mExtras == null) {
7170 mExtras = new Bundle();
7171 }
7172 mExtras.putInt(name, value);
7173 return this;
7174 }
7175
7176 /**
7177 * Add extended data to the intent. The name must include a package
7178 * prefix, for example the app com.android.contacts would use names
7179 * like "com.android.contacts.ShowAll".
7180 *
7181 * @param name The name of the extra data, with package prefix.
7182 * @param value The long data value.
7183 *
7184 * @return Returns the same Intent object, for chaining multiple calls
7185 * into a single statement.
7186 *
7187 * @see #putExtras
7188 * @see #removeExtra
7189 * @see #getLongExtra(String, long)
7190 */
7191 public Intent putExtra(String name, long value) {
7192 if (mExtras == null) {
7193 mExtras = new Bundle();
7194 }
7195 mExtras.putLong(name, value);
7196 return this;
7197 }
7198
7199 /**
7200 * Add extended data to the intent. The name must include a package
7201 * prefix, for example the app com.android.contacts would use names
7202 * like "com.android.contacts.ShowAll".
7203 *
7204 * @param name The name of the extra data, with package prefix.
7205 * @param value The float data value.
7206 *
7207 * @return Returns the same Intent object, for chaining multiple calls
7208 * into a single statement.
7209 *
7210 * @see #putExtras
7211 * @see #removeExtra
7212 * @see #getFloatExtra(String, float)
7213 */
7214 public Intent putExtra(String name, float value) {
7215 if (mExtras == null) {
7216 mExtras = new Bundle();
7217 }
7218 mExtras.putFloat(name, value);
7219 return this;
7220 }
7221
7222 /**
7223 * Add extended data to the intent. The name must include a package
7224 * prefix, for example the app com.android.contacts would use names
7225 * like "com.android.contacts.ShowAll".
7226 *
7227 * @param name The name of the extra data, with package prefix.
7228 * @param value The double data value.
7229 *
7230 * @return Returns the same Intent object, for chaining multiple calls
7231 * into a single statement.
7232 *
7233 * @see #putExtras
7234 * @see #removeExtra
7235 * @see #getDoubleExtra(String, double)
7236 */
7237 public Intent putExtra(String name, double value) {
7238 if (mExtras == null) {
7239 mExtras = new Bundle();
7240 }
7241 mExtras.putDouble(name, value);
7242 return this;
7243 }
7244
7245 /**
7246 * Add extended data to the intent. The name must include a package
7247 * prefix, for example the app com.android.contacts would use names
7248 * like "com.android.contacts.ShowAll".
7249 *
7250 * @param name The name of the extra data, with package prefix.
7251 * @param value The String data value.
7252 *
7253 * @return Returns the same Intent object, for chaining multiple calls
7254 * into a single statement.
7255 *
7256 * @see #putExtras
7257 * @see #removeExtra
7258 * @see #getStringExtra(String)
7259 */
7260 public Intent putExtra(String name, String value) {
7261 if (mExtras == null) {
7262 mExtras = new Bundle();
7263 }
7264 mExtras.putString(name, value);
7265 return this;
7266 }
7267
7268 /**
7269 * Add extended data to the intent. The name must include a package
7270 * prefix, for example the app com.android.contacts would use names
7271 * like "com.android.contacts.ShowAll".
7272 *
7273 * @param name The name of the extra data, with package prefix.
7274 * @param value The CharSequence data value.
7275 *
7276 * @return Returns the same Intent object, for chaining multiple calls
7277 * into a single statement.
7278 *
7279 * @see #putExtras
7280 * @see #removeExtra
7281 * @see #getCharSequenceExtra(String)
7282 */
7283 public Intent putExtra(String name, CharSequence value) {
7284 if (mExtras == null) {
7285 mExtras = new Bundle();
7286 }
7287 mExtras.putCharSequence(name, value);
7288 return this;
7289 }
7290
7291 /**
7292 * Add extended data to the intent. The name must include a package
7293 * prefix, for example the app com.android.contacts would use names
7294 * like "com.android.contacts.ShowAll".
7295 *
7296 * @param name The name of the extra data, with package prefix.
7297 * @param value The Parcelable data value.
7298 *
7299 * @return Returns the same Intent object, for chaining multiple calls
7300 * into a single statement.
7301 *
7302 * @see #putExtras
7303 * @see #removeExtra
7304 * @see #getParcelableExtra(String)
7305 */
7306 public Intent putExtra(String name, Parcelable value) {
7307 if (mExtras == null) {
7308 mExtras = new Bundle();
7309 }
7310 mExtras.putParcelable(name, value);
7311 return this;
7312 }
7313
7314 /**
7315 * Add extended data to the intent. The name must include a package
7316 * prefix, for example the app com.android.contacts would use names
7317 * like "com.android.contacts.ShowAll".
7318 *
7319 * @param name The name of the extra data, with package prefix.
7320 * @param value The Parcelable[] data value.
7321 *
7322 * @return Returns the same Intent object, for chaining multiple calls
7323 * into a single statement.
7324 *
7325 * @see #putExtras
7326 * @see #removeExtra
7327 * @see #getParcelableArrayExtra(String)
7328 */
7329 public Intent putExtra(String name, Parcelable[] value) {
7330 if (mExtras == null) {
7331 mExtras = new Bundle();
7332 }
7333 mExtras.putParcelableArray(name, value);
7334 return this;
7335 }
7336
7337 /**
7338 * Add extended data to the intent. The name must include a package
7339 * prefix, for example the app com.android.contacts would use names
7340 * like "com.android.contacts.ShowAll".
7341 *
7342 * @param name The name of the extra data, with package prefix.
7343 * @param value The ArrayList<Parcelable> data value.
7344 *
7345 * @return Returns the same Intent object, for chaining multiple calls
7346 * into a single statement.
7347 *
7348 * @see #putExtras
7349 * @see #removeExtra
7350 * @see #getParcelableArrayListExtra(String)
7351 */
7352 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7353 if (mExtras == null) {
7354 mExtras = new Bundle();
7355 }
7356 mExtras.putParcelableArrayList(name, value);
7357 return this;
7358 }
7359
7360 /**
7361 * Add extended data to the intent. The name must include a package
7362 * prefix, for example the app com.android.contacts would use names
7363 * like "com.android.contacts.ShowAll".
7364 *
7365 * @param name The name of the extra data, with package prefix.
7366 * @param value The ArrayList<Integer> data value.
7367 *
7368 * @return Returns the same Intent object, for chaining multiple calls
7369 * into a single statement.
7370 *
7371 * @see #putExtras
7372 * @see #removeExtra
7373 * @see #getIntegerArrayListExtra(String)
7374 */
7375 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7376 if (mExtras == null) {
7377 mExtras = new Bundle();
7378 }
7379 mExtras.putIntegerArrayList(name, value);
7380 return this;
7381 }
7382
7383 /**
7384 * Add extended data to the intent. The name must include a package
7385 * prefix, for example the app com.android.contacts would use names
7386 * like "com.android.contacts.ShowAll".
7387 *
7388 * @param name The name of the extra data, with package prefix.
7389 * @param value The ArrayList<String> data value.
7390 *
7391 * @return Returns the same Intent object, for chaining multiple calls
7392 * into a single statement.
7393 *
7394 * @see #putExtras
7395 * @see #removeExtra
7396 * @see #getStringArrayListExtra(String)
7397 */
7398 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7399 if (mExtras == null) {
7400 mExtras = new Bundle();
7401 }
7402 mExtras.putStringArrayList(name, value);
7403 return this;
7404 }
7405
7406 /**
7407 * Add extended data to the intent. The name must include a package
7408 * prefix, for example the app com.android.contacts would use names
7409 * like "com.android.contacts.ShowAll".
7410 *
7411 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007412 * @param value The ArrayList<CharSequence> data value.
7413 *
7414 * @return Returns the same Intent object, for chaining multiple calls
7415 * into a single statement.
7416 *
7417 * @see #putExtras
7418 * @see #removeExtra
7419 * @see #getCharSequenceArrayListExtra(String)
7420 */
7421 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7422 if (mExtras == null) {
7423 mExtras = new Bundle();
7424 }
7425 mExtras.putCharSequenceArrayList(name, value);
7426 return this;
7427 }
7428
7429 /**
7430 * Add extended data to the intent. The name must include a package
7431 * prefix, for example the app com.android.contacts would use names
7432 * like "com.android.contacts.ShowAll".
7433 *
7434 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007435 * @param value The Serializable data value.
7436 *
7437 * @return Returns the same Intent object, for chaining multiple calls
7438 * into a single statement.
7439 *
7440 * @see #putExtras
7441 * @see #removeExtra
7442 * @see #getSerializableExtra(String)
7443 */
7444 public Intent putExtra(String name, Serializable value) {
7445 if (mExtras == null) {
7446 mExtras = new Bundle();
7447 }
7448 mExtras.putSerializable(name, value);
7449 return this;
7450 }
7451
7452 /**
7453 * Add extended data to the intent. The name must include a package
7454 * prefix, for example the app com.android.contacts would use names
7455 * like "com.android.contacts.ShowAll".
7456 *
7457 * @param name The name of the extra data, with package prefix.
7458 * @param value The boolean array data value.
7459 *
7460 * @return Returns the same Intent object, for chaining multiple calls
7461 * into a single statement.
7462 *
7463 * @see #putExtras
7464 * @see #removeExtra
7465 * @see #getBooleanArrayExtra(String)
7466 */
7467 public Intent putExtra(String name, boolean[] value) {
7468 if (mExtras == null) {
7469 mExtras = new Bundle();
7470 }
7471 mExtras.putBooleanArray(name, value);
7472 return this;
7473 }
7474
7475 /**
7476 * Add extended data to the intent. The name must include a package
7477 * prefix, for example the app com.android.contacts would use names
7478 * like "com.android.contacts.ShowAll".
7479 *
7480 * @param name The name of the extra data, with package prefix.
7481 * @param value The byte array data value.
7482 *
7483 * @return Returns the same Intent object, for chaining multiple calls
7484 * into a single statement.
7485 *
7486 * @see #putExtras
7487 * @see #removeExtra
7488 * @see #getByteArrayExtra(String)
7489 */
7490 public Intent putExtra(String name, byte[] value) {
7491 if (mExtras == null) {
7492 mExtras = new Bundle();
7493 }
7494 mExtras.putByteArray(name, value);
7495 return this;
7496 }
7497
7498 /**
7499 * Add extended data to the intent. The name must include a package
7500 * prefix, for example the app com.android.contacts would use names
7501 * like "com.android.contacts.ShowAll".
7502 *
7503 * @param name The name of the extra data, with package prefix.
7504 * @param value The short array data value.
7505 *
7506 * @return Returns the same Intent object, for chaining multiple calls
7507 * into a single statement.
7508 *
7509 * @see #putExtras
7510 * @see #removeExtra
7511 * @see #getShortArrayExtra(String)
7512 */
7513 public Intent putExtra(String name, short[] value) {
7514 if (mExtras == null) {
7515 mExtras = new Bundle();
7516 }
7517 mExtras.putShortArray(name, value);
7518 return this;
7519 }
7520
7521 /**
7522 * Add extended data to the intent. The name must include a package
7523 * prefix, for example the app com.android.contacts would use names
7524 * like "com.android.contacts.ShowAll".
7525 *
7526 * @param name The name of the extra data, with package prefix.
7527 * @param value The char array data value.
7528 *
7529 * @return Returns the same Intent object, for chaining multiple calls
7530 * into a single statement.
7531 *
7532 * @see #putExtras
7533 * @see #removeExtra
7534 * @see #getCharArrayExtra(String)
7535 */
7536 public Intent putExtra(String name, char[] value) {
7537 if (mExtras == null) {
7538 mExtras = new Bundle();
7539 }
7540 mExtras.putCharArray(name, value);
7541 return this;
7542 }
7543
7544 /**
7545 * Add extended data to the intent. The name must include a package
7546 * prefix, for example the app com.android.contacts would use names
7547 * like "com.android.contacts.ShowAll".
7548 *
7549 * @param name The name of the extra data, with package prefix.
7550 * @param value The int array data value.
7551 *
7552 * @return Returns the same Intent object, for chaining multiple calls
7553 * into a single statement.
7554 *
7555 * @see #putExtras
7556 * @see #removeExtra
7557 * @see #getIntArrayExtra(String)
7558 */
7559 public Intent putExtra(String name, int[] value) {
7560 if (mExtras == null) {
7561 mExtras = new Bundle();
7562 }
7563 mExtras.putIntArray(name, value);
7564 return this;
7565 }
7566
7567 /**
7568 * Add extended data to the intent. The name must include a package
7569 * prefix, for example the app com.android.contacts would use names
7570 * like "com.android.contacts.ShowAll".
7571 *
7572 * @param name The name of the extra data, with package prefix.
7573 * @param value The byte array data value.
7574 *
7575 * @return Returns the same Intent object, for chaining multiple calls
7576 * into a single statement.
7577 *
7578 * @see #putExtras
7579 * @see #removeExtra
7580 * @see #getLongArrayExtra(String)
7581 */
7582 public Intent putExtra(String name, long[] value) {
7583 if (mExtras == null) {
7584 mExtras = new Bundle();
7585 }
7586 mExtras.putLongArray(name, value);
7587 return this;
7588 }
7589
7590 /**
7591 * Add extended data to the intent. The name must include a package
7592 * prefix, for example the app com.android.contacts would use names
7593 * like "com.android.contacts.ShowAll".
7594 *
7595 * @param name The name of the extra data, with package prefix.
7596 * @param value The float array data value.
7597 *
7598 * @return Returns the same Intent object, for chaining multiple calls
7599 * into a single statement.
7600 *
7601 * @see #putExtras
7602 * @see #removeExtra
7603 * @see #getFloatArrayExtra(String)
7604 */
7605 public Intent putExtra(String name, float[] value) {
7606 if (mExtras == null) {
7607 mExtras = new Bundle();
7608 }
7609 mExtras.putFloatArray(name, value);
7610 return this;
7611 }
7612
7613 /**
7614 * Add extended data to the intent. The name must include a package
7615 * prefix, for example the app com.android.contacts would use names
7616 * like "com.android.contacts.ShowAll".
7617 *
7618 * @param name The name of the extra data, with package prefix.
7619 * @param value The double array data value.
7620 *
7621 * @return Returns the same Intent object, for chaining multiple calls
7622 * into a single statement.
7623 *
7624 * @see #putExtras
7625 * @see #removeExtra
7626 * @see #getDoubleArrayExtra(String)
7627 */
7628 public Intent putExtra(String name, double[] value) {
7629 if (mExtras == null) {
7630 mExtras = new Bundle();
7631 }
7632 mExtras.putDoubleArray(name, value);
7633 return this;
7634 }
7635
7636 /**
7637 * Add extended data to the intent. The name must include a package
7638 * prefix, for example the app com.android.contacts would use names
7639 * like "com.android.contacts.ShowAll".
7640 *
7641 * @param name The name of the extra data, with package prefix.
7642 * @param value The String array data value.
7643 *
7644 * @return Returns the same Intent object, for chaining multiple calls
7645 * into a single statement.
7646 *
7647 * @see #putExtras
7648 * @see #removeExtra
7649 * @see #getStringArrayExtra(String)
7650 */
7651 public Intent putExtra(String name, String[] value) {
7652 if (mExtras == null) {
7653 mExtras = new Bundle();
7654 }
7655 mExtras.putStringArray(name, value);
7656 return this;
7657 }
7658
7659 /**
7660 * Add extended data to the intent. The name must include a package
7661 * prefix, for example the app com.android.contacts would use names
7662 * like "com.android.contacts.ShowAll".
7663 *
7664 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007665 * @param value The CharSequence array data value.
7666 *
7667 * @return Returns the same Intent object, for chaining multiple calls
7668 * into a single statement.
7669 *
7670 * @see #putExtras
7671 * @see #removeExtra
7672 * @see #getCharSequenceArrayExtra(String)
7673 */
7674 public Intent putExtra(String name, CharSequence[] value) {
7675 if (mExtras == null) {
7676 mExtras = new Bundle();
7677 }
7678 mExtras.putCharSequenceArray(name, value);
7679 return this;
7680 }
7681
7682 /**
7683 * Add extended data to the intent. The name must include a package
7684 * prefix, for example the app com.android.contacts would use names
7685 * like "com.android.contacts.ShowAll".
7686 *
7687 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007688 * @param value The Bundle data value.
7689 *
7690 * @return Returns the same Intent object, for chaining multiple calls
7691 * into a single statement.
7692 *
7693 * @see #putExtras
7694 * @see #removeExtra
7695 * @see #getBundleExtra(String)
7696 */
7697 public Intent putExtra(String name, Bundle value) {
7698 if (mExtras == null) {
7699 mExtras = new Bundle();
7700 }
7701 mExtras.putBundle(name, value);
7702 return this;
7703 }
7704
7705 /**
7706 * Add extended data to the intent. The name must include a package
7707 * prefix, for example the app com.android.contacts would use names
7708 * like "com.android.contacts.ShowAll".
7709 *
7710 * @param name The name of the extra data, with package prefix.
7711 * @param value The IBinder data value.
7712 *
7713 * @return Returns the same Intent object, for chaining multiple calls
7714 * into a single statement.
7715 *
7716 * @see #putExtras
7717 * @see #removeExtra
7718 * @see #getIBinderExtra(String)
7719 *
7720 * @deprecated
7721 * @hide
7722 */
7723 @Deprecated
7724 public Intent putExtra(String name, IBinder value) {
7725 if (mExtras == null) {
7726 mExtras = new Bundle();
7727 }
7728 mExtras.putIBinder(name, value);
7729 return this;
7730 }
7731
7732 /**
7733 * Copy all extras in 'src' in to this intent.
7734 *
7735 * @param src Contains the extras to copy.
7736 *
7737 * @see #putExtra
7738 */
7739 public Intent putExtras(Intent src) {
7740 if (src.mExtras != null) {
7741 if (mExtras == null) {
7742 mExtras = new Bundle(src.mExtras);
7743 } else {
7744 mExtras.putAll(src.mExtras);
7745 }
7746 }
7747 return this;
7748 }
7749
7750 /**
7751 * Add a set of extended data to the intent. The keys must include a package
7752 * prefix, for example the app com.android.contacts would use names
7753 * like "com.android.contacts.ShowAll".
7754 *
7755 * @param extras The Bundle of extras to add to this intent.
7756 *
7757 * @see #putExtra
7758 * @see #removeExtra
7759 */
7760 public Intent putExtras(Bundle extras) {
7761 if (mExtras == null) {
7762 mExtras = new Bundle();
7763 }
7764 mExtras.putAll(extras);
7765 return this;
7766 }
7767
7768 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007769 * Completely replace the extras in the Intent with the extras in the
7770 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007771 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007772 * @param src The exact extras contained in this Intent are copied
7773 * into the target intent, replacing any that were previously there.
7774 */
7775 public Intent replaceExtras(Intent src) {
7776 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7777 return this;
7778 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007779
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007780 /**
7781 * Completely replace the extras in the Intent with the given Bundle of
7782 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007783 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007784 * @param extras The new set of extras in the Intent, or null to erase
7785 * all extras.
7786 */
7787 public Intent replaceExtras(Bundle extras) {
7788 mExtras = extras != null ? new Bundle(extras) : null;
7789 return this;
7790 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007791
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007792 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007793 * Remove extended data from the intent.
7794 *
7795 * @see #putExtra
7796 */
7797 public void removeExtra(String name) {
7798 if (mExtras != null) {
7799 mExtras.remove(name);
7800 if (mExtras.size() == 0) {
7801 mExtras = null;
7802 }
7803 }
7804 }
7805
7806 /**
7807 * Set special flags controlling how this intent is handled. Most values
7808 * here depend on the type of component being executed by the Intent,
7809 * specifically the FLAG_ACTIVITY_* flags are all for use with
7810 * {@link Context#startActivity Context.startActivity()} and the
7811 * FLAG_RECEIVER_* flags are all for use with
7812 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7813 *
Scott Main7aee61f2011-02-08 11:25:01 -08007814 * <p>See the
7815 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7816 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007817 * the behavior of your application.
7818 *
7819 * @param flags The desired flags.
7820 *
7821 * @return Returns the same Intent object, for chaining multiple calls
7822 * into a single statement.
7823 *
7824 * @see #getFlags
7825 * @see #addFlags
7826 *
7827 * @see #FLAG_GRANT_READ_URI_PERMISSION
7828 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007829 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7830 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007831 * @see #FLAG_DEBUG_LOG_RESOLUTION
7832 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007833 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007834 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007835 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007836 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007837 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7838 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007839 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007840 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007841 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007842 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007843 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007844 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007845 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007846 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7847 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007848 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007849 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007850 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007851 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7852 */
7853 public Intent setFlags(int flags) {
7854 mFlags = flags;
7855 return this;
7856 }
7857
7858 /**
7859 * Add additional flags to the intent (or with existing flags
7860 * value).
7861 *
7862 * @param flags The new flags to set.
7863 *
7864 * @return Returns the same Intent object, for chaining multiple calls
7865 * into a single statement.
7866 *
7867 * @see #setFlags
7868 */
7869 public Intent addFlags(int flags) {
7870 mFlags |= flags;
7871 return this;
7872 }
7873
7874 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007875 * (Usually optional) Set an explicit application package name that limits
7876 * the components this Intent will resolve to. If left to the default
7877 * value of null, all components in all applications will considered.
7878 * If non-null, the Intent can only match the components in the given
7879 * application package.
7880 *
7881 * @param packageName The name of the application package to handle the
7882 * intent, or null to allow any application package.
7883 *
7884 * @return Returns the same Intent object, for chaining multiple calls
7885 * into a single statement.
7886 *
7887 * @see #getPackage
7888 * @see #resolveActivity
7889 */
7890 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007891 if (packageName != null && mSelector != null) {
7892 throw new IllegalArgumentException(
7893 "Can't set package name when selector is already set");
7894 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007895 mPackage = packageName;
7896 return this;
7897 }
7898
7899 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007900 * (Usually optional) Explicitly set the component to handle the intent.
7901 * If left with the default value of null, the system will determine the
7902 * appropriate class to use based on the other fields (action, data,
7903 * type, categories) in the Intent. If this class is defined, the
7904 * specified class will always be used regardless of the other fields. You
7905 * should only set this value when you know you absolutely want a specific
7906 * class to be used; otherwise it is better to let the system find the
7907 * appropriate class so that you will respect the installed applications
7908 * and user preferences.
7909 *
7910 * @param component The name of the application component to handle the
7911 * intent, or null to let the system find one for you.
7912 *
7913 * @return Returns the same Intent object, for chaining multiple calls
7914 * into a single statement.
7915 *
7916 * @see #setClass
7917 * @see #setClassName(Context, String)
7918 * @see #setClassName(String, String)
7919 * @see #getComponent
7920 * @see #resolveActivity
7921 */
7922 public Intent setComponent(ComponentName component) {
7923 mComponent = component;
7924 return this;
7925 }
7926
7927 /**
7928 * Convenience for calling {@link #setComponent} with an
7929 * explicit class name.
7930 *
7931 * @param packageContext A Context of the application package implementing
7932 * this class.
7933 * @param className The name of a class inside of the application package
7934 * that will be used as the component for this Intent.
7935 *
7936 * @return Returns the same Intent object, for chaining multiple calls
7937 * into a single statement.
7938 *
7939 * @see #setComponent
7940 * @see #setClass
7941 */
7942 public Intent setClassName(Context packageContext, String className) {
7943 mComponent = new ComponentName(packageContext, className);
7944 return this;
7945 }
7946
7947 /**
7948 * Convenience for calling {@link #setComponent} with an
7949 * explicit application package name and class name.
7950 *
7951 * @param packageName The name of the package implementing the desired
7952 * component.
7953 * @param className The name of a class inside of the application package
7954 * that will be used as the component for this Intent.
7955 *
7956 * @return Returns the same Intent object, for chaining multiple calls
7957 * into a single statement.
7958 *
7959 * @see #setComponent
7960 * @see #setClass
7961 */
7962 public Intent setClassName(String packageName, String className) {
7963 mComponent = new ComponentName(packageName, className);
7964 return this;
7965 }
7966
7967 /**
7968 * Convenience for calling {@link #setComponent(ComponentName)} with the
7969 * name returned by a {@link Class} object.
7970 *
7971 * @param packageContext A Context of the application package implementing
7972 * this class.
7973 * @param cls The class name to set, equivalent to
7974 * <code>setClassName(context, cls.getName())</code>.
7975 *
7976 * @return Returns the same Intent object, for chaining multiple calls
7977 * into a single statement.
7978 *
7979 * @see #setComponent
7980 */
7981 public Intent setClass(Context packageContext, Class<?> cls) {
7982 mComponent = new ComponentName(packageContext, cls);
7983 return this;
7984 }
7985
7986 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007987 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7988 * used as a hint to the receiver for animations and the like. Null means that there
7989 * is no source bounds.
7990 */
7991 public void setSourceBounds(Rect r) {
7992 if (r != null) {
7993 mSourceBounds = new Rect(r);
7994 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007995 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007996 }
7997 }
7998
Tor Norbyed9273d62013-05-30 15:59:53 -07007999 /** @hide */
8000 @IntDef(flag = true,
8001 value = {
8002 FILL_IN_ACTION,
8003 FILL_IN_DATA,
8004 FILL_IN_CATEGORIES,
8005 FILL_IN_COMPONENT,
8006 FILL_IN_PACKAGE,
8007 FILL_IN_SOURCE_BOUNDS,
8008 FILL_IN_SELECTOR,
8009 FILL_IN_CLIP_DATA
8010 })
8011 @Retention(RetentionPolicy.SOURCE)
8012 public @interface FillInFlags {}
8013
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008014 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008015 * Use with {@link #fillIn} to allow the current action value to be
8016 * overwritten, even if it is already set.
8017 */
8018 public static final int FILL_IN_ACTION = 1<<0;
8019
8020 /**
8021 * Use with {@link #fillIn} to allow the current data or type value
8022 * overwritten, even if it is already set.
8023 */
8024 public static final int FILL_IN_DATA = 1<<1;
8025
8026 /**
8027 * Use with {@link #fillIn} to allow the current categories to be
8028 * overwritten, even if they are already set.
8029 */
8030 public static final int FILL_IN_CATEGORIES = 1<<2;
8031
8032 /**
8033 * Use with {@link #fillIn} to allow the current component value to be
8034 * overwritten, even if it is already set.
8035 */
8036 public static final int FILL_IN_COMPONENT = 1<<3;
8037
8038 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008039 * Use with {@link #fillIn} to allow the current package value to be
8040 * overwritten, even if it is already set.
8041 */
8042 public static final int FILL_IN_PACKAGE = 1<<4;
8043
8044 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008045 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008046 * overwritten, even if it is already set.
8047 */
8048 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8049
8050 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008051 * Use with {@link #fillIn} to allow the current selector to be
8052 * overwritten, even if it is already set.
8053 */
8054 public static final int FILL_IN_SELECTOR = 1<<6;
8055
8056 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008057 * Use with {@link #fillIn} to allow the current ClipData to be
8058 * overwritten, even if it is already set.
8059 */
8060 public static final int FILL_IN_CLIP_DATA = 1<<7;
8061
8062 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008063 * Copy the contents of <var>other</var> in to this object, but only
8064 * where fields are not defined by this object. For purposes of a field
8065 * being defined, the following pieces of data in the Intent are
8066 * considered to be separate fields:
8067 *
8068 * <ul>
8069 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008070 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008071 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8072 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008073 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008074 * <li> component, as set by {@link #setComponent(ComponentName)} or
8075 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008076 * <li> source bounds, as set by {@link #setSourceBounds}.
8077 * <li> selector, as set by {@link #setSelector(Intent)}.
8078 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008079 * <li> each top-level name in the associated extras.
8080 * </ul>
8081 *
8082 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008083 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008084 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8085 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8086 * the restriction where the corresponding field will not be replaced if
8087 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008088 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008089 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8090 * is explicitly specified. The selector will only be copied if
8091 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008092 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008093 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8094 * and Intent B with {action="gotit", data-type="some/thing",
8095 * categories="one","two"}.
8096 *
8097 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8098 * containing: {action="gotit", data-type="some/thing",
8099 * categories="bar"}.
8100 *
8101 * @param other Another Intent whose values are to be used to fill in
8102 * the current one.
8103 * @param flags Options to control which fields can be filled in.
8104 *
8105 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008106 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008107 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8108 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8109 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008111 @FillInFlags
8112 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008113 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008114 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008115 if (other.mAction != null
8116 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008117 mAction = other.mAction;
8118 changes |= FILL_IN_ACTION;
8119 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008120 if ((other.mData != null || other.mType != null)
8121 && ((mData == null && mType == null)
8122 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008123 mData = other.mData;
8124 mType = other.mType;
8125 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008126 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008127 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008128 if (other.mCategories != null
8129 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008130 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008131 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008132 }
8133 changes |= FILL_IN_CATEGORIES;
8134 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008135 if (other.mPackage != null
8136 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008137 // Only do this if mSelector is not set.
8138 if (mSelector == null) {
8139 mPackage = other.mPackage;
8140 changes |= FILL_IN_PACKAGE;
8141 }
8142 }
8143 // Selector is special: it can only be set if explicitly allowed,
8144 // for the same reason as the component name.
8145 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8146 if (mPackage == null) {
8147 mSelector = new Intent(other.mSelector);
8148 mPackage = null;
8149 changes |= FILL_IN_SELECTOR;
8150 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008151 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008152 if (other.mClipData != null
8153 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8154 mClipData = other.mClipData;
8155 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008156 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008157 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008158 // Component is special: it can -only- be set if explicitly allowed,
8159 // since otherwise the sender could force the intent somewhere the
8160 // originator didn't intend.
8161 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008162 mComponent = other.mComponent;
8163 changes |= FILL_IN_COMPONENT;
8164 }
8165 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008166 if (other.mSourceBounds != null
8167 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8168 mSourceBounds = new Rect(other.mSourceBounds);
8169 changes |= FILL_IN_SOURCE_BOUNDS;
8170 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008171 if (mExtras == null) {
8172 if (other.mExtras != null) {
8173 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008174 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008175 }
8176 } else if (other.mExtras != null) {
8177 try {
8178 Bundle newb = new Bundle(other.mExtras);
8179 newb.putAll(mExtras);
8180 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008181 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008182 } catch (RuntimeException e) {
8183 // Modifying the extras can cause us to unparcel the contents
8184 // of the bundle, and if we do this in the system process that
8185 // may fail. We really should handle this (i.e., the Bundle
8186 // impl shouldn't be on top of a plain map), but for now just
8187 // ignore it and keep the original contents. :(
8188 Log.w("Intent", "Failure filling in extras", e);
8189 }
8190 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008191 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8192 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8193 mContentUserHint = other.mContentUserHint;
8194 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008195 return changes;
8196 }
8197
8198 /**
8199 * Wrapper class holding an Intent and implementing comparisons on it for
8200 * the purpose of filtering. The class implements its
8201 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8202 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8203 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8204 * on the wrapped Intent.
8205 */
8206 public static final class FilterComparison {
8207 private final Intent mIntent;
8208 private final int mHashCode;
8209
8210 public FilterComparison(Intent intent) {
8211 mIntent = intent;
8212 mHashCode = intent.filterHashCode();
8213 }
8214
8215 /**
8216 * Return the Intent that this FilterComparison represents.
8217 * @return Returns the Intent held by the FilterComparison. Do
8218 * not modify!
8219 */
8220 public Intent getIntent() {
8221 return mIntent;
8222 }
8223
8224 @Override
8225 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008226 if (obj instanceof FilterComparison) {
8227 Intent other = ((FilterComparison)obj).mIntent;
8228 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008229 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008230 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008231 }
8232
8233 @Override
8234 public int hashCode() {
8235 return mHashCode;
8236 }
8237 }
8238
8239 /**
8240 * Determine if two intents are the same for the purposes of intent
8241 * resolution (filtering). That is, if their action, data, type,
8242 * class, and categories are the same. This does <em>not</em> compare
8243 * any extra data included in the intents.
8244 *
8245 * @param other The other Intent to compare against.
8246 *
8247 * @return Returns true if action, data, type, class, and categories
8248 * are the same.
8249 */
8250 public boolean filterEquals(Intent other) {
8251 if (other == null) {
8252 return false;
8253 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008254 if (!Objects.equals(this.mAction, other.mAction)) return false;
8255 if (!Objects.equals(this.mData, other.mData)) return false;
8256 if (!Objects.equals(this.mType, other.mType)) return false;
8257 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8258 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8259 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008260
8261 return true;
8262 }
8263
8264 /**
8265 * Generate hash code that matches semantics of filterEquals().
8266 *
8267 * @return Returns the hash value of the action, data, type, class, and
8268 * categories.
8269 *
8270 * @see #filterEquals
8271 */
8272 public int filterHashCode() {
8273 int code = 0;
8274 if (mAction != null) {
8275 code += mAction.hashCode();
8276 }
8277 if (mData != null) {
8278 code += mData.hashCode();
8279 }
8280 if (mType != null) {
8281 code += mType.hashCode();
8282 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008283 if (mPackage != null) {
8284 code += mPackage.hashCode();
8285 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008286 if (mComponent != null) {
8287 code += mComponent.hashCode();
8288 }
8289 if (mCategories != null) {
8290 code += mCategories.hashCode();
8291 }
8292 return code;
8293 }
8294
8295 @Override
8296 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008297 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008298
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008299 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008300 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008301 b.append(" }");
8302
8303 return b.toString();
8304 }
8305
8306 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008307 public String toInsecureString() {
8308 StringBuilder b = new StringBuilder(128);
8309
8310 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008311 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008312 b.append(" }");
8313
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008314 return b.toString();
8315 }
Romain Guy4969af72009-06-17 10:53:19 -07008316
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008317 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008318 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008319 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008320
8321 b.append("Intent { ");
8322 toShortString(b, false, true, true, true);
8323 b.append(" }");
8324
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008325 return b.toString();
8326 }
8327
8328 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008329 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8330 StringBuilder b = new StringBuilder(128);
8331 toShortString(b, secure, comp, extras, clip);
8332 return b.toString();
8333 }
8334
8335 /** @hide */
8336 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8337 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008338 boolean first = true;
8339 if (mAction != null) {
8340 b.append("act=").append(mAction);
8341 first = false;
8342 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008343 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008344 if (!first) {
8345 b.append(' ');
8346 }
8347 first = false;
8348 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008349 for (int i=0; i<mCategories.size(); i++) {
8350 if (i > 0) b.append(',');
8351 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008352 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008353 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008354 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008355 if (mData != null) {
8356 if (!first) {
8357 b.append(' ');
8358 }
8359 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008360 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008361 if (secure) {
8362 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008363 } else {
8364 b.append(mData);
8365 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008366 }
8367 if (mType != null) {
8368 if (!first) {
8369 b.append(' ');
8370 }
8371 first = false;
8372 b.append("typ=").append(mType);
8373 }
8374 if (mFlags != 0) {
8375 if (!first) {
8376 b.append(' ');
8377 }
8378 first = false;
8379 b.append("flg=0x").append(Integer.toHexString(mFlags));
8380 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008381 if (mPackage != null) {
8382 if (!first) {
8383 b.append(' ');
8384 }
8385 first = false;
8386 b.append("pkg=").append(mPackage);
8387 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008388 if (comp && mComponent != null) {
8389 if (!first) {
8390 b.append(' ');
8391 }
8392 first = false;
8393 b.append("cmp=").append(mComponent.flattenToShortString());
8394 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008395 if (mSourceBounds != null) {
8396 if (!first) {
8397 b.append(' ');
8398 }
8399 first = false;
8400 b.append("bnds=").append(mSourceBounds.toShortString());
8401 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008402 if (mClipData != null) {
8403 if (!first) {
8404 b.append(' ');
8405 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008406 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008407 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008408 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008409 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008410 if (mClipData.getDescription() != null) {
8411 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8412 } else {
8413 first = true;
8414 }
8415 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008416 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008417 first = false;
8418 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008419 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008420 if (extras && mExtras != null) {
8421 if (!first) {
8422 b.append(' ');
8423 }
8424 first = false;
8425 b.append("(has extras)");
8426 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008427 if (mContentUserHint != UserHandle.USER_CURRENT) {
8428 if (!first) {
8429 b.append(' ');
8430 }
8431 first = false;
8432 b.append("u=").append(mContentUserHint);
8433 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008434 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008435 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008436 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008437 b.append("}");
8438 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008439 }
8440
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008441 /**
8442 * Call {@link #toUri} with 0 flags.
8443 * @deprecated Use {@link #toUri} instead.
8444 */
8445 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008446 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008447 return toUri(0);
8448 }
8449
8450 /**
8451 * Convert this Intent into a String holding a URI representation of it.
8452 * The returned URI string has been properly URI encoded, so it can be
8453 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8454 * Intent's data as the base URI, with an additional fragment describing
8455 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008456 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008457 * <p>You can convert the returned string back to an Intent with
8458 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008459 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008460 * @param flags Additional operating flags. Either 0,
8461 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008462 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008463 * @return Returns a URI encoding URI string describing the entire contents
8464 * of the Intent.
8465 */
8466 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008467 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008468 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8469 if (mPackage == null) {
8470 throw new IllegalArgumentException(
8471 "Intent must include an explicit package name to build an android-app: "
8472 + this);
8473 }
8474 uri.append("android-app://");
8475 uri.append(mPackage);
8476 String scheme = null;
8477 if (mData != null) {
8478 scheme = mData.getScheme();
8479 if (scheme != null) {
8480 uri.append('/');
8481 uri.append(scheme);
8482 String authority = mData.getEncodedAuthority();
8483 if (authority != null) {
8484 uri.append('/');
8485 uri.append(authority);
8486 String path = mData.getEncodedPath();
8487 if (path != null) {
8488 uri.append(path);
8489 }
8490 String queryParams = mData.getEncodedQuery();
8491 if (queryParams != null) {
8492 uri.append('?');
8493 uri.append(queryParams);
8494 }
8495 String fragment = mData.getEncodedFragment();
8496 if (fragment != null) {
8497 uri.append('#');
8498 uri.append(fragment);
8499 }
8500 }
8501 }
8502 }
8503 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8504 mPackage, flags);
8505 return uri.toString();
8506 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008507 String scheme = null;
8508 if (mData != null) {
8509 String data = mData.toString();
8510 if ((flags&URI_INTENT_SCHEME) != 0) {
8511 final int N = data.length();
8512 for (int i=0; i<N; i++) {
8513 char c = data.charAt(i);
8514 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8515 || c == '.' || c == '-') {
8516 continue;
8517 }
8518 if (c == ':' && i > 0) {
8519 // Valid scheme.
8520 scheme = data.substring(0, i);
8521 uri.append("intent:");
8522 data = data.substring(i+1);
8523 break;
8524 }
Tom Taylord4a47292009-12-21 13:59:18 -08008525
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008526 // No scheme.
8527 break;
8528 }
8529 }
8530 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008531
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008532 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8533 uri.append("intent:");
8534 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008535
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008536 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008537
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008538 return uri.toString();
8539 }
8540
8541 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8542 String defPackage, int flags) {
8543 StringBuilder frag = new StringBuilder(128);
8544
8545 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008546 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008547 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008548 // Note that for now we are not going to try to handle the
8549 // data part; not clear how to represent this as a URI, and
8550 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008551 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8552 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008553 }
8554
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008555 if (frag.length() > 0) {
8556 uri.append("#Intent;");
8557 uri.append(frag);
8558 uri.append("end");
8559 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008560 }
8561
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008562 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8563 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008564 if (scheme != null) {
8565 uri.append("scheme=").append(scheme).append(';');
8566 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008567 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008568 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008569 }
8570 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008571 for (int i=0; i<mCategories.size(); i++) {
8572 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008573 }
8574 }
8575 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008576 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008577 }
8578 if (mFlags != 0) {
8579 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8580 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008581 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008582 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8583 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008584 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008585 uri.append("component=").append(Uri.encode(
8586 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008587 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008588 if (mSourceBounds != null) {
8589 uri.append("sourceBounds=")
8590 .append(Uri.encode(mSourceBounds.flattenToString()))
8591 .append(';');
8592 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008593 if (mExtras != null) {
8594 for (String key : mExtras.keySet()) {
8595 final Object value = mExtras.get(key);
8596 char entryType =
8597 value instanceof String ? 'S' :
8598 value instanceof Boolean ? 'B' :
8599 value instanceof Byte ? 'b' :
8600 value instanceof Character ? 'c' :
8601 value instanceof Double ? 'd' :
8602 value instanceof Float ? 'f' :
8603 value instanceof Integer ? 'i' :
8604 value instanceof Long ? 'l' :
8605 value instanceof Short ? 's' :
8606 '\0';
8607
8608 if (entryType != '\0') {
8609 uri.append(entryType);
8610 uri.append('.');
8611 uri.append(Uri.encode(key));
8612 uri.append('=');
8613 uri.append(Uri.encode(value.toString()));
8614 uri.append(';');
8615 }
8616 }
8617 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008618 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008619
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008620 public int describeContents() {
8621 return (mExtras != null) ? mExtras.describeContents() : 0;
8622 }
8623
8624 public void writeToParcel(Parcel out, int flags) {
8625 out.writeString(mAction);
8626 Uri.writeToParcel(out, mData);
8627 out.writeString(mType);
8628 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008629 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008630 ComponentName.writeToParcel(mComponent, out);
8631
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008632 if (mSourceBounds != null) {
8633 out.writeInt(1);
8634 mSourceBounds.writeToParcel(out, flags);
8635 } else {
8636 out.writeInt(0);
8637 }
8638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008639 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008640 final int N = mCategories.size();
8641 out.writeInt(N);
8642 for (int i=0; i<N; i++) {
8643 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008644 }
8645 } else {
8646 out.writeInt(0);
8647 }
8648
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008649 if (mSelector != null) {
8650 out.writeInt(1);
8651 mSelector.writeToParcel(out, flags);
8652 } else {
8653 out.writeInt(0);
8654 }
8655
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008656 if (mClipData != null) {
8657 out.writeInt(1);
8658 mClipData.writeToParcel(out, flags);
8659 } else {
8660 out.writeInt(0);
8661 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008662 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008663 out.writeBundle(mExtras);
8664 }
8665
8666 public static final Parcelable.Creator<Intent> CREATOR
8667 = new Parcelable.Creator<Intent>() {
8668 public Intent createFromParcel(Parcel in) {
8669 return new Intent(in);
8670 }
8671 public Intent[] newArray(int size) {
8672 return new Intent[size];
8673 }
8674 };
8675
Dianne Hackborneb034652009-09-07 00:49:58 -07008676 /** @hide */
8677 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008678 readFromParcel(in);
8679 }
8680
8681 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008682 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008683 mData = Uri.CREATOR.createFromParcel(in);
8684 mType = in.readString();
8685 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008686 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008687 mComponent = ComponentName.readFromParcel(in);
8688
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008689 if (in.readInt() != 0) {
8690 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8691 }
8692
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008693 int N = in.readInt();
8694 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008695 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008696 int i;
8697 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008698 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008699 }
8700 } else {
8701 mCategories = null;
8702 }
8703
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008704 if (in.readInt() != 0) {
8705 mSelector = new Intent(in);
8706 }
8707
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008708 if (in.readInt() != 0) {
8709 mClipData = new ClipData(in);
8710 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008711 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008712 mExtras = in.readBundle();
8713 }
8714
8715 /**
8716 * Parses the "intent" element (and its children) from XML and instantiates
8717 * an Intent object. The given XML parser should be located at the tag
8718 * where parsing should start (often named "intent"), from which the
8719 * basic action, data, type, and package and class name will be
8720 * retrieved. The function will then parse in to any child elements,
8721 * looking for <category android:name="xxx"> tags to add categories and
8722 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8723 * to the intent.
8724 *
8725 * @param resources The Resources to use when inflating resources.
8726 * @param parser The XML parser pointing at an "intent" tag.
8727 * @param attrs The AttributeSet interface for retrieving extended
8728 * attribute data at the current <var>parser</var> location.
8729 * @return An Intent object matching the XML data.
8730 * @throws XmlPullParserException If there was an XML parsing error.
8731 * @throws IOException If there was an I/O error.
8732 */
8733 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8734 throws XmlPullParserException, IOException {
8735 Intent intent = new Intent();
8736
8737 TypedArray sa = resources.obtainAttributes(attrs,
8738 com.android.internal.R.styleable.Intent);
8739
8740 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8741
8742 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8743 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8744 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8745
8746 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8747 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8748 if (packageName != null && className != null) {
8749 intent.setComponent(new ComponentName(packageName, className));
8750 }
8751
8752 sa.recycle();
8753
8754 int outerDepth = parser.getDepth();
8755 int type;
8756 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8757 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8758 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8759 continue;
8760 }
8761
8762 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008763 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008764 sa = resources.obtainAttributes(attrs,
8765 com.android.internal.R.styleable.IntentCategory);
8766 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8767 sa.recycle();
8768
8769 if (cat != null) {
8770 intent.addCategory(cat);
8771 }
8772 XmlUtils.skipCurrentTag(parser);
8773
Craig Mautner21d24a22014-04-23 11:45:37 -07008774 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008775 if (intent.mExtras == null) {
8776 intent.mExtras = new Bundle();
8777 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008778 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008779 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008780
8781 } else {
8782 XmlUtils.skipCurrentTag(parser);
8783 }
8784 }
8785
8786 return intent;
8787 }
Nick Pellyccae4122012-01-09 14:12:58 -08008788
Craig Mautner21d24a22014-04-23 11:45:37 -07008789 /** @hide */
8790 public void saveToXml(XmlSerializer out) throws IOException {
8791 if (mAction != null) {
8792 out.attribute(null, ATTR_ACTION, mAction);
8793 }
8794 if (mData != null) {
8795 out.attribute(null, ATTR_DATA, mData.toString());
8796 }
8797 if (mType != null) {
8798 out.attribute(null, ATTR_TYPE, mType);
8799 }
8800 if (mComponent != null) {
8801 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8802 }
8803 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8804
8805 if (mCategories != null) {
8806 out.startTag(null, TAG_CATEGORIES);
8807 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8808 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8809 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008810 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008811 }
8812 }
8813
8814 /** @hide */
8815 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8816 XmlPullParserException {
8817 Intent intent = new Intent();
8818 final int outerDepth = in.getDepth();
8819
8820 int attrCount = in.getAttributeCount();
8821 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8822 final String attrName = in.getAttributeName(attrNdx);
8823 final String attrValue = in.getAttributeValue(attrNdx);
8824 if (ATTR_ACTION.equals(attrName)) {
8825 intent.setAction(attrValue);
8826 } else if (ATTR_DATA.equals(attrName)) {
8827 intent.setData(Uri.parse(attrValue));
8828 } else if (ATTR_TYPE.equals(attrName)) {
8829 intent.setType(attrValue);
8830 } else if (ATTR_COMPONENT.equals(attrName)) {
8831 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8832 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008833 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008834 } else {
8835 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8836 }
8837 }
8838
8839 int event;
8840 String name;
8841 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8842 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8843 if (event == XmlPullParser.START_TAG) {
8844 name = in.getName();
8845 if (TAG_CATEGORIES.equals(name)) {
8846 attrCount = in.getAttributeCount();
8847 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8848 intent.addCategory(in.getAttributeValue(attrNdx));
8849 }
8850 } else {
8851 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8852 XmlUtils.skipCurrentTag(in);
8853 }
8854 }
8855 }
8856
8857 return intent;
8858 }
8859
Nick Pellyccae4122012-01-09 14:12:58 -08008860 /**
8861 * Normalize a MIME data type.
8862 *
8863 * <p>A normalized MIME type has white-space trimmed,
8864 * content-type parameters removed, and is lower-case.
8865 * This aligns the type with Android best practices for
8866 * intent filtering.
8867 *
8868 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8869 * "text/x-vCard" becomes "text/x-vcard".
8870 *
8871 * <p>All MIME types received from outside Android (such as user input,
8872 * or external sources like Bluetooth, NFC, or the Internet) should
8873 * be normalized before they are used to create an Intent.
8874 *
8875 * @param type MIME data type to normalize
8876 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008877 * @see #setType
8878 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008879 */
8880 public static String normalizeMimeType(String type) {
8881 if (type == null) {
8882 return null;
8883 }
8884
Elliott Hughescb64d432013-08-02 10:00:44 -07008885 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008886
8887 final int semicolonIndex = type.indexOf(';');
8888 if (semicolonIndex != -1) {
8889 type = type.substring(0, semicolonIndex);
8890 }
8891 return type;
8892 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008893
8894 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008895 * Prepare this {@link Intent} to leave an app process.
8896 *
8897 * @hide
8898 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008899 public void prepareToLeaveProcess(Context context) {
8900 final boolean leavingPackage = (mComponent == null)
8901 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8902 prepareToLeaveProcess(leavingPackage);
8903 }
8904
8905 /**
8906 * Prepare this {@link Intent} to leave an app process.
8907 *
8908 * @hide
8909 */
8910 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008911 setAllowFds(false);
8912
8913 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008914 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008915 }
8916 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008917 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008918 }
8919
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008920 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8921 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008922 switch (mAction) {
8923 case ACTION_MEDIA_REMOVED:
8924 case ACTION_MEDIA_UNMOUNTED:
8925 case ACTION_MEDIA_CHECKING:
8926 case ACTION_MEDIA_NOFS:
8927 case ACTION_MEDIA_MOUNTED:
8928 case ACTION_MEDIA_SHARED:
8929 case ACTION_MEDIA_UNSHARED:
8930 case ACTION_MEDIA_BAD_REMOVAL:
8931 case ACTION_MEDIA_UNMOUNTABLE:
8932 case ACTION_MEDIA_EJECT:
8933 case ACTION_MEDIA_SCANNER_STARTED:
8934 case ACTION_MEDIA_SCANNER_FINISHED:
8935 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008936 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8937 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008938 // Ignore legacy actions
8939 break;
8940 default:
8941 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008942 }
8943 }
8944 }
8945
8946 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008947 * @hide
8948 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008949 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008950 // We just entered destination process, so we should be able to read all
8951 // parcelables inside.
8952 setDefusable(true);
8953
8954 if (mSelector != null) {
8955 mSelector.prepareToEnterProcess();
8956 }
8957 if (mClipData != null) {
8958 mClipData.prepareToEnterProcess();
8959 }
8960
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008961 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008962 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8963 fixUris(mContentUserHint);
8964 mContentUserHint = UserHandle.USER_CURRENT;
8965 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008966 }
8967 }
8968
8969 /**
8970 * @hide
8971 */
8972 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008973 Uri data = getData();
8974 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008975 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008976 }
8977 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008978 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008979 }
8980 String action = getAction();
8981 if (ACTION_SEND.equals(action)) {
8982 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8983 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008984 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008985 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008986 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008987 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8988 if (streams != null) {
8989 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8990 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008991 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008992 }
8993 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8994 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008995 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8996 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8997 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8998 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8999 if (output != null) {
9000 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9001 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009002 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009003 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009004
9005 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009006 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009007 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9008 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009009 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009010 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009011 * @hide
9012 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009013 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009014 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009015 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009016
9017 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009018 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009019
9020 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009021 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009022 // Inspect contained intents to see if we need to migrate extras. We
9023 // don't promote ClipData to the parent, since ChooserActivity will
9024 // already start the picked item as the caller, and we can't combine
9025 // the flags in a safe way.
9026
9027 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009028 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009029 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9030 if (intent != null) {
9031 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009032 }
9033 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009034 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009035 try {
9036 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9037 if (intents != null) {
9038 for (int i = 0; i < intents.length; i++) {
9039 final Intent intent = (Intent) intents[i];
9040 if (intent != null) {
9041 migrated |= intent.migrateExtraStreamToClipData();
9042 }
9043 }
9044 }
9045 } catch (ClassCastException e) {
9046 }
9047 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009048
9049 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009050 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009051 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9052 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9053 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9054 if (stream != null || text != null || htmlText != null) {
9055 final ClipData clipData = new ClipData(
9056 null, new String[] { getType() },
9057 new ClipData.Item(text, htmlText, null, stream));
9058 setClipData(clipData);
9059 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009060 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009061 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009062 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009063 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009064
9065 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009066 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009067 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9068 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9069 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9070 int num = -1;
9071 if (streams != null) {
9072 num = streams.size();
9073 }
9074 if (texts != null) {
9075 if (num >= 0 && num != texts.size()) {
9076 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009077 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009078 }
9079 num = texts.size();
9080 }
9081 if (htmlTexts != null) {
9082 if (num >= 0 && num != htmlTexts.size()) {
9083 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009084 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009085 }
9086 num = htmlTexts.size();
9087 }
9088 if (num > 0) {
9089 final ClipData clipData = new ClipData(
9090 null, new String[] { getType() },
9091 makeClipItem(streams, texts, htmlTexts, 0));
9092
9093 for (int i = 1; i < num; i++) {
9094 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9095 }
9096
9097 setClipData(clipData);
9098 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009099 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009100 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009101 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009102 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009103 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9104 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9105 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9106 final Uri output;
9107 try {
9108 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9109 } catch (ClassCastException e) {
9110 return false;
9111 }
9112 if (output != null) {
9113 setClipData(ClipData.newRawUri("", output));
9114 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9115 return true;
9116 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009117 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009118
9119 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009120 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009121
9122 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9123 ArrayList<String> htmlTexts, int which) {
9124 Uri uri = streams != null ? streams.get(which) : null;
9125 CharSequence text = texts != null ? texts.get(which) : null;
9126 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9127 return new ClipData.Item(text, htmlText, null, uri);
9128 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009129
9130 /** @hide */
9131 public boolean isDocument() {
9132 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9133 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009134}