blob: 47abd2bea87fd0f0a6b4adbd5ec1ccffffee012f [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 */
1484 @SystemApi
1485 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1486 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1487 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1488
1489 /**
1490 * Service Action: Resolve ephemeral application.
1491 * <p>
1492 * The system will have a persistent connection to this service.
1493 * This is a protected intent that can only be sent by the system.
1494 * </p>
1495 *
1496 * @hide
1497 */
1498 @SystemApi
1499 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1500 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1501 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1502
1503 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001504 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1505 * package. Specifies the installer package name; this package will receive the
1506 * {@link #ACTION_APP_ERROR} intent.
1507 */
1508 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1509 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1510
1511 /**
1512 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1513 * package. Specifies that the application being installed should not be
1514 * treated as coming from an unknown source, but as coming from the app
1515 * invoking the Intent. For this to work you must start the installer with
1516 * startActivityForResult().
1517 */
1518 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1519 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1520
1521 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001522 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1523 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001524 * data field originated from.
1525 */
rich cannings706e8ba2012-08-20 13:20:14 -07001526 public static final String EXTRA_ORIGINATING_URI
1527 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001528
1529 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001530 * This extra can be used with any Intent used to launch an activity, supplying information
1531 * about who is launching that activity. This field contains a {@link android.net.Uri}
1532 * object, typically an http: or https: URI of the web site that the referral came from;
1533 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1534 * a native application that it came from.
1535 *
1536 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1537 * instead of directly retrieving the extra. It is also valid for applications to
1538 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1539 * a string, not a Uri; the field here, if supplied, will always take precedence,
1540 * however.</p>
1541 *
1542 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001543 */
1544 public static final String EXTRA_REFERRER
1545 = "android.intent.extra.REFERRER";
1546
1547 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001548 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1549 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1550 * not be created, in particular when Intent extras are supplied through the
1551 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1552 * schemes.
1553 *
1554 * @see #EXTRA_REFERRER
1555 */
1556 public static final String EXTRA_REFERRER_NAME
1557 = "android.intent.extra.REFERRER_NAME";
1558
1559 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001560 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1561 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1562 * @hide
1563 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001564 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001565 public static final String EXTRA_ORIGINATING_UID
1566 = "android.intent.extra.ORIGINATING_UID";
1567
1568 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001569 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1570 * package. Tells the installer UI to skip the confirmation with the user
1571 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001572 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1573 * will no longer show an interstitial message about updating existing
1574 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001575 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001576 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001577 public static final String EXTRA_ALLOW_REPLACE
1578 = "android.intent.extra.ALLOW_REPLACE";
1579
1580 /**
1581 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1582 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1583 * return to the application the result code of the install/uninstall. The returned result
1584 * code will be {@link android.app.Activity#RESULT_OK} on success or
1585 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1586 */
1587 public static final String EXTRA_RETURN_RESULT
1588 = "android.intent.extra.RETURN_RESULT";
1589
1590 /**
1591 * Package manager install result code. @hide because result codes are not
1592 * yet ready to be exposed.
1593 */
1594 public static final String EXTRA_INSTALL_RESULT
1595 = "android.intent.extra.INSTALL_RESULT";
1596
1597 /**
1598 * Activity Action: Launch application uninstaller.
1599 * <p>
1600 * Input: The data must be a package: URI whose scheme specific part is
1601 * the package name of the current installed package to be uninstalled.
1602 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1603 * <p>
1604 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1605 * succeeded.
1606 */
1607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1608 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1609
1610 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001611 * Specify whether the package should be uninstalled for all users.
1612 * @hide because these should not be part of normal application flow.
1613 */
1614 public static final String EXTRA_UNINSTALL_ALL_USERS
1615 = "android.intent.extra.UNINSTALL_ALL_USERS";
1616
1617 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001618 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1619 * describing the last run version of the platform that was setup.
1620 * @hide
1621 */
1622 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1623
Svet Ganov3695b8a2015-03-24 16:30:25 -07001624 /**
1625 * Activity action: Launch UI to manage the permissions of an app.
1626 * <p>
1627 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1628 * will be managed by the launched UI.
1629 * </p>
1630 * <p>
1631 * Output: Nothing.
1632 * </p>
1633 *
1634 * @see #EXTRA_PACKAGE_NAME
1635 *
1636 * @hide
1637 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001638 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1640 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1641 "android.intent.action.MANAGE_APP_PERMISSIONS";
1642
1643 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001644 * Activity action: Launch UI to manage permissions.
1645 * <p>
1646 * Input: Nothing.
1647 * </p>
1648 * <p>
1649 * Output: Nothing.
1650 * </p>
1651 *
1652 * @hide
1653 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001654 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1656 public static final String ACTION_MANAGE_PERMISSIONS =
1657 "android.intent.action.MANAGE_PERMISSIONS";
1658
1659 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001660 * Activity action: Launch UI to review permissions for an app.
1661 * The system uses this intent if permission review for apps not
1662 * supporting the new runtime permissions model is enabled. In
1663 * this mode a permission review is required before any of the
1664 * app components can run.
1665 * <p>
1666 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1667 * permissions will be reviewed (mandatory).
1668 * </p>
1669 * <p>
1670 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1671 * be fired after the permission review (optional).
1672 * </p>
1673 * <p>
1674 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1675 * be invoked after the permission review (optional).
1676 * </p>
1677 * <p>
1678 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1679 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1680 * </p>
1681 * <p>
1682 * Output: Nothing.
1683 * </p>
1684 *
1685 * @see #EXTRA_PACKAGE_NAME
1686 * @see #EXTRA_INTENT
1687 * @see #EXTRA_REMOTE_CALLBACK
1688 * @see #EXTRA_RESULT_NEEDED
1689 *
1690 * @hide
1691 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001692 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001693 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1694 public static final String ACTION_REVIEW_PERMISSIONS =
1695 "android.intent.action.REVIEW_PERMISSIONS";
1696
1697 /**
1698 * Intent extra: A callback for reporting remote result as a bundle.
1699 * <p>
1700 * Type: IRemoteCallback
1701 * </p>
1702 *
1703 * @hide
1704 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001705 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001706 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1707
1708 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001709 * Intent extra: An app package name.
1710 * <p>
1711 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001712 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001713 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001714 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001715 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1716
1717 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001718 * Intent extra: An extra for specifying whether a result is needed.
1719 * <p>
1720 * Type: boolean
1721 * </p>
1722 *
1723 * @hide
1724 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001725 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001726 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1727
1728 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001729 * Activity action: Launch UI to manage which apps have a given permission.
1730 * <p>
1731 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1732 * to which will be managed by the launched UI.
1733 * </p>
1734 * <p>
1735 * Output: Nothing.
1736 * </p>
1737 *
1738 * @see #EXTRA_PERMISSION_NAME
1739 *
1740 * @hide
1741 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001742 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001743 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1744 public static final String ACTION_MANAGE_PERMISSION_APPS =
1745 "android.intent.action.MANAGE_PERMISSION_APPS";
1746
1747 /**
1748 * Intent extra: The name of a permission.
1749 * <p>
1750 * Type: String
1751 * </p>
1752 *
1753 * @hide
1754 */
1755 @SystemApi
1756 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1757
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001758 // ---------------------------------------------------------------------
1759 // ---------------------------------------------------------------------
1760 // Standard intent broadcast actions (see action variable).
1761
1762 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001763 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1764 * <p>
1765 * For historical reasons, the name of this broadcast action refers to the power
1766 * state of the screen but it is actually sent in response to changes in the
1767 * overall interactive state of the device.
1768 * </p><p>
1769 * This broadcast is sent when the device becomes non-interactive which may have
1770 * nothing to do with the screen turning off. To determine the
1771 * actual state of the screen, use {@link android.view.Display#getState}.
1772 * </p><p>
1773 * See {@link android.os.PowerManager#isInteractive} for details.
1774 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001775 * You <em>cannot</em> receive this through components declared in
1776 * manifests, only by explicitly registering for it with
1777 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1778 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001779 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001780 * <p class="note">This is a protected intent that can only be sent
1781 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001782 */
1783 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1784 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001785
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001786 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001787 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1788 * <p>
1789 * For historical reasons, the name of this broadcast action refers to the power
1790 * state of the screen but it is actually sent in response to changes in the
1791 * overall interactive state of the device.
1792 * </p><p>
1793 * This broadcast is sent when the device becomes interactive which may have
1794 * nothing to do with the screen turning on. To determine the
1795 * actual state of the screen, use {@link android.view.Display#getState}.
1796 * </p><p>
1797 * See {@link android.os.PowerManager#isInteractive} for details.
1798 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001799 * You <em>cannot</em> receive this through components declared in
1800 * manifests, only by explicitly registering for it with
1801 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1802 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001803 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001804 * <p class="note">This is a protected intent that can only be sent
1805 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001806 */
1807 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1808 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001809
1810 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001811 * Broadcast Action: Sent after the system stops dreaming.
1812 *
1813 * <p class="note">This is a protected intent that can only be sent by the system.
1814 * It is only sent to registered receivers.</p>
1815 */
1816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1817 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1818
1819 /**
1820 * Broadcast Action: Sent after the system starts dreaming.
1821 *
1822 * <p class="note">This is a protected intent that can only be sent by the system.
1823 * It is only sent to registered receivers.</p>
1824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1827
1828 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001829 * 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 -07001830 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001831 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001832 * <p class="note">This is a protected intent that can only be sent
1833 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001834 */
1835 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001836 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001837
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001838 /**
1839 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001840 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001841 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001842 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1843 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001844 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001845 * <p class="note">This is a protected intent that can only be sent
1846 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001847 */
1848 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1849 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1850 /**
1851 * Broadcast Action: The time was set.
1852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1855 /**
1856 * Broadcast Action: The date has changed.
1857 */
1858 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1859 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1860 /**
1861 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1862 * <ul>
1863 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1864 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001865 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001866 * <p class="note">This is a protected intent that can only be sent
1867 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001868 */
1869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1870 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1871 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001872 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1873 * DNS entries should be tossed.
1874 * @hide
1875 */
1876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1877 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1878 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001879 * Alarm Changed Action: This is broadcast when the AlarmClock
1880 * application's alarm is set or unset. It is used by the
1881 * AlarmClock application and the StatusBar service.
1882 * @hide
1883 */
1884 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1885 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001886
1887 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001888 * Broadcast Action: This is broadcast once, after the user has finished
1889 * booting, but while still in the "locked" state. It can be used to perform
1890 * application-specific initialization, such as installing alarms. You must
1891 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1892 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001893 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001894 * This broadcast is sent immediately at boot by all devices (regardless of
1895 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1896 * higher. Upon receipt of this broadcast, the user is still locked and only
1897 * device-protected storage can be accessed safely. If you want to access
1898 * credential-protected storage, you need to wait for the user to be
1899 * unlocked (typically by entering their lock pattern or PIN for the first
1900 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1901 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1902 * <p>
1903 * To receive this broadcast, your receiver component must be marked as
1904 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001905 * <p class="note">
1906 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001907 *
1908 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001909 */
1910 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1911 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1912
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001913 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001914 * Broadcast Action: This is broadcast once, after the user has finished
1915 * booting. It can be used to perform application-specific initialization,
1916 * such as installing alarms. You must hold the
1917 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1918 * order to receive this broadcast.
1919 * <p>
1920 * This broadcast is sent at boot by all devices (both with and without
1921 * direct boot support). Upon receipt of this broadcast, the user is
1922 * unlocked and both device-protected and credential-protected storage can
1923 * accessed safely.
1924 * <p>
1925 * If you need to run while the user is still locked (before they've entered
1926 * their lock pattern or PIN for the first time), you can listen for the
1927 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1928 * <p class="note">
1929 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 */
1931 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1932 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001933
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001934 /**
1935 * Broadcast Action: This is broadcast when a user action should request a
1936 * temporary system dialog to dismiss. Some examples of temporary system
1937 * dialogs are the notification window-shade and the recent tasks dialog.
1938 */
1939 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1940 /**
1941 * Broadcast Action: Trigger the download and eventual installation
1942 * of a package.
1943 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001944 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001945 * <p class="note">This is a protected intent that can only be sent
1946 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001947 *
1948 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001949 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001950 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001951 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1952 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1953 /**
1954 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001955 * device. The data contains the name of the package. Note that the
1956 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001957 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001958 * <ul>
1959 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1960 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1961 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1962 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001963 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001964 * <p class="note">This is a protected intent that can only be sent
1965 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 */
1967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1968 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1969 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001970 * Broadcast Action: A new version of an application package has been
1971 * installed, replacing an existing version that was previously installed.
1972 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001973 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001974 * <ul>
1975 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1976 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001977 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001978 * <p class="note">This is a protected intent that can only be sent
1979 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1983 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001984 * Broadcast Action: A new version of your application has been installed
1985 * over an existing one. This is only sent to the application that was
1986 * replaced. It does not contain any additional data; to receive it, just
1987 * use an intent filter for this action.
1988 *
1989 * <p class="note">This is a protected intent that can only be sent
1990 * by the system.
1991 */
1992 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1993 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1994 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001995 * Broadcast Action: An existing application package has been removed from
1996 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07001997 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001998 * <ul>
1999 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2000 * to the package.
2001 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2002 * application -- data and code -- is being removed.
2003 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2004 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2005 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002006 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002007 * <p class="note">This is a protected intent that can only be sent
2008 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2012 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002013 * Broadcast Action: An existing application package has been completely
2014 * removed from the device. The data contains the name of the package.
2015 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2016 * {@link #EXTRA_DATA_REMOVED} is true and
2017 * {@link #EXTRA_REPLACING} is false of that broadcast.
2018 *
2019 * <ul>
2020 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2021 * to the package.
2022 * </ul>
2023 *
2024 * <p class="note">This is a protected intent that can only be sent
2025 * by the system.
2026 */
2027 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2028 public static final String ACTION_PACKAGE_FULLY_REMOVED
2029 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2030 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002031 * Broadcast Action: An existing application package has been changed (for
2032 * example, a component has been enabled or disabled). The data contains
2033 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002034 * <ul>
2035 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002036 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002037 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002038 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2039 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002040 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002041 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002042 * <p class="note">This is a protected intent that can only be sent
2043 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2047 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002048 * @hide
2049 * Broadcast Action: Ask system services if there is any reason to
2050 * restart the given package. The data contains the name of the
2051 * package.
2052 * <ul>
2053 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2054 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2055 * </ul>
2056 *
2057 * <p class="note">This is a protected intent that can only be sent
2058 * by the system.
2059 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002060 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2063 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002064 * Broadcast Action: The user has restarted a package, and all of its
2065 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002066 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002067 * be removed. Note that the restarted package does <em>not</em>
2068 * receive this broadcast.
2069 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002070 * <ul>
2071 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2072 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002073 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002074 * <p class="note">This is a protected intent that can only be sent
2075 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2079 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002080 * Broadcast Action: The user has cleared the data of a package. This should
2081 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002082 * its persistent data is erased and this broadcast sent.
2083 * Note that the cleared package does <em>not</em>
2084 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002085 * <ul>
2086 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2087 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002088 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002089 * <p class="note">This is a protected intent that can only be sent
2090 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2094 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002095 * Broadcast Action: Packages have been suspended.
2096 * <p>Includes the following extras:
2097 * <ul>
2098 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2099 * </ul>
2100 *
2101 * <p class="note">This is a protected intent that can only be sent
2102 * by the system. It is only sent to registered receivers.
2103 */
2104 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2105 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2106 /**
2107 * Broadcast Action: Packages have been unsuspended.
2108 * <p>Includes the following extras:
2109 * <ul>
2110 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2111 * </ul>
2112 *
2113 * <p class="note">This is a protected intent that can only be sent
2114 * by the system. It is only sent to registered receivers.
2115 */
2116 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2117 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2118 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002119 * Broadcast Action: A user ID has been removed from the system. The user
2120 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002121 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002122 * <p class="note">This is a protected intent that can only be sent
2123 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002124 */
2125 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2126 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002127
2128 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002129 * Broadcast Action: Sent to the installer package of an application when
2130 * that application is first launched (that is the first time it is moved
2131 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002132 *
2133 * <p class="note">This is a protected intent that can only be sent
2134 * by the system.
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2138
2139 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002140 * Broadcast Action: Sent to the system package verifier when a package
2141 * needs to be verified. The data contains the package URI.
2142 * <p class="note">
2143 * This is a protected intent that can only be sent by the system.
2144 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002145 */
2146 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2147 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2148
2149 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002150 * Broadcast Action: Sent to the system package verifier when a package is
2151 * verified. The data contains the package URI.
2152 * <p class="note">
2153 * This is a protected intent that can only be sent by the system.
2154 */
2155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2156 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2157
2158 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002159 * Broadcast Action: Sent to the system intent filter verifier when an
2160 * intent filter needs to be verified. The data contains the filter data
2161 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002162 * <p class="note">
2163 * This is a protected intent that can only be sent by the system.
2164 * </p>
2165 *
2166 * @hide
2167 */
2168 @SystemApi
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2170 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2171
2172 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002173 * Broadcast Action: Resources for a set of packages (which were
2174 * previously unavailable) are currently
2175 * available since the media on which they exist is available.
2176 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2177 * list of packages whose availability changed.
2178 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2179 * list of uids of packages whose availability changed.
2180 * Note that the
2181 * packages in this list do <em>not</em> receive this broadcast.
2182 * The specified set of packages are now available on the system.
2183 * <p>Includes the following extras:
2184 * <ul>
2185 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2186 * whose resources(were previously unavailable) are currently available.
2187 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2188 * packages whose resources(were previously unavailable)
2189 * are currently available.
2190 * </ul>
2191 *
2192 * <p class="note">This is a protected intent that can only be sent
2193 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002194 */
2195 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002196 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2197 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002198
2199 /**
2200 * Broadcast Action: Resources for a set of packages are currently
2201 * unavailable since the media on which they exist is unavailable.
2202 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2203 * list of packages whose availability changed.
2204 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2205 * list of uids of packages whose availability changed.
2206 * The specified set of packages can no longer be
2207 * launched and are practically unavailable on the system.
2208 * <p>Inclues the following extras:
2209 * <ul>
2210 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2211 * whose resources are no longer available.
2212 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2213 * whose resources are no longer available.
2214 * </ul>
2215 *
2216 * <p class="note">This is a protected intent that can only be sent
2217 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002220 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002221 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002222
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002223 /**
2224 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002225 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002226 * This should <em>only</em> be used to determine when the wallpaper
2227 * has changed to show the new wallpaper to the user. You should certainly
2228 * never, in response to this, change the wallpaper or other attributes of
2229 * it such as the suggested size. That would be crazy, right? You'd cause
2230 * all kinds of loops, especially if other apps are doing similar things,
2231 * right? Of course. So please don't do this.
2232 *
2233 * @deprecated Modern applications should use
2234 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2235 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2236 * shown behind their UI, rather than watching for this broadcast and
2237 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002238 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002239 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002240 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2241 /**
2242 * Broadcast Action: The current device {@link android.content.res.Configuration}
2243 * (orientation, locale, etc) has changed. When such a change happens, the
2244 * UIs (view hierarchy) will need to be rebuilt based on this new
2245 * information; for the most part, applications don't need to worry about
2246 * this, because the system will take care of stopping and restarting the
2247 * application to make sure it sees the new changes. Some system code that
2248 * can not be restarted will need to watch for this action and handle it
2249 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002250 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002251 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002252 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002253 * in manifests, only by explicitly registering for it with
2254 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2255 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002256 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002257 * <p class="note">This is a protected intent that can only be sent
2258 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002259 *
2260 * @see android.content.res.Configuration
2261 */
2262 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2263 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2264 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002265 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002266 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002267 * <p class="note">This is a protected intent that can only be sent
2268 * by the system.
2269 */
2270 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2271 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2272 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002273 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2274 * charging state, level, and other information about the battery.
2275 * See {@link android.os.BatteryManager} for documentation on the
2276 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002277 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002278 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002279 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002280 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002281 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002282 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2283 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2284 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2285 * broadcasts that are sent and can be received through manifest
2286 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002287 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002288 * <p class="note">This is a protected intent that can only be sent
2289 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 */
2291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2292 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2293 /**
2294 * Broadcast Action: Indicates low battery condition on the device.
2295 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002296 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002297 * <p class="note">This is a protected intent that can only be sent
2298 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002299 */
2300 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2301 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2302 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002303 * Broadcast Action: Indicates the battery is now okay after being low.
2304 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2305 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002306 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002307 * <p class="note">This is a protected intent that can only be sent
2308 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002309 */
2310 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2311 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2312 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002313 * Broadcast Action: External power has been connected to the device.
2314 * This is intended for applications that wish to register specifically to this notification.
2315 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2316 * stay active to receive this notification. This action can be used to implement actions
2317 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002318 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002319 * <p class="note">This is a protected intent that can only be sent
2320 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002321 */
2322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002323 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002324 /**
2325 * Broadcast Action: External power has been removed from the device.
2326 * This is intended for applications that wish to register specifically to this notification.
2327 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2328 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002329 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002330 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002335 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002336 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002337 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002338 * Broadcast Action: Device is shutting down.
2339 * This is broadcast when the device is being shut down (completely turned
2340 * off, not sleeping). Once the broadcast is complete, the final shutdown
2341 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002342 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002343 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002344 * <p class="note">This is a protected intent that can only be sent
2345 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002346 * <p>May include the following extras:
2347 * <ul>
2348 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2349 * shutdown is only for userspace processes. If not set, assumed to be false.
2350 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002351 */
2352 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002353 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002354 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002355 * Activity Action: Start this activity to request system shutdown.
2356 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002357 * to request confirmation from the user before shutting down. The optional boolean
2358 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2359 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002360 *
2361 * <p class="note">This is a protected intent that can only be sent
2362 * by the system.
2363 *
2364 * {@hide}
2365 */
2366 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2367 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002368 * Broadcast Action: A sticky broadcast that indicates low memory
2369 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002370 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002371 * <p class="note">This is a protected intent that can only be sent
2372 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002373 */
2374 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2375 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2376 /**
2377 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002378 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002379 * <p class="note">This is a protected intent that can only be sent
2380 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002381 */
2382 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2383 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2384 /**
Jake Hambybb371632010-08-23 18:16:48 -07002385 * Broadcast Action: A sticky broadcast that indicates a memory full
2386 * condition on the device. This is intended for activities that want
2387 * to be able to fill the data partition completely, leaving only
2388 * enough free space to prevent system-wide SQLite failures.
2389 *
2390 * <p class="note">This is a protected intent that can only be sent
2391 * by the system.
2392 *
2393 * {@hide}
2394 */
2395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2396 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2397 /**
2398 * Broadcast Action: Indicates memory full condition on the device
2399 * no longer exists.
2400 *
2401 * <p class="note">This is a protected intent that can only be sent
2402 * by the system.
2403 *
2404 * {@hide}
2405 */
2406 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2407 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2408 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002409 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2410 * and package management should be started.
2411 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2412 * notification.
2413 */
2414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2415 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2416 /**
2417 * Broadcast Action: The device has entered USB Mass Storage mode.
2418 * This is used mainly for the USB Settings panel.
2419 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2420 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002421 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002422 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002423 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002424 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2425
2426 /**
2427 * Broadcast Action: The device has exited USB Mass Storage mode.
2428 * This is used mainly for the USB Settings panel.
2429 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2430 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002431 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002432 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002433 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002434 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2435
2436 /**
2437 * Broadcast Action: External media has been removed.
2438 * The path to the mount point for the removed media is contained in the Intent.mData field.
2439 */
2440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2441 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2442
2443 /**
2444 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002445 * 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 -07002446 */
2447 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2448 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2449
2450 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002451 * Broadcast Action: External media is present, and being disk-checked
2452 * 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 -08002453 */
2454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2455 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2456
2457 /**
2458 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2459 * 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 -08002460 */
2461 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2462 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2463
2464 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002465 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002466 * 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 -07002467 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2468 * media was mounted read only.
2469 */
2470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2471 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2472
2473 /**
2474 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002475 * 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 -07002476 */
2477 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2478 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2479
2480 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002481 * Broadcast Action: External media is no longer being shared via USB mass storage.
2482 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2483 *
2484 * @hide
2485 */
2486 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2487
2488 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002489 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2490 * The path to the mount point for the removed media is contained in the Intent.mData field.
2491 */
2492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2493 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2494
2495 /**
2496 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002497 * 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 -07002498 */
2499 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2500 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2501
2502 /**
2503 * Broadcast Action: User has expressed the desire to remove the external storage media.
2504 * Applications should close all files they have open within the mount point when they receive this intent.
2505 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2506 */
2507 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2508 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2509
2510 /**
2511 * Broadcast Action: The media scanner has started scanning a directory.
2512 * The path to the directory being scanned is contained in the Intent.mData field.
2513 */
2514 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2515 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2516
2517 /**
2518 * Broadcast Action: The media scanner has finished scanning a directory.
2519 * The path to the scanned directory is contained in the Intent.mData field.
2520 */
2521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2522 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2523
2524 /**
2525 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2526 * The path to the file is contained in the Intent.mData field.
2527 */
2528 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2529 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2530
2531 /**
2532 * Broadcast Action: The "Media Button" was pressed. Includes a single
2533 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2534 * caused the broadcast.
2535 */
2536 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2537 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2538
2539 /**
2540 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2541 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2542 * caused the broadcast.
2543 */
2544 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2545 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2546
2547 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2548 // location; they are not general-purpose actions.
2549
2550 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002551 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002552 */
2553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2554 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2555 "android.intent.action.GTALK_CONNECTED";
2556
2557 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002558 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002559 */
2560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2561 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2562 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002563
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002564 /**
2565 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_INPUT_METHOD_CHANGED =
2569 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002570
2571 /**
2572 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2573 * more radios have been turned off or on. The intent will have the following extra value:</p>
2574 * <ul>
2575 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2576 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2577 * turned off</li>
2578 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002579 *
Peng Xua35b5532016-01-20 00:05:45 -08002580 * <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 -07002581 */
2582 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2583 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2584
2585 /**
2586 * Broadcast Action: Some content providers have parts of their namespace
2587 * where they publish new events or items that the user may be especially
2588 * interested in. For these things, they may broadcast this action when the
2589 * set of interesting items change.
2590 *
2591 * For example, GmailProvider sends this notification when the set of unread
2592 * mail in the inbox changes.
2593 *
2594 * <p>The data of the intent identifies which part of which provider
2595 * changed. When queried through the content resolver, the data URI will
2596 * return the data set in question.
2597 *
2598 * <p>The intent will have the following extra values:
2599 * <ul>
2600 * <li><em>count</em> - The number of items in the data set. This is the
2601 * same as the number of items in the cursor returned by querying the
2602 * data URI. </li>
2603 * </ul>
2604 *
2605 * This intent will be sent at boot (if the count is non-zero) and when the
2606 * data set changes. It is possible for the data set to change without the
2607 * count changing (for example, if a new unread message arrives in the same
2608 * sync operation in which a message is archived). The phone should still
2609 * ring/vibrate/etc as normal in this case.
2610 */
2611 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2612 public static final String ACTION_PROVIDER_CHANGED =
2613 "android.intent.action.PROVIDER_CHANGED";
2614
2615 /**
2616 * Broadcast Action: Wired Headset plugged in or unplugged.
2617 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002618 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2619 * and documentation.
2620 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002621 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002622 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002623 */
2624 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002625 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002626
2627 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002628 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2629 * <ul>
2630 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2631 * </ul>
2632 *
2633 * <p class="note">This is a protected intent that can only be sent
2634 * by the system.
2635 *
2636 * @hide
2637 */
2638 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2639 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2640 = "android.intent.action.ADVANCED_SETTINGS";
2641
2642 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002643 * Broadcast Action: Sent after application restrictions are changed.
2644 *
2645 * <p class="note">This is a protected intent that can only be sent
2646 * by the system.</p>
2647 */
2648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2649 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2650 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2651
2652 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 * Broadcast Action: An outgoing call is about to be placed.
2654 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002655 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002656 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002657 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002658 * the phone number originally intended to be dialed.</li>
2659 * </ul>
2660 * <p>Once the broadcast is finished, the resultData is used as the actual
2661 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002662 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002663 * outgoing call in turn: for example, a parental control application
2664 * might verify that the user is authorized to place the call at that
2665 * time, then a number-rewriting application might add an area code if
2666 * one was not specified.</p>
2667 * <p>For consistency, any receiver whose purpose is to prohibit phone
2668 * calls should have a priority of 0, to ensure it will see the final
2669 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002670 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002671 * should have a positive priority.
2672 * Negative priorities are reserved for the system for this broadcast;
2673 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002674 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2675 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002676 * <p>Emergency calls cannot be intercepted using this mechanism, and
2677 * other calls cannot be modified to call emergency numbers using this
2678 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002679 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2680 * call to use their own service instead. Those apps should first prevent
2681 * the call from being placed by setting resultData to <code>null</code>
2682 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002683 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002684 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2685 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002686 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002687 * <p class="note">This is a protected intent that can only be sent
2688 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002689 */
2690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2691 public static final String ACTION_NEW_OUTGOING_CALL =
2692 "android.intent.action.NEW_OUTGOING_CALL";
2693
2694 /**
2695 * Broadcast Action: Have the device reboot. This is only for use by
2696 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002697 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002698 * <p class="note">This is a protected intent that can only be sent
2699 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002700 */
2701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2702 public static final String ACTION_REBOOT =
2703 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002704
Wei Huang97ecc9c2009-05-11 17:44:20 -07002705 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002706 * Broadcast Action: A sticky broadcast for changes in the physical
2707 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002708 *
2709 * <p>The intent will have the following extra values:
2710 * <ul>
2711 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002712 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002713 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002714 * <p>This is intended for monitoring the current physical dock state.
2715 * See {@link android.app.UiModeManager} for the normal API dealing with
2716 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002717 */
2718 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2719 public static final String ACTION_DOCK_EVENT =
2720 "android.intent.action.DOCK_EVENT";
2721
2722 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002723 * Broadcast Action: A broadcast when idle maintenance can be started.
2724 * This means that the user is not interacting with the device and is
2725 * not expected to do so soon. Typical use of the idle maintenance is
2726 * to perform somehow expensive tasks that can be postponed at a moment
2727 * when they will not degrade user experience.
2728 * <p>
2729 * <p class="note">In order to keep the device responsive in case of an
2730 * unexpected user interaction, implementations of a maintenance task
2731 * should be interruptible. In such a scenario a broadcast with action
2732 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2733 * should not do the maintenance work in
2734 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2735 * maintenance service by {@link Context#startService(Intent)}. Also
2736 * you should hold a wake lock while your maintenance service is running
2737 * to prevent the device going to sleep.
2738 * </p>
2739 * <p>
2740 * <p class="note">This is a protected intent that can only be sent by
2741 * the system.
2742 * </p>
2743 *
2744 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002745 *
2746 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002747 */
2748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2749 public static final String ACTION_IDLE_MAINTENANCE_START =
2750 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2751
2752 /**
2753 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2754 * This means that the user was not interacting with the device as a result
2755 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2756 * was sent and now the user started interacting with the device. Typical
2757 * use of the idle maintenance is to perform somehow expensive tasks that
2758 * can be postponed at a moment when they will not degrade user experience.
2759 * <p>
2760 * <p class="note">In order to keep the device responsive in case of an
2761 * unexpected user interaction, implementations of a maintenance task
2762 * should be interruptible. Hence, on receiving a broadcast with this
2763 * action, the maintenance task should be interrupted as soon as possible.
2764 * In other words, you should not do the maintenance work in
2765 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2766 * maintenance service that was started on receiving of
2767 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2768 * lock you acquired when your maintenance service started.
2769 * </p>
2770 * <p class="note">This is a protected intent that can only be sent
2771 * by the system.
2772 *
2773 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002774 *
2775 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002776 */
2777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2778 public static final String ACTION_IDLE_MAINTENANCE_END =
2779 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2780
2781 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002782 * Broadcast Action: a remote intent is to be broadcasted.
2783 *
2784 * A remote intent is used for remote RPC between devices. The remote intent
2785 * is serialized and sent from one device to another device. The receiving
2786 * device parses the remote intent and broadcasts it. Note that anyone can
2787 * broadcast a remote intent. However, if the intent receiver of the remote intent
2788 * does not trust intent broadcasts from arbitrary intent senders, it should require
2789 * the sender to hold certain permissions so only trusted sender's broadcast will be
2790 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002791 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002792 */
2793 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002794 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002795
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002796 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002797 * Broadcast Action: This is broadcast once when the user is booting after a
2798 * system update. It can be used to perform cleanup or upgrades after a
2799 * system update.
2800 * <p>
2801 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2802 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2803 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2804 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002805 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002806 * @hide
2807 */
2808 public static final String ACTION_PRE_BOOT_COMPLETED =
2809 "android.intent.action.PRE_BOOT_COMPLETED";
2810
Amith Yamasani13593602012-03-22 16:16:17 -07002811 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002812 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002813 * on restricted users. The broadcast intent contains an extra
2814 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2815 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2816 * String[] depending on the restriction type.<p/>
2817 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002818 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2819 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2820 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002821 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2822 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002823 * @see RestrictionEntry
2824 */
2825 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2826 "android.intent.action.GET_RESTRICTION_ENTRIES";
2827
2828 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002829 * Sent the first time a user is starting, to allow system apps to
2830 * perform one time initialization. (This will not be seen by third
2831 * party applications because a newly initialized user does not have any
2832 * third party applications installed for it.) This is sent early in
2833 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002834 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2835 * broadcast, since it is part of a visible user interaction; be as quick
2836 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002837 */
2838 public static final String ACTION_USER_INITIALIZE =
2839 "android.intent.action.USER_INITIALIZE";
2840
2841 /**
2842 * Sent when a user switch is happening, causing the process's user to be
2843 * brought to the foreground. This is only sent to receivers registered
2844 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2845 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002846 * foreground. This is sent as a foreground
2847 * broadcast, since it is part of a visible user interaction; be as quick
2848 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002849 */
2850 public static final String ACTION_USER_FOREGROUND =
2851 "android.intent.action.USER_FOREGROUND";
2852
2853 /**
2854 * Sent when a user switch is happening, causing the process's user to be
2855 * sent to the background. This is only sent to receivers registered
2856 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2857 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002858 * background. This is sent as a foreground
2859 * broadcast, since it is part of a visible user interaction; be as quick
2860 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002861 */
2862 public static final String ACTION_USER_BACKGROUND =
2863 "android.intent.action.USER_BACKGROUND";
2864
2865 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002866 * Broadcast sent to the system when a user is added. Carries an extra
2867 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2868 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002869 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002870 * @hide
2871 */
2872 public static final String ACTION_USER_ADDED =
2873 "android.intent.action.USER_ADDED";
2874
2875 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002876 * Broadcast sent by the system when a user is started. Carries an extra
2877 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002878 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002879 * that has been started. This is sent as a foreground
2880 * broadcast, since it is part of a visible user interaction; be as quick
2881 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002882 * @hide
2883 */
2884 public static final String ACTION_USER_STARTED =
2885 "android.intent.action.USER_STARTED";
2886
2887 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002888 * Broadcast sent when a user is in the process of starting. Carries an extra
2889 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2890 * sent to registered receivers, not manifest receivers. It is sent to all
2891 * users (including the one that is being started). You must hold
2892 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2893 * this broadcast. This is sent as a background broadcast, since
2894 * its result is not part of the primary UX flow; to safely keep track of
2895 * started/stopped state of a user you can use this in conjunction with
2896 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2897 * other user state broadcasts since those are foreground broadcasts so can
2898 * execute in a different order.
2899 * @hide
2900 */
2901 public static final String ACTION_USER_STARTING =
2902 "android.intent.action.USER_STARTING";
2903
2904 /**
2905 * Broadcast sent when a user is going to be stopped. Carries an extra
2906 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2907 * sent to registered receivers, not manifest receivers. It is sent to all
2908 * users (including the one that is being stopped). You must hold
2909 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2910 * this broadcast. The user will not stop until all receivers have
2911 * handled the broadcast. This is sent as a background broadcast, since
2912 * its result is not part of the primary UX flow; to safely keep track of
2913 * started/stopped state of a user you can use this in conjunction with
2914 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2915 * other user state broadcasts since those are foreground broadcasts so can
2916 * execute in a different order.
2917 * @hide
2918 */
2919 public static final String ACTION_USER_STOPPING =
2920 "android.intent.action.USER_STOPPING";
2921
2922 /**
2923 * Broadcast sent to the system when a user is stopped. Carries an extra
2924 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2925 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2926 * specific package. This is only sent to registered receivers, not manifest
2927 * receivers. It is sent to all running users <em>except</em> the one that
2928 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002929 * @hide
2930 */
2931 public static final String ACTION_USER_STOPPED =
2932 "android.intent.action.USER_STOPPED";
2933
2934 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002935 * 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 -07002936 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002937 * one that has been removed. The user will not be completely removed until all receivers have
2938 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002939 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002940 * @hide
2941 */
2942 public static final String ACTION_USER_REMOVED =
2943 "android.intent.action.USER_REMOVED";
2944
2945 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002946 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002947 * the userHandle of the user to become the current one. This is only sent to
2948 * registered receivers, not manifest receivers. It is sent to all running users.
2949 * You must hold
2950 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002951 * @hide
2952 */
2953 public static final String ACTION_USER_SWITCHED =
2954 "android.intent.action.USER_SWITCHED";
2955
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002956 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002957 * Broadcast Action: Sent when the credential-encrypted private storage has
2958 * become unlocked for the target user. This is only sent to registered
2959 * receivers, not manifest receivers.
2960 */
2961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2962 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2963
2964 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002965 * Broadcast sent to the system when a user's information changes. Carries an extra
2966 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002967 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002968 * @hide
2969 */
2970 public static final String ACTION_USER_INFO_CHANGED =
2971 "android.intent.action.USER_INFO_CHANGED";
2972
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002973 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002974 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2975 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002976 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2977 * that need to display merged content across both primary and managed profiles need to
2978 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002979 * not manifest receivers.
2980 */
2981 public static final String ACTION_MANAGED_PROFILE_ADDED =
2982 "android.intent.action.MANAGED_PROFILE_ADDED";
2983
2984 /**
2985 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002986 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2987 * Only applications (for example Launchers) that need to display merged content across both
2988 * primary and managed profiles need to worry about this broadcast. This is only sent to
2989 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002990 */
2991 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2992 "android.intent.action.MANAGED_PROFILE_REMOVED";
2993
2994 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00002995 * Broadcast sent to the primary user when the credential-encrypted private storage for
2996 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
2997 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
2998 * Launchers) that need to display merged content across both primary and managed profiles
2999 * need to worry about this broadcast. This is only sent to registered receivers,
3000 * not manifest receivers.
3001 */
3002 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3003 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3004
3005 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003006 * Broadcast sent to the primary user when an associated managed profile has become available.
3007 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003008 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3009 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3010 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003011 */
Rubin Xue95057a2016-04-01 16:49:25 +01003012 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3013 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3014
3015 /**
3016 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3017 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3018 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3019 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3020 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3021 */
3022 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3023 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003024
3025 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003026 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3027 */
3028 public static final String ACTION_QUICK_CLOCK =
3029 "android.intent.action.QUICK_CLOCK";
3030
Michael Wright0087a142013-02-05 16:29:39 -08003031 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003032 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003033 * @hide
3034 */
3035 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3036 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3037
Justin Kohd378ad72013-04-01 12:18:26 -07003038 /**
3039 * Broadcast Action: A global button was pressed. Includes a single
3040 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3041 * caused the broadcast.
3042 * @hide
3043 */
3044 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3045
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003046 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003047 * Broadcast Action: Sent when media resource is granted.
3048 * <p>
3049 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3050 * granted.
3051 * </p>
3052 * <p class="note">
3053 * This is a protected intent that can only be sent by the system.
3054 * </p>
3055 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003056 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003057 * </p>
3058 *
3059 * @hide
3060 */
3061 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3062 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3063
3064 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003065 * Activity Action: Allow the user to select and return one or more existing
3066 * documents. When invoked, the system will display the various
3067 * {@link DocumentsProvider} instances installed on the device, letting the
3068 * user interactively navigate through them. These documents include local
3069 * media, such as photos and video, and documents provided by installed
3070 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003071 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003072 * Each document is represented as a {@code content://} URI backed by a
3073 * {@link DocumentsProvider}, which can be opened as a stream with
3074 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3075 * {@link android.provider.DocumentsContract.Document} metadata.
3076 * <p>
3077 * All selected documents are returned to the calling application with
3078 * persistable read and write permission grants. If you want to maintain
3079 * access to the documents across device reboots, you need to explicitly
3080 * take the persistable permissions using
3081 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3082 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003083 * Callers must indicate the acceptable document MIME types through
3084 * {@link #setType(String)}. For example, to select photos, use
3085 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3086 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3087 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003088 * <p>
3089 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003090 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3091 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003092 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003093 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3094 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003095 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003096 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003097 * Output: The URI of the item that was picked, returned in
3098 * {@link #getData()}. This must be a {@code content://} URI so that any
3099 * receiver can access it. If multiple documents were selected, they are
3100 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003101 *
3102 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003103 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003104 * @see #ACTION_CREATE_DOCUMENT
3105 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003106 */
3107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3108 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3109
3110 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003111 * Activity Action: Allow the user to create a new document. When invoked,
3112 * the system will display the various {@link DocumentsProvider} instances
3113 * installed on the device, letting the user navigate through them. The
3114 * returned document may be a newly created document with no content, or it
3115 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003116 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003117 * Each document is represented as a {@code content://} URI backed by a
3118 * {@link DocumentsProvider}, which can be opened as a stream with
3119 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3120 * {@link android.provider.DocumentsContract.Document} metadata.
3121 * <p>
3122 * Callers must indicate the concrete MIME type of the document being
3123 * created by setting {@link #setType(String)}. This MIME type cannot be
3124 * changed after the document is created.
3125 * <p>
3126 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3127 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003128 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003129 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3130 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003131 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003132 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003133 * Output: The URI of the item that was created. This must be a
3134 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003135 *
3136 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003137 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003138 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003139 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003140 */
3141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3142 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3143
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003144 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003145 * Activity Action: Allow the user to pick a directory subtree. When
3146 * invoked, the system will display the various {@link DocumentsProvider}
3147 * instances installed on the device, letting the user navigate through
3148 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003149 * <p>
3150 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003151 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3152 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3153 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003154 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003155 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003156 *
3157 * @see DocumentsContract
3158 */
3159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003160 public static final String
3161 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003162
Felipe Lemec7b1f892016-01-15 15:02:31 -08003163 /**
Peng Xua35b5532016-01-20 00:05:45 -08003164 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3165 * exisiting sensor being disconnected.
3166 *
3167 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3168 *
3169 * {@hide}
3170 */
3171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3172 public static final String
3173 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3174
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003175 /** {@hide} */
3176 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3177
Christopher Tate6597e342015-02-17 12:15:25 -08003178 /**
3179 * Broadcast action: report that a settings element is being restored from backup. The intent
3180 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3181 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3182 * is the value of that settings entry prior to the restore operation. All of these values are
3183 * represented as strings.
3184 *
3185 * <p>This broadcast is sent only for settings provider entries known to require special handling
3186 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3187 * the provider's backup agent implementation.
3188 *
3189 * @see #EXTRA_SETTING_NAME
3190 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3191 * @see #EXTRA_SETTING_NEW_VALUE
3192 * {@hide}
3193 */
3194 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3195
3196 /** {@hide} */
3197 public static final String EXTRA_SETTING_NAME = "setting_name";
3198 /** {@hide} */
3199 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3200 /** {@hide} */
3201 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3202
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003203 /**
3204 * Activity Action: Process a piece of text.
3205 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3206 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3207 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3208 */
3209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3210 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3211 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003212 * The name of the extra used to define the text to be processed, as a
3213 * CharSequence. Note that this may be a styled CharSequence, so you must use
3214 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003215 */
3216 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3217 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003218 * 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 +00003219 */
3220 public static final String EXTRA_PROCESS_TEXT_READONLY =
3221 "android.intent.extra.PROCESS_TEXT_READONLY";
3222
Bryce Leebc58f592015-09-25 16:43:01 -07003223 /**
3224 * Broadcast action: reports when a new thermal event has been reached. When the device
3225 * is reaching its maximum temperatue, the thermal level reported
3226 * {@hide}
3227 */
3228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3229 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3230
3231 /** {@hide} */
3232 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3233
3234 /**
3235 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003236 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003237 * {@hide}
3238 */
3239 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3240
3241 /**
3242 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003243 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003244 * {@hide}
3245 */
3246 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3247
3248 /**
3249 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003250 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003251 * {@hide}
3252 */
3253 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3254
3255
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003256 // ---------------------------------------------------------------------
3257 // ---------------------------------------------------------------------
3258 // Standard intent categories (see addCategory()).
3259
3260 /**
3261 * Set if the activity should be an option for the default action
3262 * (center press) to perform on a piece of data. Setting this will
3263 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003264 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003265 * Intent when initiating an action -- it is for use in intent filters
3266 * specified in packages.
3267 */
3268 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3269 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3270 /**
3271 * Activities that can be safely invoked from a browser must support this
3272 * category. For example, if the user is viewing a web page or an e-mail
3273 * and clicks on a link in the text, the Intent generated execute that
3274 * link will require the BROWSABLE category, so that only activities
3275 * supporting this category will be considered as possible actions. By
3276 * supporting this category, you are promising that there is nothing
3277 * damaging (without user intervention) that can happen by invoking any
3278 * matching Intent.
3279 */
3280 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3281 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3282 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003283 * Categories for activities that can participate in voice interaction.
3284 * An activity that supports this category must be prepared to run with
3285 * no UI shown at all (though in some case it may have a UI shown), and
3286 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3287 */
3288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3289 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3290 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003291 * Set if the activity should be considered as an alternative action to
3292 * the data the user is currently viewing. See also
3293 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3294 * applies to the selection in a list of items.
3295 *
3296 * <p>Supporting this category means that you would like your activity to be
3297 * displayed in the set of alternative things the user can do, usually as
3298 * part of the current activity's options menu. You will usually want to
3299 * include a specific label in the &lt;intent-filter&gt; of this action
3300 * describing to the user what it does.
3301 *
3302 * <p>The action of IntentFilter with this category is important in that it
3303 * describes the specific action the target will perform. This generally
3304 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3305 * a specific name such as "com.android.camera.action.CROP. Only one
3306 * alternative of any particular action will be shown to the user, so using
3307 * a specific action like this makes sure that your alternative will be
3308 * displayed while also allowing other applications to provide their own
3309 * overrides of that particular action.
3310 */
3311 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3312 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3313 /**
3314 * Set if the activity should be considered as an alternative selection
3315 * action to the data the user has currently selected. This is like
3316 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3317 * of items from which the user can select, giving them alternatives to the
3318 * default action that will be performed on it.
3319 */
3320 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3321 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3322 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003323 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003324 */
3325 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3326 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3327 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003328 * Should be displayed in the top-level launcher.
3329 */
3330 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3331 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3332 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003333 * Indicates an activity optimized for Leanback mode, and that should
3334 * be displayed in the Leanback launcher.
3335 */
3336 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3337 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3338 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003339 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3340 * @hide
3341 */
3342 @SystemApi
3343 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3344 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003345 * Provides information about the package it is in; typically used if
3346 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3347 * a front-door to the user without having to be shown in the all apps list.
3348 */
3349 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3350 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3351 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003352 * This is the home activity, that is the first activity that is displayed
3353 * when the device boots.
3354 */
3355 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3356 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3357 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003358 * This is the home activity that is displayed when the device is finished setting up and ready
3359 * for use.
3360 * @hide
3361 */
3362 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3363 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3364 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003365 * This is the setup wizard activity, that is the first activity that is displayed
3366 * when the user sets up the device for the first time.
3367 * @hide
3368 */
3369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3370 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3371 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003372 * This activity is a preference panel.
3373 */
3374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3375 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3376 /**
3377 * This activity is a development preference panel.
3378 */
3379 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3380 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3381 /**
3382 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003383 */
3384 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3385 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3386 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003387 * This activity allows the user to browse and download new applications.
3388 */
3389 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3390 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3391 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003392 * This activity may be exercised by the monkey or other automated test tools.
3393 */
3394 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3395 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3396 /**
3397 * To be used as a test (not part of the normal user experience).
3398 */
3399 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3400 /**
3401 * To be used as a unit test (run through the Test Harness).
3402 */
3403 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3404 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003405 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003406 * experience).
3407 */
3408 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003409
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003410 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003411 * Used to indicate that an intent only wants URIs that can be opened with
3412 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3413 * must support at least the columns defined in {@link OpenableColumns} when
3414 * queried.
3415 *
3416 * @see #ACTION_GET_CONTENT
3417 * @see #ACTION_OPEN_DOCUMENT
3418 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003419 */
3420 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3421 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3422
3423 /**
3424 * To be used as code under test for framework instrumentation tests.
3425 */
3426 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3427 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003428 /**
3429 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003430 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3431 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003432 */
3433 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3434 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3435 /**
3436 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003437 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3438 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003439 */
3440 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3441 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003442 /**
3443 * An activity to run when device is inserted into a analog (low end) dock.
3444 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3445 * information, see {@link android.app.UiModeManager}.
3446 */
3447 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3448 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3449
3450 /**
3451 * An activity to run when device is inserted into a digital (high end) dock.
3452 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3453 * information, see {@link android.app.UiModeManager}.
3454 */
3455 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3456 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003457
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003458 /**
3459 * Used to indicate that the activity can be used in a car environment.
3460 */
3461 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3462 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3463
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003464 // ---------------------------------------------------------------------
3465 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003466 // Application launch intent categories (see addCategory()).
3467
3468 /**
3469 * Used with {@link #ACTION_MAIN} to launch the browser application.
3470 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003471 * <p>NOTE: This should not be used as the primary key of an Intent,
3472 * since it will not result in the app launching with the correct
3473 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003474 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003475 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003476 */
3477 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3478 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3479
3480 /**
3481 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3482 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003483 * <p>NOTE: This should not be used as the primary key of an Intent,
3484 * since it will not result in the app launching with the correct
3485 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003486 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003487 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003488 */
3489 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3490 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3491
3492 /**
3493 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3494 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003495 * <p>NOTE: This should not be used as the primary key of an Intent,
3496 * since it will not result in the app launching with the correct
3497 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003498 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003499 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003500 */
3501 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3502 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3503
3504 /**
3505 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3506 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003507 * <p>NOTE: This should not be used as the primary key of an Intent,
3508 * since it will not result in the app launching with the correct
3509 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003510 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003511 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003512 */
3513 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3514 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3515
3516 /**
3517 * Used with {@link #ACTION_MAIN} to launch the email application.
3518 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003519 * <p>NOTE: This should not be used as the primary key of an Intent,
3520 * since it will not result in the app launching with the correct
3521 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003522 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003523 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003524 */
3525 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3526 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3527
3528 /**
3529 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3530 * The activity should be able to view and manipulate image and video files
3531 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003532 * <p>NOTE: This should not be used as the primary key of an Intent,
3533 * since it will not result in the app launching with the correct
3534 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003535 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003536 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003537 */
3538 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3539 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3540
3541 /**
3542 * Used with {@link #ACTION_MAIN} to launch the maps application.
3543 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003544 * <p>NOTE: This should not be used as the primary key of an Intent,
3545 * since it will not result in the app launching with the correct
3546 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003547 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003548 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003549 */
3550 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3551 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3552
3553 /**
3554 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3555 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003556 * <p>NOTE: This should not be used as the primary key of an Intent,
3557 * since it will not result in the app launching with the correct
3558 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003559 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003560 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003561 */
3562 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3563 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3564
3565 /**
3566 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003567 * The activity should be able to play, browse, or manipulate music files
3568 * stored on the device.
3569 * <p>NOTE: This should not be used as the primary key of an Intent,
3570 * since it will not result in the app launching with the correct
3571 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003572 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003573 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003574 */
3575 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3576 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3577
3578 // ---------------------------------------------------------------------
3579 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003580 // Standard extra data keys.
3581
3582 /**
3583 * The initial data to place in a newly created record. Use with
3584 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3585 * fields as would be given to the underlying ContentProvider.insert()
3586 * call.
3587 */
3588 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3589
3590 /**
3591 * A constant CharSequence that is associated with the Intent, used with
3592 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3593 * this may be a styled CharSequence, so you must use
3594 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3595 * retrieve it.
3596 */
3597 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3598
3599 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003600 * A constant String that is associated with the Intent, used with
3601 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3602 * as HTML formatted text. Note that you <em>must</em> also supply
3603 * {@link #EXTRA_TEXT}.
3604 */
3605 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3606
3607 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003608 * A content: URI holding a stream of data associated with the Intent,
3609 * used with {@link #ACTION_SEND} to supply the data being sent.
3610 */
3611 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3612
3613 /**
3614 * A String[] holding e-mail addresses that should be delivered to.
3615 */
3616 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3617
3618 /**
3619 * A String[] holding e-mail addresses that should be carbon copied.
3620 */
3621 public static final String EXTRA_CC = "android.intent.extra.CC";
3622
3623 /**
3624 * A String[] holding e-mail addresses that should be blind carbon copied.
3625 */
3626 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3627
3628 /**
3629 * A constant string holding the desired subject line of a message.
3630 */
3631 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3632
3633 /**
3634 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003635 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003636 */
3637 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3638
3639 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003640 * An int representing the user id to be used.
3641 *
3642 * @hide
3643 */
3644 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3645
3646 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003647 * An int representing the task id to be retrieved. This is used when a launch from recents is
3648 * intercepted by another action such as credentials confirmation to remember which task should
3649 * be resumed when complete.
3650 *
3651 * @hide
3652 */
3653 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3654
3655 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003656 * An Intent[] describing additional, alternate choices you would like shown with
3657 * {@link #ACTION_CHOOSER}.
3658 *
3659 * <p>An app may be capable of providing several different payload types to complete a
3660 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3661 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3662 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3663 * photo data or a hosted link where the photos can be viewed.</p>
3664 *
3665 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3666 * first/primary/preferred intent in the set. Additional intents specified in
3667 * this extra are ordered; by default intents that appear earlier in the array will be
3668 * preferred over intents that appear later in the array as matches for the same
3669 * target component. To alter this preference, a calling app may also supply
3670 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3671 */
3672 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3673
3674 /**
Adam Powell52c39212016-04-07 15:14:18 -07003675 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3676 * and omitted from a list of components presented to the user.
3677 *
3678 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3679 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3680 * from your own package or other apps from your organization if the idea of sending to those
3681 * targets would be redundant with other app functionality. Filtered components will not
3682 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3683 */
3684 public static final String EXTRA_EXCLUDE_COMPONENTS
3685 = "android.intent.extra.EXCLUDE_COMPONENTS";
3686
3687 /**
3688 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3689 * describing additional high-priority deep-link targets for the chooser to present to the user.
3690 *
3691 * <p>Targets provided in this way will be presented inline with all other targets provided
3692 * by services from other apps. They will be prioritized before other service targets, but
3693 * after those targets provided by sources that the user has manually pinned to the front.</p>
3694 *
3695 * @see #ACTION_CHOOSER
3696 */
3697 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3698
3699 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003700 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3701 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3702 *
3703 * <p>An app preparing an action for another app to complete may wish to allow the user to
3704 * disambiguate between several options for completing the action based on the chosen target
3705 * or otherwise refine the action before it is invoked.
3706 * </p>
3707 *
3708 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3709 * <ul>
3710 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3711 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3712 * chosen target beyond the first</li>
3713 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3714 * should fill in and send once the disambiguation is complete</li>
3715 * </ul>
3716 */
3717 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3718 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3719
3720 /**
3721 * A {@link ResultReceiver} used to return data back to the sender.
3722 *
3723 * <p>Used to complete an app-specific
3724 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3725 *
3726 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3727 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3728 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3729 * when the user selects a target component from the chooser. It is up to the recipient
3730 * to send a result to this ResultReceiver to signal that disambiguation is complete
3731 * and that the chooser should invoke the user's choice.</p>
3732 *
3733 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3734 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3735 * to match and fill in the final Intent or ChooserTarget before starting it.
3736 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3737 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3738 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3739 *
3740 * <p>The result code passed to the ResultReceiver should be
3741 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3742 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3743 * the chooser should finish without starting a target.</p>
3744 */
3745 public static final String EXTRA_RESULT_RECEIVER
3746 = "android.intent.extra.RESULT_RECEIVER";
3747
3748 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003749 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003750 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003751 */
3752 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3753
3754 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003755 * A Parcelable[] of {@link Intent} or
3756 * {@link android.content.pm.LabeledIntent} objects as set with
3757 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3758 * a the front of the list of choices, when shown to the user with a
3759 * {@link #ACTION_CHOOSER}.
3760 */
3761 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3762
3763 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003764 * A {@link IntentSender} to start after ephemeral installation success.
3765 * @hide
3766 */
3767 @SystemApi
3768 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3769
3770 /**
3771 * A {@link IntentSender} to start after ephemeral installation failure.
3772 * @hide
3773 */
3774 @SystemApi
3775 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3776
3777 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003778 * A Bundle forming a mapping of potential target package names to different extras Bundles
3779 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3780 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3781 * be currently installed on the device.
3782 *
3783 * <p>An application may choose to provide alternate extras for the case where a user
3784 * selects an activity from a predetermined set of target packages. If the activity
3785 * the user selects from the chooser belongs to a package with its package name as
3786 * a key in this bundle, the corresponding extras for that package will be merged with
3787 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3788 * extra has the same key as an extra already present in the intent it will overwrite
3789 * the extra from the intent.</p>
3790 *
3791 * <p><em>Examples:</em>
3792 * <ul>
3793 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3794 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3795 * parameters for that target.</li>
3796 * <li>An application may offer additional metadata for known targets of a given intent
3797 * to pass along information only relevant to that target such as account or content
3798 * identifiers already known to that application.</li>
3799 * </ul></p>
3800 */
3801 public static final String EXTRA_REPLACEMENT_EXTRAS =
3802 "android.intent.extra.REPLACEMENT_EXTRAS";
3803
3804 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003805 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3806 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3807 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3808 * {@link ComponentName} of the chosen component.
3809 *
3810 * <p>In some situations this callback may never come, for example if the user abandons
3811 * the chooser, switches to another task or any number of other reasons. Apps should not
3812 * be written assuming that this callback will always occur.</p>
3813 */
3814 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3815 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3816
3817 /**
3818 * The {@link ComponentName} chosen by the user to complete an action.
3819 *
3820 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3821 */
3822 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3823
3824 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 * A {@link android.view.KeyEvent} object containing the event that
3826 * triggered the creation of the Intent it is in.
3827 */
3828 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3829
3830 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003831 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3832 * before shutting down.
3833 *
3834 * {@hide}
3835 */
3836 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3837
3838 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003839 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3840 * requested by the user.
3841 *
3842 * {@hide}
3843 */
3844 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3845 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3846
3847 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003848 * 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 -07003849 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3850 * of restarting the application.
3851 */
3852 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3853
3854 /**
3855 * A String holding the phone number originally entered in
3856 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3857 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3858 */
3859 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003860
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003861 /**
3862 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3863 * intents to supply the uid the package had been assigned. Also an optional
3864 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3865 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3866 * purpose.
3867 */
3868 public static final String EXTRA_UID = "android.intent.extra.UID";
3869
3870 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003871 * @hide String array of package names.
3872 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003873 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003874 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3875
3876 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003877 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3878 * intents to indicate whether this represents a full uninstall (removing
3879 * both the code and its data) or a partial uninstall (leaving its data,
3880 * implying that this is an update).
3881 */
3882 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003883
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003884 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003885 * @hide
3886 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3887 * intents to indicate that at this point the package has been removed for
3888 * all users on the device.
3889 */
3890 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3891 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3892
3893 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003894 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3895 * intents to indicate that this is a replacement of the package, so this
3896 * broadcast will immediately be followed by an add broadcast for a
3897 * different version of the same package.
3898 */
3899 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003900
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003901 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003902 * Used as an int extra field in {@link android.app.AlarmManager} intents
3903 * to tell the application being invoked how many pending alarms are being
3904 * delievered with the intent. For one-shot alarms this will always be 1.
3905 * For recurring alarms, this might be greater than 1 if the device was
3906 * asleep or powered off at the time an earlier alarm would have been
3907 * delivered.
3908 */
3909 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003910
Jacek Surazski86b6c532009-05-13 14:38:28 +02003911 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003912 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3913 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003914 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3915 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003916 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3917 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3918 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003919 */
3920 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3921
3922 /**
3923 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3924 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003925 */
3926 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3927
3928 /**
3929 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3930 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003931 */
3932 public static final int EXTRA_DOCK_STATE_DESK = 1;
3933
3934 /**
3935 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3936 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003937 */
3938 public static final int EXTRA_DOCK_STATE_CAR = 2;
3939
3940 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003941 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3942 * to represent that the phone is in a analog (low end) dock.
3943 */
3944 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3945
3946 /**
3947 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3948 * to represent that the phone is in a digital (high end) dock.
3949 */
3950 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3951
3952 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003953 * Boolean that can be supplied as meta-data with a dock activity, to
3954 * indicate that the dock should take over the home key when it is active.
3955 */
3956 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003957
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003958 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003959 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3960 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003961 */
3962 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3963
3964 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003965 * Used in the extra field in the remote intent. It's astring token passed with the
3966 * remote intent.
3967 */
3968 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3969 "android.intent.extra.remote_intent_token";
3970
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003971 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003972 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003973 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003974 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003975 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003976 "android.intent.extra.changed_component_name";
3977
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003978 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003979 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003980 * and contains a string array of all of the components that have changed. If
3981 * the state of the overall package has changed, then it will contain an entry
3982 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003983 */
3984 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3985 "android.intent.extra.changed_component_name_list";
3986
3987 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003988 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003989 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00003990 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
3991 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
3992 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003993 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003994 */
3995 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3996 "android.intent.extra.changed_package_list";
3997
3998 /**
3999 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004000 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4001 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004002 * and contains an integer array of uids of all of the components
4003 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004004 */
4005 public static final String EXTRA_CHANGED_UID_LIST =
4006 "android.intent.extra.changed_uid_list";
4007
4008 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004009 * @hide
4010 * Magic extra system code can use when binding, to give a label for
4011 * who it is that has bound to a service. This is an integer giving
4012 * a framework string resource that can be displayed to the user.
4013 */
4014 public static final String EXTRA_CLIENT_LABEL =
4015 "android.intent.extra.client_label";
4016
4017 /**
4018 * @hide
4019 * Magic extra system code can use when binding, to give a PendingIntent object
4020 * that can be launched for the user to disable the system's use of this
4021 * service.
4022 */
4023 public static final String EXTRA_CLIENT_INTENT =
4024 "android.intent.extra.client_intent";
4025
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004026 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004027 * Extra used to indicate that an intent should only return data that is on
4028 * the local device. This is a boolean extra; the default is false. If true,
4029 * an implementation should only allow the user to select data that is
4030 * already on the device, not requiring it be downloaded from a remote
4031 * service when opened.
4032 *
4033 * @see #ACTION_GET_CONTENT
4034 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004035 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004036 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004037 */
4038 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004039 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004040
Amith Yamasani13593602012-03-22 16:16:17 -07004041 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004042 * Extra used to indicate that an intent can allow the user to select and
4043 * return multiple items. This is a boolean extra; the default is false. If
4044 * true, an implementation is allowed to present the user with a UI where
4045 * they can pick multiple items that are all returned to the caller. When
4046 * this happens, they should be returned as the {@link #getClipData()} part
4047 * of the result Intent.
4048 *
4049 * @see #ACTION_GET_CONTENT
4050 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004051 */
4052 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004053 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004054
4055 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004056 * The integer userHandle carried with broadcast intents related to addition, removal and
4057 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4058 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4059 *
Amith Yamasani13593602012-03-22 16:16:17 -07004060 * @hide
4061 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004062 public static final String EXTRA_USER_HANDLE =
4063 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004064
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004065 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004066 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4067 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4068 */
4069 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004070 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004071
4072 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004073 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004074 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4075 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004076 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004077 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4078
4079 /**
4080 * Extra sent in the intent to the BroadcastReceiver that handles
4081 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4082 * the restrictions as key/value pairs.
4083 */
4084 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4085 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004086
Amith Yamasani86118ba2013-03-28 14:33:16 -07004087 /**
4088 * Extra used in the response from a BroadcastReceiver that handles
4089 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4090 */
4091 public static final String EXTRA_RESTRICTIONS_INTENT =
4092 "android.intent.extra.restrictions_intent";
4093
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004094 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004095 * Extra used to communicate a set of acceptable MIME types. The type of the
4096 * extra is {@code String[]}. Values may be a combination of concrete MIME
4097 * types (such as "image/png") and/or partial MIME types (such as
4098 * "audio/*").
4099 *
4100 * @see #ACTION_GET_CONTENT
4101 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004102 */
4103 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4104
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004105 /**
4106 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4107 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004108 * When this is true, hardware devices can use this information to determine that
4109 * they shouldn't do a complete shutdown of their device since this is not a
4110 * complete shutdown down to the kernel, but only user space restarting.
4111 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004112 */
4113 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4114 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4115
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004116 /**
4117 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4118 * user has set their time format preferences to the 24 hour format.
4119 *
4120 * @hide for internal use only.
4121 */
4122 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4123 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4124
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004125 /** {@hide} */
4126 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4127
Rubin Xue8490f12015-06-25 12:17:48 +01004128 /** {@hide} */
4129 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4130
Santos Cordon15a13782015-03-31 18:32:31 -07004131 /**
4132 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4133 * activation request.
4134 * TODO: Add information about the structure and response data used with the pending intent.
4135 * @hide
4136 */
4137 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4138 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4139
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004140 /**
4141 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004142 *
4143 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004144 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004145 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4146
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004147 /**
4148 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004149 * When a profile goes into quiet mode, all apps in the profile are killed and the
4150 * profile user is stopped. Widgets originating from the profile are masked, and app
4151 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004152 */
4153 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004154
4155 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004156 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004157 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004158 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4159 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004160 *
4161 * @hide
4162 */
4163 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4164 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4165
4166 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004167 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004168 * to represent that a video codec is allowed to use.
4169 *
4170 * @hide
4171 */
4172 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4173
4174 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004175 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004176 * to represent that a audio codec is allowed to use.
4177 *
4178 * @hide
4179 */
4180 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4181
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004182 // ---------------------------------------------------------------------
4183 // ---------------------------------------------------------------------
4184 // Intent flags (see mFlags variable).
4185
Tor Norbyed9273d62013-05-30 15:59:53 -07004186 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004187 @IntDef(flag = true, value = {
4188 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4189 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004190 @Retention(RetentionPolicy.SOURCE)
4191 public @interface GrantUriMode {}
4192
Jeff Sharkey846318a2014-04-04 12:12:41 -07004193 /** @hide */
4194 @IntDef(flag = true, value = {
4195 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4196 @Retention(RetentionPolicy.SOURCE)
4197 public @interface AccessUriMode {}
4198
4199 /**
4200 * Test if given mode flags specify an access mode, which must be at least
4201 * read and/or write.
4202 *
4203 * @hide
4204 */
4205 public static boolean isAccessUriMode(int modeFlags) {
4206 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4207 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4208 }
4209
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004210 /**
4211 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004212 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004213 * specified in its ClipData. When applying to an Intent's ClipData,
4214 * all URIs as well as recursive traversals through data or other ClipData
4215 * in Intent items will be granted; only the grant flags of the top-level
4216 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004217 */
4218 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4219 /**
4220 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004221 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004222 * specified in its ClipData. When applying to an Intent's ClipData,
4223 * all URIs as well as recursive traversals through data or other ClipData
4224 * in Intent items will be granted; only the grant flags of the top-level
4225 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004226 */
4227 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4228 /**
4229 * Can be set by the caller to indicate that this Intent is coming from
4230 * a background operation, not from direct user interaction.
4231 */
4232 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4233 /**
4234 * A flag you can enable for debugging: when set, log messages will be
4235 * printed during the resolution of this intent to show you what has
4236 * been found to create the final resolved list.
4237 */
4238 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004239 /**
4240 * If set, this intent will not match any components in packages that
4241 * are currently stopped. If this is not set, then the default behavior
4242 * is to include such applications in the result.
4243 */
4244 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4245 /**
4246 * If set, this intent will always match any components in packages that
4247 * are currently stopped. This is the default behavior when
4248 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4249 * flags are set, this one wins (it allows overriding of exclude for
4250 * places where the framework may automatically set the exclude flag).
4251 */
4252 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004253
4254 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004255 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004256 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004257 * persisted across device reboots until explicitly revoked with
4258 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4259 * grant for possible persisting; the receiving application must call
4260 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4261 * actually persist.
4262 *
4263 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4264 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4265 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004266 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004267 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004268 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004269
4270 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004271 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4272 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4273 * applies to any URI that is a prefix match against the original granted
4274 * URI. (Without this flag, the URI must match exactly for access to be
4275 * granted.) Another URI is considered a prefix match only when scheme,
4276 * authority, and all path segments defined by the prefix are an exact
4277 * match.
4278 */
4279 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4280
4281 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004282 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004283 * homework and verified that they correctly handle packages and components
4284 * that come and go over time. In particular:
4285 * <ul>
4286 * <li>Apps installed on external storage, which will appear to be
4287 * uninstalled while the the device is ejected.
4288 * <li>Apps with encryption unaware components, which will appear to not
4289 * exist while the device is locked.
4290 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004291 *
4292 * @hide
4293 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004294 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004295
4296 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004297 * If set, the new activity is not kept in the history stack. As soon as
4298 * the user navigates away from it, the activity is finished. This may also
4299 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4300 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004301 *
4302 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4303 * is never invoked when the current activity starts a new activity which
4304 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004305 */
4306 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4307 /**
4308 * If set, the activity will not be launched if it is already running
4309 * at the top of the history stack.
4310 */
4311 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4312 /**
4313 * If set, this activity will become the start of a new task on this
4314 * history stack. A task (from the activity that started it to the
4315 * next task activity) defines an atomic group of activities that the
4316 * user can move to. Tasks can be moved to the foreground and background;
4317 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004318 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004319 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4320 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004321 *
4322 * <p>This flag is generally used by activities that want
4323 * to present a "launcher" style behavior: they give the user a list of
4324 * separate things that can be done, which otherwise run completely
4325 * independently of the activity launching them.
4326 *
4327 * <p>When using this flag, if a task is already running for the activity
4328 * you are now starting, then a new activity will not be started; instead,
4329 * the current task will simply be brought to the front of the screen with
4330 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4331 * to disable this behavior.
4332 *
4333 * <p>This flag can not be used when the caller is requesting a result from
4334 * the activity being launched.
4335 */
4336 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4337 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004338 * This flag is used to create a new task and launch an activity into it.
4339 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4340 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4341 * search through existing tasks for ones matching this Intent. Only if no such
4342 * task is found would a new task be created. When paired with
4343 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4344 * the search for a matching task and unconditionally start a new task.
4345 *
4346 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4347 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004348 * top-level application launcher.</strong> Used in conjunction with
4349 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4350 * behavior of bringing an existing task to the foreground. When set,
4351 * a new task is <em>always</em> started to host the Activity for the
4352 * Intent, regardless of whether there is already an existing task running
4353 * the same thing.
4354 *
4355 * <p><strong>Because the default system does not include graphical task management,
4356 * you should not use this flag unless you provide some way for a user to
4357 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004358 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004359 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4360 * creating new document tasks.
4361 *
4362 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004363 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004364 *
Scott Main7aee61f2011-02-08 11:25:01 -08004365 * <p>See
4366 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4367 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004368 *
4369 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4370 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004371 */
4372 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4373 /**
4374 * If set, and the activity being launched is already running in the
4375 * current task, then instead of launching a new instance of that activity,
4376 * all of the other activities on top of it will be closed and this Intent
4377 * will be delivered to the (now on top) old activity as a new Intent.
4378 *
4379 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4380 * If D calls startActivity() with an Intent that resolves to the component
4381 * of activity B, then C and D will be finished and B receive the given
4382 * Intent, resulting in the stack now being: A, B.
4383 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004384 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004385 * either receive the new intent you are starting here in its
4386 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004387 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004388 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4389 * the same intent, then it will be finished and re-created; for all other
4390 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4391 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004392 *
4393 * <p>This launch mode can also be used to good effect in conjunction with
4394 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4395 * of a task, it will bring any currently running instance of that task
4396 * to the foreground, and then clear it to its root state. This is
4397 * especially useful, for example, when launching an activity from the
4398 * notification manager.
4399 *
Scott Main7aee61f2011-02-08 11:25:01 -08004400 * <p>See
4401 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4402 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004403 */
4404 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4405 /**
4406 * If set and this intent is being used to launch a new activity from an
4407 * existing one, then the reply target of the existing activity will be
4408 * transfered to the new activity. This way the new activity can call
4409 * {@link android.app.Activity#setResult} and have that result sent back to
4410 * the reply target of the original activity.
4411 */
4412 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4413 /**
4414 * If set and this intent is being used to launch a new activity from an
4415 * existing one, the current activity will not be counted as the top
4416 * activity for deciding whether the new intent should be delivered to
4417 * the top instead of starting a new one. The previous activity will
4418 * be used as the top, with the assumption being that the current activity
4419 * will finish itself immediately.
4420 */
4421 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4422 /**
4423 * If set, the new activity is not kept in the list of recently launched
4424 * activities.
4425 */
4426 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4427 /**
4428 * This flag is not normally set by application code, but set for you by
4429 * the system as described in the
4430 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4431 * launchMode} documentation for the singleTask mode.
4432 */
4433 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4434 /**
4435 * If set, and this activity is either being started in a new task or
4436 * bringing to the top an existing task, then it will be launched as
4437 * the front door of the task. This will result in the application of
4438 * any affinities needed to have that task in the proper state (either
4439 * moving activities to or from it), or simply resetting that task to
4440 * its initial state if needed.
4441 */
4442 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4443 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004444 * This flag is not normally set by application code, but set for you by
4445 * the system if this activity is being launched from history
4446 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004447 */
4448 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004449 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004450 * @deprecated As of API 21 this performs identically to
4451 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004452 */
4453 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004454 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004455 * This flag is used to open a document into a new task rooted at the activity launched
4456 * by this Intent. Through the use of this flag, or its equivalent attribute,
4457 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004458 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004459 *
Craig Mautner026596b2014-05-21 15:35:44 -07004460 * <p>The use of the activity attribute form of this,
4461 * {@link android.R.attr#documentLaunchMode}, is
4462 * preferred over the Intent flag described here. The attribute form allows the
4463 * Activity to specify multiple document behavior for all launchers of the Activity
4464 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004465 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004466 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4467 * it is kept after the activity is finished is different than the use of
4468 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4469 * this flag is being used to create a new recents entry, then by default that entry
4470 * will be removed once the activity is finished. You can modify this behavior with
4471 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4472 *
Craig Mautner026596b2014-05-21 15:35:44 -07004473 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4474 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4475 * equivalent of the Activity manifest specifying {@link
4476 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4477 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4478 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004479 *
Craig Mautner026596b2014-05-21 15:35:44 -07004480 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004481 *
Craig Mautner026596b2014-05-21 15:35:44 -07004482 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004483 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4484 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004485 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004486 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004487 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004488 * callback from occurring on the current frontmost activity before it is
4489 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004490 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004491 * <p>Typically, an activity can rely on that callback to indicate that an
4492 * explicit user action has caused their activity to be moved out of the
4493 * foreground. The callback marks an appropriate point in the activity's
4494 * lifecycle for it to dismiss any notifications that it intends to display
4495 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004496 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004497 * <p>If an activity is ever started via any non-user-driven events such as
4498 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4499 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004500 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004501 */
4502 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004503 /**
4504 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4505 * this flag will cause the launched activity to be brought to the front of its
4506 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004507 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004508 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4509 * If D calls startActivity() with an Intent that resolves to the component
4510 * of activity B, then B will be brought to the front of the history stack,
4511 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004512 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004513 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004514 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004515 */
4516 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004517 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004518 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4519 * this flag will prevent the system from applying an activity transition
4520 * animation to go to the next activity state. This doesn't mean an
4521 * animation will never run -- if another activity change happens that doesn't
4522 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004523 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004524 * when you are going to do a series of activity operations but the
4525 * animation seen by the user shouldn't be driven by the first activity
4526 * change but rather a later one.
4527 */
4528 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4529 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004530 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4531 * this flag will cause any existing task that would be associated with the
4532 * activity to be cleared before the activity is started. That is, the activity
4533 * becomes the new root of an otherwise empty task, and any old activities
4534 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4535 */
4536 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4537 /**
4538 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4539 * this flag will cause a newly launching task to be placed on top of the current
4540 * home activity task (if there is one). That is, pressing back from the task
4541 * will always return the user to home even if that was not the last activity they
4542 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4543 */
4544 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4545 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004546 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4547 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004548 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004549 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004550 * this flag. When set and the task's activity is finished, the recents
4551 * entry will remain in the interface for the user to re-launch it, like a
4552 * recents entry for a top-level application.
4553 * <p>
4554 * The receiving activity can override this request with
4555 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4556 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004557 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004558 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004559 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004560
4561 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004562 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4563 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004564 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4565 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004566 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004567 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004568
4569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004570 * If set, when sending a broadcast only registered receivers will be
4571 * called -- no BroadcastReceiver components will be launched.
4572 */
4573 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004574 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004575 * If set, when sending a broadcast the new broadcast will replace
4576 * any existing pending broadcast that matches it. Matching is defined
4577 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4578 * true for the intents of the two broadcasts. When a match is found,
4579 * the new broadcast (and receivers associated with it) will replace the
4580 * existing one in the pending broadcast list, remaining at the same
4581 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004582 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004583 * <p>This flag is most typically used with sticky broadcasts, which
4584 * only care about delivering the most recent values of the broadcast
4585 * to their receivers.
4586 */
4587 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4588 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004589 * If set, when sending a broadcast the recipient is allowed to run at
4590 * foreground priority, with a shorter timeout interval. During normal
4591 * broadcasts the receivers are not automatically hoisted out of the
4592 * background priority class.
4593 */
4594 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4595 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004596 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4597 * They can still propagate results through to later receivers, but they can not prevent
4598 * later receivers from seeing the broadcast.
4599 */
4600 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4601 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004602 * If set, when sending a broadcast <i>before boot has completed</i> only
4603 * registered receivers will be called -- no BroadcastReceiver components
4604 * will be launched. Sticky intent state will be recorded properly even
4605 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4606 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004607 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004608 * <p>This flag is only for use by system sevices as a convenience to
4609 * avoid having to implement a more complex mechanism around detection
4610 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004611 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004612 * @hide
4613 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004614 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004615 /**
4616 * Set when this broadcast is for a boot upgrade, a special mode that
4617 * allows the broadcast to be sent before the system is ready and launches
4618 * the app process with no providers running in it.
4619 * @hide
4620 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004621 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004622 /**
4623 * If set, the broadcast will always go to manifest receivers in background (cached
4624 * or not running) apps, regardless of whether that would be done by default. By
4625 * default they will only receive broadcasts if the broadcast has specified an
4626 * explicit component or package name.
4627 * @hide
4628 */
4629 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4630 /**
4631 * If set, the broadcast will never go to manifest receivers in background (cached
4632 * or not running) apps, regardless of whether that would be done by default. By
4633 * default they will receive broadcasts if the broadcast has specified an
4634 * explicit component or package name.
4635 * @hide
4636 */
4637 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004638
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004639 /**
4640 * @hide Flags that can't be changed with PendingIntent.
4641 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004642 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4643 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4644 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004645
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004646 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004647 // ---------------------------------------------------------------------
4648 // toUri() and parseUri() options.
4649
4650 /**
4651 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4652 * always has the "intent:" scheme. This syntax can be used when you want
4653 * to later disambiguate between URIs that are intended to describe an
4654 * Intent vs. all others that should be treated as raw URIs. When used
4655 * with {@link #parseUri}, any other scheme will result in a generic
4656 * VIEW action for that raw URI.
4657 */
4658 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004659
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004660 /**
4661 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4662 * always has the "android-app:" scheme. This is a variation of
4663 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4664 * http/https URI being delivered to a specific package name. The format
4665 * is:
4666 *
4667 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004668 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004669 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004670 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4671 * you must also include a scheme; including a path also requires both a host and a scheme.
4672 * The final #Intent; fragment can be used without a scheme, host, or path.
4673 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004674 * used with intents that have a {@link #setSelector}, since the base intent
4675 * will always have an explicit package name.</p>
4676 *
4677 * <p>Some examples of how this scheme maps to Intent objects:</p>
4678 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4679 * <colgroup align="left" />
4680 * <colgroup align="left" />
4681 * <thead>
4682 * <tr><th>URI</th> <th>Intent</th></tr>
4683 * </thead>
4684 *
4685 * <tbody>
4686 * <tr><td><code>android-app://com.example.app</code></td>
4687 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4688 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4689 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4690 * </table></td>
4691 * </tr>
4692 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4693 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4694 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4695 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4696 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4697 * </table></td>
4698 * </tr>
4699 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4700 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4701 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4702 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4703 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4704 * </table></td>
4705 * </tr>
4706 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4707 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4708 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4709 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4710 * </table></td>
4711 * </tr>
4712 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4713 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4714 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4715 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4716 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4717 * </table></td>
4718 * </tr>
4719 * <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>
4720 * <td><table border="" style="margin:0" >
4721 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4722 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4723 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4724 * </table></td>
4725 * </tr>
4726 * </tbody>
4727 * </table>
4728 */
4729 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4730
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004731 /**
4732 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4733 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4734 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4735 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4736 * generated Intent can not cause unexpected data access to happen.
4737 *
4738 * <p>If you do not trust the source of the URI being parsed, you should still do further
4739 * processing to protect yourself from it. In particular, when using it to start an
4740 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4741 * that can handle it.</p>
4742 */
4743 public static final int URI_ALLOW_UNSAFE = 1<<2;
4744
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004745 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004746
4747 private String mAction;
4748 private Uri mData;
4749 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004750 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004751 private ComponentName mComponent;
4752 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004753 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004754 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004755 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004756 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004757 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004758 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004759
4760 // ---------------------------------------------------------------------
4761
4762 /**
4763 * Create an empty intent.
4764 */
4765 public Intent() {
4766 }
4767
4768 /**
4769 * Copy constructor.
4770 */
4771 public Intent(Intent o) {
4772 this.mAction = o.mAction;
4773 this.mData = o.mData;
4774 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004775 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004776 this.mComponent = o.mComponent;
4777 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004778 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004779 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004780 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004781 }
4782 if (o.mExtras != null) {
4783 this.mExtras = new Bundle(o.mExtras);
4784 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004785 if (o.mSourceBounds != null) {
4786 this.mSourceBounds = new Rect(o.mSourceBounds);
4787 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004788 if (o.mSelector != null) {
4789 this.mSelector = new Intent(o.mSelector);
4790 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004791 if (o.mClipData != null) {
4792 this.mClipData = new ClipData(o.mClipData);
4793 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004794 }
4795
4796 @Override
4797 public Object clone() {
4798 return new Intent(this);
4799 }
4800
4801 private Intent(Intent o, boolean all) {
4802 this.mAction = o.mAction;
4803 this.mData = o.mData;
4804 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004805 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004806 this.mComponent = o.mComponent;
4807 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004808 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004809 }
4810 }
4811
4812 /**
4813 * Make a clone of only the parts of the Intent that are relevant for
4814 * filter matching: the action, data, type, component, and categories.
4815 */
4816 public Intent cloneFilter() {
4817 return new Intent(this, false);
4818 }
4819
4820 /**
4821 * Create an intent with a given action. All other fields (data, type,
4822 * class) are null. Note that the action <em>must</em> be in a
4823 * namespace because Intents are used globally in the system -- for
4824 * example the system VIEW action is android.intent.action.VIEW; an
4825 * application's custom action would be something like
4826 * com.google.app.myapp.CUSTOM_ACTION.
4827 *
4828 * @param action The Intent action, such as ACTION_VIEW.
4829 */
4830 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004831 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004832 }
4833
4834 /**
4835 * Create an intent with a given action and for a given data url. Note
4836 * that the action <em>must</em> be in a namespace because Intents are
4837 * used globally in the system -- for example the system VIEW action is
4838 * android.intent.action.VIEW; an application's custom action would be
4839 * something like com.google.app.myapp.CUSTOM_ACTION.
4840 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004841 * <p><em>Note: scheme and host name matching in the Android framework is
4842 * case-sensitive, unlike the formal RFC. As a result,
4843 * you should always ensure that you write your Uri with these elements
4844 * using lower case letters, and normalize any Uris you receive from
4845 * outside of Android to ensure the scheme and host is lower case.</em></p>
4846 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004847 * @param action The Intent action, such as ACTION_VIEW.
4848 * @param uri The Intent data URI.
4849 */
4850 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004851 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004852 mData = uri;
4853 }
4854
4855 /**
4856 * Create an intent for a specific component. All other fields (action, data,
4857 * type, class) are null, though they can be modified later with explicit
4858 * calls. This provides a convenient way to create an intent that is
4859 * intended to execute a hard-coded class name, rather than relying on the
4860 * system to find an appropriate class for you; see {@link #setComponent}
4861 * for more information on the repercussions of this.
4862 *
4863 * @param packageContext A Context of the application package implementing
4864 * this class.
4865 * @param cls The component class that is to be used for the intent.
4866 *
4867 * @see #setClass
4868 * @see #setComponent
4869 * @see #Intent(String, android.net.Uri , Context, Class)
4870 */
4871 public Intent(Context packageContext, Class<?> cls) {
4872 mComponent = new ComponentName(packageContext, cls);
4873 }
4874
4875 /**
4876 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004877 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004878 * construct the Intent and then calling {@link #setClass} to set its
4879 * class.
4880 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004881 * <p><em>Note: scheme and host name matching in the Android framework is
4882 * case-sensitive, unlike the formal RFC. As a result,
4883 * you should always ensure that you write your Uri with these elements
4884 * using lower case letters, and normalize any Uris you receive from
4885 * outside of Android to ensure the scheme and host is lower case.</em></p>
4886 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004887 * @param action The Intent action, such as ACTION_VIEW.
4888 * @param uri The Intent data URI.
4889 * @param packageContext A Context of the application package implementing
4890 * this class.
4891 * @param cls The component class that is to be used for the intent.
4892 *
4893 * @see #Intent(String, android.net.Uri)
4894 * @see #Intent(Context, Class)
4895 * @see #setClass
4896 * @see #setComponent
4897 */
4898 public Intent(String action, Uri uri,
4899 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004900 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004901 mData = uri;
4902 mComponent = new ComponentName(packageContext, cls);
4903 }
4904
4905 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004906 * Create an intent to launch the main (root) activity of a task. This
4907 * is the Intent that is started when the application's is launched from
4908 * Home. For anything else that wants to launch an application in the
4909 * same way, it is important that they use an Intent structured the same
4910 * way, and can use this function to ensure this is the case.
4911 *
4912 * <p>The returned Intent has the given Activity component as its explicit
4913 * component, {@link #ACTION_MAIN} as its action, and includes the
4914 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4915 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4916 * to do that through {@link #addFlags(int)} on the returned Intent.
4917 *
4918 * @param mainActivity The main activity component that this Intent will
4919 * launch.
4920 * @return Returns a newly created Intent that can be used to launch the
4921 * activity as a main application entry.
4922 *
4923 * @see #setClass
4924 * @see #setComponent
4925 */
4926 public static Intent makeMainActivity(ComponentName mainActivity) {
4927 Intent intent = new Intent(ACTION_MAIN);
4928 intent.setComponent(mainActivity);
4929 intent.addCategory(CATEGORY_LAUNCHER);
4930 return intent;
4931 }
4932
4933 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004934 * Make an Intent for the main activity of an application, without
4935 * specifying a specific activity to run but giving a selector to find
4936 * the activity. This results in a final Intent that is structured
4937 * the same as when the application is launched from
4938 * Home. For anything else that wants to launch an application in the
4939 * same way, it is important that they use an Intent structured the same
4940 * way, and can use this function to ensure this is the case.
4941 *
4942 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4943 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4944 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4945 * to do that through {@link #addFlags(int)} on the returned Intent.
4946 *
4947 * @param selectorAction The action name of the Intent's selector.
4948 * @param selectorCategory The name of a category to add to the Intent's
4949 * selector.
4950 * @return Returns a newly created Intent that can be used to launch the
4951 * activity as a main application entry.
4952 *
4953 * @see #setSelector(Intent)
4954 */
4955 public static Intent makeMainSelectorActivity(String selectorAction,
4956 String selectorCategory) {
4957 Intent intent = new Intent(ACTION_MAIN);
4958 intent.addCategory(CATEGORY_LAUNCHER);
4959 Intent selector = new Intent();
4960 selector.setAction(selectorAction);
4961 selector.addCategory(selectorCategory);
4962 intent.setSelector(selector);
4963 return intent;
4964 }
4965
4966 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004967 * Make an Intent that can be used to re-launch an application's task
4968 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4969 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4970 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4971 *
4972 * @param mainActivity The activity component that is the root of the
4973 * task; this is the activity that has been published in the application's
4974 * manifest as the main launcher icon.
4975 *
4976 * @return Returns a newly created Intent that can be used to relaunch the
4977 * activity's task in its root state.
4978 */
4979 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4980 Intent intent = makeMainActivity(mainActivity);
4981 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4982 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4983 return intent;
4984 }
4985
4986 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004987 * Call {@link #parseUri} with 0 flags.
4988 * @deprecated Use {@link #parseUri} instead.
4989 */
4990 @Deprecated
4991 public static Intent getIntent(String uri) throws URISyntaxException {
4992 return parseUri(uri, 0);
4993 }
Tom Taylord4a47292009-12-21 13:59:18 -08004994
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004995 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004996 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004997 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004998 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004999 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005000 *
5001 * <p>The URI given here must not be relative -- that is, it must include
5002 * the scheme and full path.
5003 *
5004 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005005 * @param flags Additional processing flags. Either 0,
5006 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005007 *
5008 * @return Intent The newly created Intent object.
5009 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005010 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5011 * it bad (as parsed by the Uri class) or the Intent data within the
5012 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005013 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005014 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005015 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005016 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005017 int i = 0;
5018 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005019 final boolean androidApp = uri.startsWith("android-app:");
5020
5021 // Validate intent scheme if requested.
5022 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5023 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005024 Intent intent = new Intent(ACTION_VIEW);
5025 try {
5026 intent.setData(Uri.parse(uri));
5027 } catch (IllegalArgumentException e) {
5028 throw new URISyntaxException(uri, e.getMessage());
5029 }
5030 return intent;
5031 }
5032 }
Tom Taylord4a47292009-12-21 13:59:18 -08005033
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005035 // simple case
5036 if (i == -1) {
5037 if (!androidApp) {
5038 return new Intent(ACTION_VIEW, Uri.parse(uri));
5039 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005040
5041 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005042 } else if (!uri.startsWith("#Intent;", i)) {
5043 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005044 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005045 } else {
5046 i = -1;
5047 }
5048 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005049
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005050 // new format
5051 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005052 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005053 boolean explicitAction = false;
5054 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005055
5056 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005057 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005058 String data;
5059 if (i >= 0) {
5060 data = uri.substring(0, i);
5061 i += 8; // length of "#Intent;"
5062 } else {
5063 data = uri;
5064 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005065
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005066 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005067 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005068 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005069 if (eq < 0) eq = i-1;
5070 int semi = uri.indexOf(';', i);
5071 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005072
5073 // action
5074 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005075 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005076 if (!inSelector) {
5077 explicitAction = true;
5078 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005079 }
5080
5081 // categories
5082 else if (uri.startsWith("category=", i)) {
5083 intent.addCategory(value);
5084 }
5085
5086 // type
5087 else if (uri.startsWith("type=", i)) {
5088 intent.mType = value;
5089 }
5090
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005091 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005092 else if (uri.startsWith("launchFlags=", i)) {
5093 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005094 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5095 intent.mFlags &= ~IMMUTABLE_FLAGS;
5096 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005097 }
5098
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005099 // package
5100 else if (uri.startsWith("package=", i)) {
5101 intent.mPackage = value;
5102 }
5103
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005104 // component
5105 else if (uri.startsWith("component=", i)) {
5106 intent.mComponent = ComponentName.unflattenFromString(value);
5107 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005108
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005109 // scheme
5110 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005111 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005112 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005113 } else {
5114 scheme = value;
5115 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005116 }
5117
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005118 // source bounds
5119 else if (uri.startsWith("sourceBounds=", i)) {
5120 intent.mSourceBounds = Rect.unflattenFromString(value);
5121 }
5122
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005123 // selector
5124 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5125 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005126 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005127 }
5128
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005129 // extra
5130 else {
5131 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005132 // create Bundle if it doesn't already exist
5133 if (intent.mExtras == null) intent.mExtras = new Bundle();
5134 Bundle b = intent.mExtras;
5135 // add EXTRA
5136 if (uri.startsWith("S.", i)) b.putString(key, value);
5137 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5138 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5139 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5140 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5141 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5142 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5143 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5144 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5145 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5146 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005147
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005148 // move to the next item
5149 i = semi + 1;
5150 }
5151
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005152 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005153 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005154 if (baseIntent.mPackage == null) {
5155 baseIntent.setSelector(intent);
5156 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005157 intent = baseIntent;
5158 }
5159
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005160 if (data != null) {
5161 if (data.startsWith("intent:")) {
5162 data = data.substring(7);
5163 if (scheme != null) {
5164 data = scheme + ':' + data;
5165 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005166 } else if (data.startsWith("android-app:")) {
5167 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5168 // Correctly formed android-app, first part is package name.
5169 int end = data.indexOf('/', 14);
5170 if (end < 0) {
5171 // All we have is a package name.
5172 intent.mPackage = data.substring(14);
5173 if (!explicitAction) {
5174 intent.setAction(ACTION_MAIN);
5175 }
5176 data = "";
5177 } else {
5178 // Target the Intent at the given package name always.
5179 String authority = null;
5180 intent.mPackage = data.substring(14, end);
5181 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005182 if ((end+1) < data.length()) {
5183 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5184 // Found a scheme, remember it.
5185 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005186 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005187 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5188 // Found a authority, remember it.
5189 authority = data.substring(end+1, newEnd);
5190 end = newEnd;
5191 }
5192 } else {
5193 // All we have is a scheme.
5194 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005195 }
5196 }
5197 if (scheme == null) {
5198 // If there was no scheme, then this just targets the package.
5199 if (!explicitAction) {
5200 intent.setAction(ACTION_MAIN);
5201 }
5202 data = "";
5203 } else if (authority == null) {
5204 data = scheme + ":";
5205 } else {
5206 data = scheme + "://" + authority + data.substring(end);
5207 }
5208 }
5209 } else {
5210 data = "";
5211 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005212 }
Tom Taylord4a47292009-12-21 13:59:18 -08005213
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005214 if (data.length() > 0) {
5215 try {
5216 intent.mData = Uri.parse(data);
5217 } catch (IllegalArgumentException e) {
5218 throw new URISyntaxException(uri, e.getMessage());
5219 }
5220 }
5221 }
Tom Taylord4a47292009-12-21 13:59:18 -08005222
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005223 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005224
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005225 } catch (IndexOutOfBoundsException e) {
5226 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5227 }
5228 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005229
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005230 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005231 return getIntentOld(uri, 0);
5232 }
5233
5234 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005235 Intent intent;
5236
5237 int i = uri.lastIndexOf('#');
5238 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005239 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005240 final int intentFragmentStart = i;
5241 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005242
5243 i++;
5244
5245 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005246 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005247 i += 7;
5248 int j = uri.indexOf(')', i);
5249 action = uri.substring(i, j);
5250 i = j + 1;
5251 }
5252
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005253 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005254
5255 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005256 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005257 i += 11;
5258 int j = uri.indexOf(')', i);
5259 while (i < j) {
5260 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005261 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005262 if (i < sep) {
5263 intent.addCategory(uri.substring(i, sep));
5264 }
5265 i = sep + 1;
5266 }
5267 i = j + 1;
5268 }
5269
5270 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005271 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005272 i += 5;
5273 int j = uri.indexOf(')', i);
5274 intent.mType = uri.substring(i, j);
5275 i = j + 1;
5276 }
5277
5278 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005279 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005280 i += 12;
5281 int j = uri.indexOf(')', i);
5282 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005283 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5284 intent.mFlags &= ~IMMUTABLE_FLAGS;
5285 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005286 i = j + 1;
5287 }
5288
5289 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005290 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005291 i += 10;
5292 int j = uri.indexOf(')', i);
5293 int sep = uri.indexOf('!', i);
5294 if (sep >= 0 && sep < j) {
5295 String pkg = uri.substring(i, sep);
5296 String cls = uri.substring(sep + 1, j);
5297 intent.mComponent = new ComponentName(pkg, cls);
5298 }
5299 i = j + 1;
5300 }
5301
5302 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005303 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005304 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005305
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005306 final int closeParen = uri.indexOf(')', i);
5307 if (closeParen == -1) throw new URISyntaxException(uri,
5308 "EXTRA missing trailing ')'", i);
5309
5310 while (i < closeParen) {
5311 // fetch the key value
5312 int j = uri.indexOf('=', i);
5313 if (j <= i + 1 || i >= closeParen) {
5314 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5315 }
5316 char type = uri.charAt(i);
5317 i++;
5318 String key = uri.substring(i, j);
5319 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005320
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005321 // get type-value
5322 j = uri.indexOf('!', i);
5323 if (j == -1 || j >= closeParen) j = closeParen;
5324 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5325 String value = uri.substring(i, j);
5326 i = j;
5327
5328 // create Bundle if it doesn't already exist
5329 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005330
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005331 // add item to bundle
5332 try {
5333 switch (type) {
5334 case 'S':
5335 intent.mExtras.putString(key, Uri.decode(value));
5336 break;
5337 case 'B':
5338 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5339 break;
5340 case 'b':
5341 intent.mExtras.putByte(key, Byte.parseByte(value));
5342 break;
5343 case 'c':
5344 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5345 break;
5346 case 'd':
5347 intent.mExtras.putDouble(key, Double.parseDouble(value));
5348 break;
5349 case 'f':
5350 intent.mExtras.putFloat(key, Float.parseFloat(value));
5351 break;
5352 case 'i':
5353 intent.mExtras.putInt(key, Integer.parseInt(value));
5354 break;
5355 case 'l':
5356 intent.mExtras.putLong(key, Long.parseLong(value));
5357 break;
5358 case 's':
5359 intent.mExtras.putShort(key, Short.parseShort(value));
5360 break;
5361 default:
5362 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5363 }
5364 } catch (NumberFormatException e) {
5365 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5366 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005367
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005368 char ch = uri.charAt(i);
5369 if (ch == ')') break;
5370 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5371 i++;
5372 }
5373 }
5374
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005375 if (isIntentFragment) {
5376 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5377 } else {
5378 intent.mData = Uri.parse(uri);
5379 }
Tom Taylord4a47292009-12-21 13:59:18 -08005380
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005381 if (intent.mAction == null) {
5382 // By default, if no action is specified, then use VIEW.
5383 intent.mAction = ACTION_VIEW;
5384 }
5385
5386 } else {
5387 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5388 }
5389
5390 return intent;
5391 }
5392
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005393 /** @hide */
5394 public interface CommandOptionHandler {
5395 boolean handleOption(String opt, ShellCommand cmd);
5396 }
5397
5398 /** @hide */
5399 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5400 throws URISyntaxException {
5401 Intent intent = new Intent();
5402 Intent baseIntent = intent;
5403 boolean hasIntentInfo = false;
5404
5405 Uri data = null;
5406 String type = null;
5407
5408 String opt;
5409 while ((opt=cmd.getNextOption()) != null) {
5410 switch (opt) {
5411 case "-a":
5412 intent.setAction(cmd.getNextArgRequired());
5413 if (intent == baseIntent) {
5414 hasIntentInfo = true;
5415 }
5416 break;
5417 case "-d":
5418 data = Uri.parse(cmd.getNextArgRequired());
5419 if (intent == baseIntent) {
5420 hasIntentInfo = true;
5421 }
5422 break;
5423 case "-t":
5424 type = cmd.getNextArgRequired();
5425 if (intent == baseIntent) {
5426 hasIntentInfo = true;
5427 }
5428 break;
5429 case "-c":
5430 intent.addCategory(cmd.getNextArgRequired());
5431 if (intent == baseIntent) {
5432 hasIntentInfo = true;
5433 }
5434 break;
5435 case "-e":
5436 case "--es": {
5437 String key = cmd.getNextArgRequired();
5438 String value = cmd.getNextArgRequired();
5439 intent.putExtra(key, value);
5440 }
5441 break;
5442 case "--esn": {
5443 String key = cmd.getNextArgRequired();
5444 intent.putExtra(key, (String) null);
5445 }
5446 break;
5447 case "--ei": {
5448 String key = cmd.getNextArgRequired();
5449 String value = cmd.getNextArgRequired();
5450 intent.putExtra(key, Integer.decode(value));
5451 }
5452 break;
5453 case "--eu": {
5454 String key = cmd.getNextArgRequired();
5455 String value = cmd.getNextArgRequired();
5456 intent.putExtra(key, Uri.parse(value));
5457 }
5458 break;
5459 case "--ecn": {
5460 String key = cmd.getNextArgRequired();
5461 String value = cmd.getNextArgRequired();
5462 ComponentName cn = ComponentName.unflattenFromString(value);
5463 if (cn == null)
5464 throw new IllegalArgumentException("Bad component name: " + value);
5465 intent.putExtra(key, cn);
5466 }
5467 break;
5468 case "--eia": {
5469 String key = cmd.getNextArgRequired();
5470 String value = cmd.getNextArgRequired();
5471 String[] strings = value.split(",");
5472 int[] list = new int[strings.length];
5473 for (int i = 0; i < strings.length; i++) {
5474 list[i] = Integer.decode(strings[i]);
5475 }
5476 intent.putExtra(key, list);
5477 }
5478 break;
5479 case "--eial": {
5480 String key = cmd.getNextArgRequired();
5481 String value = cmd.getNextArgRequired();
5482 String[] strings = value.split(",");
5483 ArrayList<Integer> list = new ArrayList<>(strings.length);
5484 for (int i = 0; i < strings.length; i++) {
5485 list.add(Integer.decode(strings[i]));
5486 }
5487 intent.putExtra(key, list);
5488 }
5489 break;
5490 case "--el": {
5491 String key = cmd.getNextArgRequired();
5492 String value = cmd.getNextArgRequired();
5493 intent.putExtra(key, Long.valueOf(value));
5494 }
5495 break;
5496 case "--ela": {
5497 String key = cmd.getNextArgRequired();
5498 String value = cmd.getNextArgRequired();
5499 String[] strings = value.split(",");
5500 long[] list = new long[strings.length];
5501 for (int i = 0; i < strings.length; i++) {
5502 list[i] = Long.valueOf(strings[i]);
5503 }
5504 intent.putExtra(key, list);
5505 hasIntentInfo = true;
5506 }
5507 break;
5508 case "--elal": {
5509 String key = cmd.getNextArgRequired();
5510 String value = cmd.getNextArgRequired();
5511 String[] strings = value.split(",");
5512 ArrayList<Long> list = new ArrayList<>(strings.length);
5513 for (int i = 0; i < strings.length; i++) {
5514 list.add(Long.valueOf(strings[i]));
5515 }
5516 intent.putExtra(key, list);
5517 hasIntentInfo = true;
5518 }
5519 break;
5520 case "--ef": {
5521 String key = cmd.getNextArgRequired();
5522 String value = cmd.getNextArgRequired();
5523 intent.putExtra(key, Float.valueOf(value));
5524 hasIntentInfo = true;
5525 }
5526 break;
5527 case "--efa": {
5528 String key = cmd.getNextArgRequired();
5529 String value = cmd.getNextArgRequired();
5530 String[] strings = value.split(",");
5531 float[] list = new float[strings.length];
5532 for (int i = 0; i < strings.length; i++) {
5533 list[i] = Float.valueOf(strings[i]);
5534 }
5535 intent.putExtra(key, list);
5536 hasIntentInfo = true;
5537 }
5538 break;
5539 case "--efal": {
5540 String key = cmd.getNextArgRequired();
5541 String value = cmd.getNextArgRequired();
5542 String[] strings = value.split(",");
5543 ArrayList<Float> list = new ArrayList<>(strings.length);
5544 for (int i = 0; i < strings.length; i++) {
5545 list.add(Float.valueOf(strings[i]));
5546 }
5547 intent.putExtra(key, list);
5548 hasIntentInfo = true;
5549 }
5550 break;
5551 case "--esa": {
5552 String key = cmd.getNextArgRequired();
5553 String value = cmd.getNextArgRequired();
5554 // Split on commas unless they are preceeded by an escape.
5555 // The escape character must be escaped for the string and
5556 // again for the regex, thus four escape characters become one.
5557 String[] strings = value.split("(?<!\\\\),");
5558 intent.putExtra(key, strings);
5559 hasIntentInfo = true;
5560 }
5561 break;
5562 case "--esal": {
5563 String key = cmd.getNextArgRequired();
5564 String value = cmd.getNextArgRequired();
5565 // Split on commas unless they are preceeded by an escape.
5566 // The escape character must be escaped for the string and
5567 // again for the regex, thus four escape characters become one.
5568 String[] strings = value.split("(?<!\\\\),");
5569 ArrayList<String> list = new ArrayList<>(strings.length);
5570 for (int i = 0; i < strings.length; i++) {
5571 list.add(strings[i]);
5572 }
5573 intent.putExtra(key, list);
5574 hasIntentInfo = true;
5575 }
5576 break;
5577 case "--ez": {
5578 String key = cmd.getNextArgRequired();
5579 String value = cmd.getNextArgRequired().toLowerCase();
5580 // Boolean.valueOf() results in false for anything that is not "true", which is
5581 // error-prone in shell commands
5582 boolean arg;
5583 if ("true".equals(value) || "t".equals(value)) {
5584 arg = true;
5585 } else if ("false".equals(value) || "f".equals(value)) {
5586 arg = false;
5587 } else {
5588 try {
5589 arg = Integer.decode(value) != 0;
5590 } catch (NumberFormatException ex) {
5591 throw new IllegalArgumentException("Invalid boolean value: " + value);
5592 }
5593 }
5594
5595 intent.putExtra(key, arg);
5596 }
5597 break;
5598 case "-n": {
5599 String str = cmd.getNextArgRequired();
5600 ComponentName cn = ComponentName.unflattenFromString(str);
5601 if (cn == null)
5602 throw new IllegalArgumentException("Bad component name: " + str);
5603 intent.setComponent(cn);
5604 if (intent == baseIntent) {
5605 hasIntentInfo = true;
5606 }
5607 }
5608 break;
5609 case "-p": {
5610 String str = cmd.getNextArgRequired();
5611 intent.setPackage(str);
5612 if (intent == baseIntent) {
5613 hasIntentInfo = true;
5614 }
5615 }
5616 break;
5617 case "-f":
5618 String str = cmd.getNextArgRequired();
5619 intent.setFlags(Integer.decode(str).intValue());
5620 break;
5621 case "--grant-read-uri-permission":
5622 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5623 break;
5624 case "--grant-write-uri-permission":
5625 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5626 break;
5627 case "--grant-persistable-uri-permission":
5628 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5629 break;
5630 case "--grant-prefix-uri-permission":
5631 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5632 break;
5633 case "--exclude-stopped-packages":
5634 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5635 break;
5636 case "--include-stopped-packages":
5637 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5638 break;
5639 case "--debug-log-resolution":
5640 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5641 break;
5642 case "--activity-brought-to-front":
5643 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5644 break;
5645 case "--activity-clear-top":
5646 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5647 break;
5648 case "--activity-clear-when-task-reset":
5649 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5650 break;
5651 case "--activity-exclude-from-recents":
5652 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5653 break;
5654 case "--activity-launched-from-history":
5655 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5656 break;
5657 case "--activity-multiple-task":
5658 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5659 break;
5660 case "--activity-no-animation":
5661 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5662 break;
5663 case "--activity-no-history":
5664 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5665 break;
5666 case "--activity-no-user-action":
5667 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5668 break;
5669 case "--activity-previous-is-top":
5670 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5671 break;
5672 case "--activity-reorder-to-front":
5673 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5674 break;
5675 case "--activity-reset-task-if-needed":
5676 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5677 break;
5678 case "--activity-single-top":
5679 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5680 break;
5681 case "--activity-clear-task":
5682 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5683 break;
5684 case "--activity-task-on-home":
5685 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5686 break;
5687 case "--receiver-registered-only":
5688 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5689 break;
5690 case "--receiver-replace-pending":
5691 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5692 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005693 case "--receiver-foreground":
5694 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5695 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005696 case "--selector":
5697 intent.setDataAndType(data, type);
5698 intent = new Intent();
5699 break;
5700 default:
5701 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5702 // Okay, caller handled this option.
5703 } else {
5704 throw new IllegalArgumentException("Unknown option: " + opt);
5705 }
5706 break;
5707 }
5708 }
5709 intent.setDataAndType(data, type);
5710
5711 final boolean hasSelector = intent != baseIntent;
5712 if (hasSelector) {
5713 // A selector was specified; fix up.
5714 baseIntent.setSelector(intent);
5715 intent = baseIntent;
5716 }
5717
5718 String arg = cmd.getNextArg();
5719 baseIntent = null;
5720 if (arg == null) {
5721 if (hasSelector) {
5722 // If a selector has been specified, and no arguments
5723 // have been supplied for the main Intent, then we can
5724 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5725 // need to have a component name specified yet, the
5726 // selector will take care of that.
5727 baseIntent = new Intent(Intent.ACTION_MAIN);
5728 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5729 }
5730 } else if (arg.indexOf(':') >= 0) {
5731 // The argument is a URI. Fully parse it, and use that result
5732 // to fill in any data not specified so far.
5733 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5734 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5735 } else if (arg.indexOf('/') >= 0) {
5736 // The argument is a component name. Build an Intent to launch
5737 // it.
5738 baseIntent = new Intent(Intent.ACTION_MAIN);
5739 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5740 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5741 } else {
5742 // Assume the argument is a package name.
5743 baseIntent = new Intent(Intent.ACTION_MAIN);
5744 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5745 baseIntent.setPackage(arg);
5746 }
5747 if (baseIntent != null) {
5748 Bundle extras = intent.getExtras();
5749 intent.replaceExtras((Bundle)null);
5750 Bundle uriExtras = baseIntent.getExtras();
5751 baseIntent.replaceExtras((Bundle)null);
5752 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5753 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5754 for (String c : cats) {
5755 baseIntent.removeCategory(c);
5756 }
5757 }
5758 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5759 if (extras == null) {
5760 extras = uriExtras;
5761 } else if (uriExtras != null) {
5762 uriExtras.putAll(extras);
5763 extras = uriExtras;
5764 }
5765 intent.replaceExtras(extras);
5766 hasIntentInfo = true;
5767 }
5768
5769 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5770 return intent;
5771 }
5772
5773 /** @hide */
5774 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5775 final String[] lines = new String[] {
5776 "<INTENT> specifications include these flags and arguments:",
5777 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5778 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5779 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5780 " [--esn <EXTRA_KEY> ...]",
5781 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5782 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5783 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5784 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5785 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5786 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5787 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5788 " (mutiple extras passed as Integer[])",
5789 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5790 " (mutiple extras passed as List<Integer>)",
5791 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5792 " (mutiple extras passed as Long[])",
5793 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5794 " (mutiple extras passed as List<Long>)",
5795 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5796 " (mutiple extras passed as Float[])",
5797 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5798 " (mutiple extras passed as List<Float>)",
5799 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5800 " (mutiple extras passed as String[]; to embed a comma into a string,",
5801 " escape it using \"\\,\")",
5802 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5803 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5804 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005805 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005806 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5807 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5808 " [--debug-log-resolution] [--exclude-stopped-packages]",
5809 " [--include-stopped-packages]",
5810 " [--activity-brought-to-front] [--activity-clear-top]",
5811 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5812 " [--activity-launched-from-history] [--activity-multiple-task]",
5813 " [--activity-no-animation] [--activity-no-history]",
5814 " [--activity-no-user-action] [--activity-previous-is-top]",
5815 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5816 " [--activity-single-top] [--activity-clear-task]",
5817 " [--activity-task-on-home]",
5818 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005819 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005820 " [--selector]",
5821 " [<URI> | <PACKAGE> | <COMPONENT>]"
5822 };
5823 for (String line : lines) {
5824 pw.print(prefix);
5825 pw.println(line);
5826 }
5827 }
5828
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005829 /**
5830 * Retrieve the general action to be performed, such as
5831 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5832 * the information in the intent should be interpreted -- most importantly,
5833 * what to do with the data returned by {@link #getData}.
5834 *
5835 * @return The action of this intent or null if none is specified.
5836 *
5837 * @see #setAction
5838 */
5839 public String getAction() {
5840 return mAction;
5841 }
5842
5843 /**
5844 * Retrieve data this intent is operating on. This URI specifies the name
5845 * of the data; often it uses the content: scheme, specifying data in a
5846 * content provider. Other schemes may be handled by specific activities,
5847 * such as http: by the web browser.
5848 *
5849 * @return The URI of the data this intent is targeting or null.
5850 *
5851 * @see #getScheme
5852 * @see #setData
5853 */
5854 public Uri getData() {
5855 return mData;
5856 }
5857
5858 /**
5859 * The same as {@link #getData()}, but returns the URI as an encoded
5860 * String.
5861 */
5862 public String getDataString() {
5863 return mData != null ? mData.toString() : null;
5864 }
5865
5866 /**
5867 * Return the scheme portion of the intent's data. If the data is null or
5868 * does not include a scheme, null is returned. Otherwise, the scheme
5869 * prefix without the final ':' is returned, i.e. "http".
5870 *
5871 * <p>This is the same as calling getData().getScheme() (and checking for
5872 * null data).
5873 *
5874 * @return The scheme of this intent.
5875 *
5876 * @see #getData
5877 */
5878 public String getScheme() {
5879 return mData != null ? mData.getScheme() : null;
5880 }
5881
5882 /**
5883 * Retrieve any explicit MIME type included in the intent. This is usually
5884 * null, as the type is determined by the intent data.
5885 *
5886 * @return If a type was manually set, it is returned; else null is
5887 * returned.
5888 *
5889 * @see #resolveType(ContentResolver)
5890 * @see #setType
5891 */
5892 public String getType() {
5893 return mType;
5894 }
5895
5896 /**
5897 * Return the MIME data type of this intent. If the type field is
5898 * explicitly set, that is simply returned. Otherwise, if the data is set,
5899 * the type of that data is returned. If neither fields are set, a null is
5900 * returned.
5901 *
5902 * @return The MIME type of this intent.
5903 *
5904 * @see #getType
5905 * @see #resolveType(ContentResolver)
5906 */
5907 public String resolveType(Context context) {
5908 return resolveType(context.getContentResolver());
5909 }
5910
5911 /**
5912 * Return the MIME data type of this intent. If the type field is
5913 * explicitly set, that is simply returned. Otherwise, if the data is set,
5914 * the type of that data is returned. If neither fields are set, a null is
5915 * returned.
5916 *
5917 * @param resolver A ContentResolver that can be used to determine the MIME
5918 * type of the intent's data.
5919 *
5920 * @return The MIME type of this intent.
5921 *
5922 * @see #getType
5923 * @see #resolveType(Context)
5924 */
5925 public String resolveType(ContentResolver resolver) {
5926 if (mType != null) {
5927 return mType;
5928 }
5929 if (mData != null) {
5930 if ("content".equals(mData.getScheme())) {
5931 return resolver.getType(mData);
5932 }
5933 }
5934 return null;
5935 }
5936
5937 /**
5938 * Return the MIME data type of this intent, only if it will be needed for
5939 * intent resolution. This is not generally useful for application code;
5940 * it is used by the frameworks for communicating with back-end system
5941 * services.
5942 *
5943 * @param resolver A ContentResolver that can be used to determine the MIME
5944 * type of the intent's data.
5945 *
5946 * @return The MIME type of this intent, or null if it is unknown or not
5947 * needed.
5948 */
5949 public String resolveTypeIfNeeded(ContentResolver resolver) {
5950 if (mComponent != null) {
5951 return mType;
5952 }
5953 return resolveType(resolver);
5954 }
5955
5956 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005957 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005958 *
5959 * @param category The category to check.
5960 *
5961 * @return boolean True if the intent contains the category, else false.
5962 *
5963 * @see #getCategories
5964 * @see #addCategory
5965 */
5966 public boolean hasCategory(String category) {
5967 return mCategories != null && mCategories.contains(category);
5968 }
5969
5970 /**
5971 * Return the set of all categories in the intent. If there are no categories,
5972 * returns NULL.
5973 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005974 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005975 *
5976 * @see #hasCategory
5977 * @see #addCategory
5978 */
5979 public Set<String> getCategories() {
5980 return mCategories;
5981 }
5982
5983 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005984 * Return the specific selector associated with this Intent. If there is
5985 * none, returns null. See {@link #setSelector} for more information.
5986 *
5987 * @see #setSelector
5988 */
5989 public Intent getSelector() {
5990 return mSelector;
5991 }
5992
5993 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005994 * Return the {@link ClipData} associated with this Intent. If there is
5995 * none, returns null. See {@link #setClipData} for more information.
5996 *
John Spurlock125d1332013-11-25 11:58:37 -05005997 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005998 */
5999 public ClipData getClipData() {
6000 return mClipData;
6001 }
6002
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006003 /** @hide */
6004 public int getContentUserHint() {
6005 return mContentUserHint;
6006 }
6007
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006008 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006009 * Sets the ClassLoader that will be used when unmarshalling
6010 * any Parcelable values from the extras of this Intent.
6011 *
6012 * @param loader a ClassLoader, or null to use the default loader
6013 * at the time of unmarshalling.
6014 */
6015 public void setExtrasClassLoader(ClassLoader loader) {
6016 if (mExtras != null) {
6017 mExtras.setClassLoader(loader);
6018 }
6019 }
6020
6021 /**
6022 * Returns true if an extra value is associated with the given name.
6023 * @param name the extra's name
6024 * @return true if the given extra is present.
6025 */
6026 public boolean hasExtra(String name) {
6027 return mExtras != null && mExtras.containsKey(name);
6028 }
6029
6030 /**
6031 * Returns true if the Intent's extras contain a parcelled file descriptor.
6032 * @return true if the Intent contains a parcelled file descriptor.
6033 */
6034 public boolean hasFileDescriptors() {
6035 return mExtras != null && mExtras.hasFileDescriptors();
6036 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006037
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006038 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006039 public void setAllowFds(boolean allowFds) {
6040 if (mExtras != null) {
6041 mExtras.setAllowFds(allowFds);
6042 }
6043 }
6044
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006045 /** {@hide} */
6046 public void setDefusable(boolean defusable) {
6047 if (mExtras != null) {
6048 mExtras.setDefusable(defusable);
6049 }
6050 }
6051
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006052 /**
6053 * Retrieve extended data from the intent.
6054 *
6055 * @param name The name of the desired item.
6056 *
6057 * @return the value of an item that previously added with putExtra()
6058 * or null if none was found.
6059 *
6060 * @deprecated
6061 * @hide
6062 */
6063 @Deprecated
6064 public Object getExtra(String name) {
6065 return getExtra(name, null);
6066 }
6067
6068 /**
6069 * Retrieve extended data from the intent.
6070 *
6071 * @param name The name of the desired item.
6072 * @param defaultValue the value to be returned if no value of the desired
6073 * type is stored with the given name.
6074 *
6075 * @return the value of an item that previously added with putExtra()
6076 * or the default value if none was found.
6077 *
6078 * @see #putExtra(String, boolean)
6079 */
6080 public boolean getBooleanExtra(String name, boolean defaultValue) {
6081 return mExtras == null ? defaultValue :
6082 mExtras.getBoolean(name, defaultValue);
6083 }
6084
6085 /**
6086 * Retrieve extended data from the intent.
6087 *
6088 * @param name The name of the desired item.
6089 * @param defaultValue the value to be returned if no value of the desired
6090 * type is stored with the given name.
6091 *
6092 * @return the value of an item that previously added with putExtra()
6093 * or the default value if none was found.
6094 *
6095 * @see #putExtra(String, byte)
6096 */
6097 public byte getByteExtra(String name, byte defaultValue) {
6098 return mExtras == null ? defaultValue :
6099 mExtras.getByte(name, defaultValue);
6100 }
6101
6102 /**
6103 * Retrieve extended data from the intent.
6104 *
6105 * @param name The name of the desired item.
6106 * @param defaultValue the value to be returned if no value of the desired
6107 * type is stored with the given name.
6108 *
6109 * @return the value of an item that previously added with putExtra()
6110 * or the default value if none was found.
6111 *
6112 * @see #putExtra(String, short)
6113 */
6114 public short getShortExtra(String name, short defaultValue) {
6115 return mExtras == null ? defaultValue :
6116 mExtras.getShort(name, defaultValue);
6117 }
6118
6119 /**
6120 * Retrieve extended data from the intent.
6121 *
6122 * @param name The name of the desired item.
6123 * @param defaultValue the value to be returned if no value of the desired
6124 * type is stored with the given name.
6125 *
6126 * @return the value of an item that previously added with putExtra()
6127 * or the default value if none was found.
6128 *
6129 * @see #putExtra(String, char)
6130 */
6131 public char getCharExtra(String name, char defaultValue) {
6132 return mExtras == null ? defaultValue :
6133 mExtras.getChar(name, defaultValue);
6134 }
6135
6136 /**
6137 * Retrieve extended data from the intent.
6138 *
6139 * @param name The name of the desired item.
6140 * @param defaultValue the value to be returned if no value of the desired
6141 * type is stored with the given name.
6142 *
6143 * @return the value of an item that previously added with putExtra()
6144 * or the default value if none was found.
6145 *
6146 * @see #putExtra(String, int)
6147 */
6148 public int getIntExtra(String name, int defaultValue) {
6149 return mExtras == null ? defaultValue :
6150 mExtras.getInt(name, defaultValue);
6151 }
6152
6153 /**
6154 * Retrieve extended data from the intent.
6155 *
6156 * @param name The name of the desired item.
6157 * @param defaultValue the value to be returned if no value of the desired
6158 * type is stored with the given name.
6159 *
6160 * @return the value of an item that previously added with putExtra()
6161 * or the default value if none was found.
6162 *
6163 * @see #putExtra(String, long)
6164 */
6165 public long getLongExtra(String name, long defaultValue) {
6166 return mExtras == null ? defaultValue :
6167 mExtras.getLong(name, defaultValue);
6168 }
6169
6170 /**
6171 * Retrieve extended data from the intent.
6172 *
6173 * @param name The name of the desired item.
6174 * @param defaultValue the value to be returned if no value of the desired
6175 * type is stored with the given name.
6176 *
6177 * @return the value of an item that previously added with putExtra(),
6178 * or the default value if no such item is present
6179 *
6180 * @see #putExtra(String, float)
6181 */
6182 public float getFloatExtra(String name, float defaultValue) {
6183 return mExtras == null ? defaultValue :
6184 mExtras.getFloat(name, defaultValue);
6185 }
6186
6187 /**
6188 * Retrieve extended data from the intent.
6189 *
6190 * @param name The name of the desired item.
6191 * @param defaultValue the value to be returned if no value of the desired
6192 * type is stored with the given name.
6193 *
6194 * @return the value of an item that previously added with putExtra()
6195 * or the default value if none was found.
6196 *
6197 * @see #putExtra(String, double)
6198 */
6199 public double getDoubleExtra(String name, double defaultValue) {
6200 return mExtras == null ? defaultValue :
6201 mExtras.getDouble(name, defaultValue);
6202 }
6203
6204 /**
6205 * Retrieve extended data from the intent.
6206 *
6207 * @param name The name of the desired item.
6208 *
6209 * @return the value of an item that previously added with putExtra()
6210 * or null if no String value was found.
6211 *
6212 * @see #putExtra(String, String)
6213 */
6214 public String getStringExtra(String name) {
6215 return mExtras == null ? null : mExtras.getString(name);
6216 }
6217
6218 /**
6219 * Retrieve extended data from the intent.
6220 *
6221 * @param name The name of the desired item.
6222 *
6223 * @return the value of an item that previously added with putExtra()
6224 * or null if no CharSequence value was found.
6225 *
6226 * @see #putExtra(String, CharSequence)
6227 */
6228 public CharSequence getCharSequenceExtra(String name) {
6229 return mExtras == null ? null : mExtras.getCharSequence(name);
6230 }
6231
6232 /**
6233 * Retrieve extended data from the intent.
6234 *
6235 * @param name The name of the desired item.
6236 *
6237 * @return the value of an item that previously added with putExtra()
6238 * or null if no Parcelable value was found.
6239 *
6240 * @see #putExtra(String, Parcelable)
6241 */
6242 public <T extends Parcelable> T getParcelableExtra(String name) {
6243 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6244 }
6245
6246 /**
6247 * Retrieve extended data from the intent.
6248 *
6249 * @param name The name of the desired item.
6250 *
6251 * @return the value of an item that previously added with putExtra()
6252 * or null if no Parcelable[] value was found.
6253 *
6254 * @see #putExtra(String, Parcelable[])
6255 */
6256 public Parcelable[] getParcelableArrayExtra(String name) {
6257 return mExtras == null ? null : mExtras.getParcelableArray(name);
6258 }
6259
6260 /**
6261 * Retrieve extended data from the intent.
6262 *
6263 * @param name The name of the desired item.
6264 *
6265 * @return the value of an item that previously added with putExtra()
6266 * or null if no ArrayList<Parcelable> value was found.
6267 *
6268 * @see #putParcelableArrayListExtra(String, ArrayList)
6269 */
6270 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6271 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6272 }
6273
6274 /**
6275 * Retrieve extended data from the intent.
6276 *
6277 * @param name The name of the desired item.
6278 *
6279 * @return the value of an item that previously added with putExtra()
6280 * or null if no Serializable value was found.
6281 *
6282 * @see #putExtra(String, Serializable)
6283 */
6284 public Serializable getSerializableExtra(String name) {
6285 return mExtras == null ? null : mExtras.getSerializable(name);
6286 }
6287
6288 /**
6289 * Retrieve extended data from the intent.
6290 *
6291 * @param name The name of the desired item.
6292 *
6293 * @return the value of an item that previously added with putExtra()
6294 * or null if no ArrayList<Integer> value was found.
6295 *
6296 * @see #putIntegerArrayListExtra(String, ArrayList)
6297 */
6298 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6299 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6300 }
6301
6302 /**
6303 * Retrieve extended data from the intent.
6304 *
6305 * @param name The name of the desired item.
6306 *
6307 * @return the value of an item that previously added with putExtra()
6308 * or null if no ArrayList<String> value was found.
6309 *
6310 * @see #putStringArrayListExtra(String, ArrayList)
6311 */
6312 public ArrayList<String> getStringArrayListExtra(String name) {
6313 return mExtras == null ? null : mExtras.getStringArrayList(name);
6314 }
6315
6316 /**
6317 * Retrieve extended data from the intent.
6318 *
6319 * @param name The name of the desired item.
6320 *
6321 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006322 * or null if no ArrayList<CharSequence> value was found.
6323 *
6324 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6325 */
6326 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6327 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6328 }
6329
6330 /**
6331 * Retrieve extended data from the intent.
6332 *
6333 * @param name The name of the desired item.
6334 *
6335 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006336 * or null if no boolean array value was found.
6337 *
6338 * @see #putExtra(String, boolean[])
6339 */
6340 public boolean[] getBooleanArrayExtra(String name) {
6341 return mExtras == null ? null : mExtras.getBooleanArray(name);
6342 }
6343
6344 /**
6345 * Retrieve extended data from the intent.
6346 *
6347 * @param name The name of the desired item.
6348 *
6349 * @return the value of an item that previously added with putExtra()
6350 * or null if no byte array value was found.
6351 *
6352 * @see #putExtra(String, byte[])
6353 */
6354 public byte[] getByteArrayExtra(String name) {
6355 return mExtras == null ? null : mExtras.getByteArray(name);
6356 }
6357
6358 /**
6359 * Retrieve extended data from the intent.
6360 *
6361 * @param name The name of the desired item.
6362 *
6363 * @return the value of an item that previously added with putExtra()
6364 * or null if no short array value was found.
6365 *
6366 * @see #putExtra(String, short[])
6367 */
6368 public short[] getShortArrayExtra(String name) {
6369 return mExtras == null ? null : mExtras.getShortArray(name);
6370 }
6371
6372 /**
6373 * Retrieve extended data from the intent.
6374 *
6375 * @param name The name of the desired item.
6376 *
6377 * @return the value of an item that previously added with putExtra()
6378 * or null if no char array value was found.
6379 *
6380 * @see #putExtra(String, char[])
6381 */
6382 public char[] getCharArrayExtra(String name) {
6383 return mExtras == null ? null : mExtras.getCharArray(name);
6384 }
6385
6386 /**
6387 * Retrieve extended data from the intent.
6388 *
6389 * @param name The name of the desired item.
6390 *
6391 * @return the value of an item that previously added with putExtra()
6392 * or null if no int array value was found.
6393 *
6394 * @see #putExtra(String, int[])
6395 */
6396 public int[] getIntArrayExtra(String name) {
6397 return mExtras == null ? null : mExtras.getIntArray(name);
6398 }
6399
6400 /**
6401 * Retrieve extended data from the intent.
6402 *
6403 * @param name The name of the desired item.
6404 *
6405 * @return the value of an item that previously added with putExtra()
6406 * or null if no long array value was found.
6407 *
6408 * @see #putExtra(String, long[])
6409 */
6410 public long[] getLongArrayExtra(String name) {
6411 return mExtras == null ? null : mExtras.getLongArray(name);
6412 }
6413
6414 /**
6415 * Retrieve extended data from the intent.
6416 *
6417 * @param name The name of the desired item.
6418 *
6419 * @return the value of an item that previously added with putExtra()
6420 * or null if no float array value was found.
6421 *
6422 * @see #putExtra(String, float[])
6423 */
6424 public float[] getFloatArrayExtra(String name) {
6425 return mExtras == null ? null : mExtras.getFloatArray(name);
6426 }
6427
6428 /**
6429 * Retrieve extended data from the intent.
6430 *
6431 * @param name The name of the desired item.
6432 *
6433 * @return the value of an item that previously added with putExtra()
6434 * or null if no double array value was found.
6435 *
6436 * @see #putExtra(String, double[])
6437 */
6438 public double[] getDoubleArrayExtra(String name) {
6439 return mExtras == null ? null : mExtras.getDoubleArray(name);
6440 }
6441
6442 /**
6443 * Retrieve extended data from the intent.
6444 *
6445 * @param name The name of the desired item.
6446 *
6447 * @return the value of an item that previously added with putExtra()
6448 * or null if no String array value was found.
6449 *
6450 * @see #putExtra(String, String[])
6451 */
6452 public String[] getStringArrayExtra(String name) {
6453 return mExtras == null ? null : mExtras.getStringArray(name);
6454 }
6455
6456 /**
6457 * Retrieve extended data from the intent.
6458 *
6459 * @param name The name of the desired item.
6460 *
6461 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006462 * or null if no CharSequence array value was found.
6463 *
6464 * @see #putExtra(String, CharSequence[])
6465 */
6466 public CharSequence[] getCharSequenceArrayExtra(String name) {
6467 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6468 }
6469
6470 /**
6471 * Retrieve extended data from the intent.
6472 *
6473 * @param name The name of the desired item.
6474 *
6475 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006476 * or null if no Bundle value was found.
6477 *
6478 * @see #putExtra(String, Bundle)
6479 */
6480 public Bundle getBundleExtra(String name) {
6481 return mExtras == null ? null : mExtras.getBundle(name);
6482 }
6483
6484 /**
6485 * Retrieve extended data from the intent.
6486 *
6487 * @param name The name of the desired item.
6488 *
6489 * @return the value of an item that previously added with putExtra()
6490 * or null if no IBinder value was found.
6491 *
6492 * @see #putExtra(String, IBinder)
6493 *
6494 * @deprecated
6495 * @hide
6496 */
6497 @Deprecated
6498 public IBinder getIBinderExtra(String name) {
6499 return mExtras == null ? null : mExtras.getIBinder(name);
6500 }
6501
6502 /**
6503 * Retrieve extended data from the intent.
6504 *
6505 * @param name The name of the desired item.
6506 * @param defaultValue The default value to return in case no item is
6507 * associated with the key 'name'
6508 *
6509 * @return the value of an item that previously added with putExtra()
6510 * or defaultValue if none was found.
6511 *
6512 * @see #putExtra
6513 *
6514 * @deprecated
6515 * @hide
6516 */
6517 @Deprecated
6518 public Object getExtra(String name, Object defaultValue) {
6519 Object result = defaultValue;
6520 if (mExtras != null) {
6521 Object result2 = mExtras.get(name);
6522 if (result2 != null) {
6523 result = result2;
6524 }
6525 }
6526
6527 return result;
6528 }
6529
6530 /**
6531 * Retrieves a map of extended data from the intent.
6532 *
6533 * @return the map of all extras previously added with putExtra(),
6534 * or null if none have been added.
6535 */
6536 public Bundle getExtras() {
6537 return (mExtras != null)
6538 ? new Bundle(mExtras)
6539 : null;
6540 }
6541
6542 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006543 * Filter extras to only basic types.
6544 * @hide
6545 */
6546 public void removeUnsafeExtras() {
6547 if (mExtras != null) {
6548 mExtras.filterValues();
6549 }
6550 }
6551
6552 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006553 * Retrieve any special flags associated with this intent. You will
6554 * normally just set them with {@link #setFlags} and let the system
6555 * take the appropriate action with them.
6556 *
6557 * @return int The currently set flags.
6558 *
6559 * @see #setFlags
6560 */
6561 public int getFlags() {
6562 return mFlags;
6563 }
6564
Dianne Hackborne7f97212011-02-24 14:40:20 -08006565 /** @hide */
6566 public boolean isExcludingStopped() {
6567 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6568 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6569 }
6570
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006571 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006572 * Retrieve the application package name this Intent is limited to. When
6573 * resolving an Intent, if non-null this limits the resolution to only
6574 * components in the given application package.
6575 *
6576 * @return The name of the application package for the Intent.
6577 *
6578 * @see #resolveActivity
6579 * @see #setPackage
6580 */
6581 public String getPackage() {
6582 return mPackage;
6583 }
6584
6585 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006586 * Retrieve the concrete component associated with the intent. When receiving
6587 * an intent, this is the component that was found to best handle it (that is,
6588 * yourself) and will always be non-null; in all other cases it will be
6589 * null unless explicitly set.
6590 *
6591 * @return The name of the application component to handle the intent.
6592 *
6593 * @see #resolveActivity
6594 * @see #setComponent
6595 */
6596 public ComponentName getComponent() {
6597 return mComponent;
6598 }
6599
6600 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006601 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6602 * used as a hint to the receiver for animations and the like. Null means that there
6603 * is no source bounds.
6604 */
6605 public Rect getSourceBounds() {
6606 return mSourceBounds;
6607 }
6608
6609 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006610 * Return the Activity component that should be used to handle this intent.
6611 * The appropriate component is determined based on the information in the
6612 * intent, evaluated as follows:
6613 *
6614 * <p>If {@link #getComponent} returns an explicit class, that is returned
6615 * without any further consideration.
6616 *
6617 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6618 * category to be considered.
6619 *
6620 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6621 * action.
6622 *
6623 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6624 * this type.
6625 *
6626 * <p>If {@link #addCategory} has added any categories, the activity must
6627 * handle ALL of the categories specified.
6628 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006629 * <p>If {@link #getPackage} is non-NULL, only activity components in
6630 * that application package will be considered.
6631 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006632 * <p>If there are no activities that satisfy all of these conditions, a
6633 * null string is returned.
6634 *
6635 * <p>If multiple activities are found to satisfy the intent, the one with
6636 * the highest priority will be used. If there are multiple activities
6637 * with the same priority, the system will either pick the best activity
6638 * based on user preference, or resolve to a system class that will allow
6639 * the user to pick an activity and forward from there.
6640 *
6641 * <p>This method is implemented simply by calling
6642 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6643 * true.</p>
6644 * <p> This API is called for you as part of starting an activity from an
6645 * intent. You do not normally need to call it yourself.</p>
6646 *
6647 * @param pm The package manager with which to resolve the Intent.
6648 *
6649 * @return Name of the component implementing an activity that can
6650 * display the intent.
6651 *
6652 * @see #setComponent
6653 * @see #getComponent
6654 * @see #resolveActivityInfo
6655 */
6656 public ComponentName resolveActivity(PackageManager pm) {
6657 if (mComponent != null) {
6658 return mComponent;
6659 }
6660
6661 ResolveInfo info = pm.resolveActivity(
6662 this, PackageManager.MATCH_DEFAULT_ONLY);
6663 if (info != null) {
6664 return new ComponentName(
6665 info.activityInfo.applicationInfo.packageName,
6666 info.activityInfo.name);
6667 }
6668
6669 return null;
6670 }
6671
6672 /**
6673 * Resolve the Intent into an {@link ActivityInfo}
6674 * describing the activity that should execute the intent. Resolution
6675 * follows the same rules as described for {@link #resolveActivity}, but
6676 * you get back the completely information about the resolved activity
6677 * instead of just its class name.
6678 *
6679 * @param pm The package manager with which to resolve the Intent.
6680 * @param flags Addition information to retrieve as per
6681 * {@link PackageManager#getActivityInfo(ComponentName, int)
6682 * PackageManager.getActivityInfo()}.
6683 *
6684 * @return PackageManager.ActivityInfo
6685 *
6686 * @see #resolveActivity
6687 */
6688 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6689 ActivityInfo ai = null;
6690 if (mComponent != null) {
6691 try {
6692 ai = pm.getActivityInfo(mComponent, flags);
6693 } catch (PackageManager.NameNotFoundException e) {
6694 // ignore
6695 }
6696 } else {
6697 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006698 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006699 if (info != null) {
6700 ai = info.activityInfo;
6701 }
6702 }
6703
6704 return ai;
6705 }
6706
6707 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006708 * Special function for use by the system to resolve service
6709 * intents to system apps. Throws an exception if there are
6710 * multiple potential matches to the Intent. Returns null if
6711 * there are no matches.
6712 * @hide
6713 */
6714 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6715 if (mComponent != null) {
6716 return mComponent;
6717 }
6718
6719 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6720 if (results == null) {
6721 return null;
6722 }
6723 ComponentName comp = null;
6724 for (int i=0; i<results.size(); i++) {
6725 ResolveInfo ri = results.get(i);
6726 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6727 continue;
6728 }
6729 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6730 ri.serviceInfo.name);
6731 if (comp != null) {
6732 throw new IllegalStateException("Multiple system services handle " + this
6733 + ": " + comp + ", " + foundComp);
6734 }
6735 comp = foundComp;
6736 }
6737 return comp;
6738 }
6739
6740 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006741 * Set the general action to be performed.
6742 *
6743 * @param action An action name, such as ACTION_VIEW. Application-specific
6744 * actions should be prefixed with the vendor's package name.
6745 *
6746 * @return Returns the same Intent object, for chaining multiple calls
6747 * into a single statement.
6748 *
6749 * @see #getAction
6750 */
6751 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006752 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006753 return this;
6754 }
6755
6756 /**
6757 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006758 * clears any type that was previously set by {@link #setType} or
6759 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006760 *
Nick Pellyccae4122012-01-09 14:12:58 -08006761 * <p><em>Note: scheme matching in the Android framework is
6762 * case-sensitive, unlike the formal RFC. As a result,
6763 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006764 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006765 * {@link #setDataAndNormalize}
6766 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006767 *
Nick Pellyccae4122012-01-09 14:12:58 -08006768 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006769 *
6770 * @return Returns the same Intent object, for chaining multiple calls
6771 * into a single statement.
6772 *
6773 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006774 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006775 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006776 */
6777 public Intent setData(Uri data) {
6778 mData = data;
6779 mType = null;
6780 return this;
6781 }
6782
6783 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006784 * Normalize and set the data this intent is operating on.
6785 *
6786 * <p>This method automatically clears any type that was
6787 * previously set (for example, by {@link #setType}).
6788 *
6789 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006790 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006791 * so really this is just a convenience method for
6792 * <pre>
6793 * setData(data.normalize())
6794 * </pre>
6795 *
6796 * @param data The Uri of the data this intent is now targeting.
6797 *
6798 * @return Returns the same Intent object, for chaining multiple calls
6799 * into a single statement.
6800 *
6801 * @see #getData
6802 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006803 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006804 */
6805 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006806 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006807 }
6808
6809 /**
6810 * Set an explicit MIME data type.
6811 *
6812 * <p>This is used to create intents that only specify a type and not data,
6813 * for example to indicate the type of data to return.
6814 *
6815 * <p>This method automatically clears any data that was
6816 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006817 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006818 * <p><em>Note: MIME type matching in the Android framework is
6819 * case-sensitive, unlike formal RFC MIME types. As a result,
6820 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006821 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6822 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006823 *
6824 * @param type The MIME type of the data being handled by this intent.
6825 *
6826 * @return Returns the same Intent object, for chaining multiple calls
6827 * into a single statement.
6828 *
6829 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006830 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006831 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006832 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006833 */
6834 public Intent setType(String type) {
6835 mData = null;
6836 mType = type;
6837 return this;
6838 }
6839
6840 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006841 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006842 *
Nick Pellyccae4122012-01-09 14:12:58 -08006843 * <p>This is used to create intents that only specify a type and not data,
6844 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006845 *
Nick Pellyccae4122012-01-09 14:12:58 -08006846 * <p>This method automatically clears any data that was
6847 * previously set (for example by {@link #setData}).
6848 *
6849 * <p>The MIME type is normalized using
6850 * {@link #normalizeMimeType} before it is set,
6851 * so really this is just a convenience method for
6852 * <pre>
6853 * setType(Intent.normalizeMimeType(type))
6854 * </pre>
6855 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006856 * @param type The MIME type of the data being handled by this intent.
6857 *
6858 * @return Returns the same Intent object, for chaining multiple calls
6859 * into a single statement.
6860 *
Nick Pellyccae4122012-01-09 14:12:58 -08006861 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006862 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006863 * @see #normalizeMimeType
6864 */
6865 public Intent setTypeAndNormalize(String type) {
6866 return setType(normalizeMimeType(type));
6867 }
6868
6869 /**
6870 * (Usually optional) Set the data for the intent along with an explicit
6871 * MIME data type. This method should very rarely be used -- it allows you
6872 * to override the MIME type that would ordinarily be inferred from the
6873 * data with your own type given here.
6874 *
6875 * <p><em>Note: MIME type and Uri scheme matching in the
6876 * Android framework is case-sensitive, unlike the formal RFC definitions.
6877 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006878 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006879 * {@link #setDataAndTypeAndNormalize}
6880 * to ensure that they are converted to lower case.</em>
6881 *
6882 * @param data The Uri of the data this intent is now targeting.
6883 * @param type The MIME type of the data being handled by this intent.
6884 *
6885 * @return Returns the same Intent object, for chaining multiple calls
6886 * into a single statement.
6887 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006888 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006889 * @see #setData
6890 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006891 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006892 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006893 */
6894 public Intent setDataAndType(Uri data, String type) {
6895 mData = data;
6896 mType = type;
6897 return this;
6898 }
6899
6900 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006901 * (Usually optional) Normalize and set both the data Uri and an explicit
6902 * MIME data type. This method should very rarely be used -- it allows you
6903 * to override the MIME type that would ordinarily be inferred from the
6904 * data with your own type given here.
6905 *
6906 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006907 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006908 * before they are set, so really this is just a convenience method for
6909 * <pre>
6910 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6911 * </pre>
6912 *
6913 * @param data The Uri of the data this intent is now targeting.
6914 * @param type The MIME type of the data being handled by this intent.
6915 *
6916 * @return Returns the same Intent object, for chaining multiple calls
6917 * into a single statement.
6918 *
6919 * @see #setType
6920 * @see #setData
6921 * @see #setDataAndType
6922 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006923 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006924 */
6925 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006926 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006927 }
6928
6929 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006930 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006931 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006932 * activities that provide <em>all</em> of the requested categories will be
6933 * used.
6934 *
6935 * @param category The desired category. This can be either one of the
6936 * predefined Intent categories, or a custom category in your own
6937 * namespace.
6938 *
6939 * @return Returns the same Intent object, for chaining multiple calls
6940 * into a single statement.
6941 *
6942 * @see #hasCategory
6943 * @see #removeCategory
6944 */
6945 public Intent addCategory(String category) {
6946 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006947 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006948 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006949 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006950 return this;
6951 }
6952
6953 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006954 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006955 *
6956 * @param category The category to remove.
6957 *
6958 * @see #addCategory
6959 */
6960 public void removeCategory(String category) {
6961 if (mCategories != null) {
6962 mCategories.remove(category);
6963 if (mCategories.size() == 0) {
6964 mCategories = null;
6965 }
6966 }
6967 }
6968
6969 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006970 * Set a selector for this Intent. This is a modification to the kinds of
6971 * things the Intent will match. If the selector is set, it will be used
6972 * when trying to find entities that can handle the Intent, instead of the
6973 * main contents of the Intent. This allows you build an Intent containing
6974 * a generic protocol while targeting it more specifically.
6975 *
6976 * <p>An example of where this may be used is with things like
6977 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6978 * Intent that will launch the Browser application. However, the correct
6979 * main entry point of an application is actually {@link #ACTION_MAIN}
6980 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6981 * used to specify the actual Activity to launch. If you launch the browser
6982 * with something different, undesired behavior may happen if the user has
6983 * previously or later launches it the normal way, since they do not match.
6984 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6985 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6986 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6987 *
6988 * <p>Setting a selector does not impact the behavior of
6989 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6990 * desired behavior of a selector -- it does not impact the base meaning
6991 * of the Intent, just what kinds of things will be matched against it
6992 * when determining who can handle it.</p>
6993 *
6994 * <p>You can not use both a selector and {@link #setPackage(String)} on
6995 * the same base Intent.</p>
6996 *
6997 * @param selector The desired selector Intent; set to null to not use
6998 * a special selector.
6999 */
7000 public void setSelector(Intent selector) {
7001 if (selector == this) {
7002 throw new IllegalArgumentException(
7003 "Intent being set as a selector of itself");
7004 }
7005 if (selector != null && mPackage != null) {
7006 throw new IllegalArgumentException(
7007 "Can't set selector when package name is already set");
7008 }
7009 mSelector = selector;
7010 }
7011
7012 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007013 * Set a {@link ClipData} associated with this Intent. This replaces any
7014 * previously set ClipData.
7015 *
7016 * <p>The ClipData in an intent is not used for Intent matching or other
7017 * such operations. Semantically it is like extras, used to transmit
7018 * additional data with the Intent. The main feature of using this over
7019 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7020 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7021 * items included in the clip data. This is useful, in particular, if
7022 * you want to transmit an Intent containing multiple <code>content:</code>
7023 * URIs for which the recipient may not have global permission to access the
7024 * content provider.
7025 *
7026 * <p>If the ClipData contains items that are themselves Intents, any
7027 * grant flags in those Intents will be ignored. Only the top-level flags
7028 * of the main Intent are respected, and will be applied to all Uri or
7029 * Intent items in the clip (or sub-items of the clip).
7030 *
7031 * <p>The MIME type, label, and icon in the ClipData object are not
7032 * directly used by Intent. Applications should generally rely on the
7033 * MIME type of the Intent itself, not what it may find in the ClipData.
7034 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007035 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007036 *
7037 * @param clip The new clip to set. May be null to clear the current clip.
7038 */
7039 public void setClipData(ClipData clip) {
7040 mClipData = clip;
7041 }
7042
7043 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007044 * This is NOT a secure mechanism to identify the user who sent the intent.
7045 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7046 * who sent the intent.
7047 * @hide
7048 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007049 public void prepareToLeaveUser(int userId) {
7050 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7051 // We want mContentUserHint to refer to the original user, so don't do anything.
7052 if (mContentUserHint == UserHandle.USER_CURRENT) {
7053 mContentUserHint = userId;
7054 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007055 }
7056
7057 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007058 * Add extended data to the intent. The name must include a package
7059 * prefix, for example the app com.android.contacts would use names
7060 * like "com.android.contacts.ShowAll".
7061 *
7062 * @param name The name of the extra data, with package prefix.
7063 * @param value The boolean data value.
7064 *
7065 * @return Returns the same Intent object, for chaining multiple calls
7066 * into a single statement.
7067 *
7068 * @see #putExtras
7069 * @see #removeExtra
7070 * @see #getBooleanExtra(String, boolean)
7071 */
7072 public Intent putExtra(String name, boolean value) {
7073 if (mExtras == null) {
7074 mExtras = new Bundle();
7075 }
7076 mExtras.putBoolean(name, value);
7077 return this;
7078 }
7079
7080 /**
7081 * Add extended data to the intent. The name must include a package
7082 * prefix, for example the app com.android.contacts would use names
7083 * like "com.android.contacts.ShowAll".
7084 *
7085 * @param name The name of the extra data, with package prefix.
7086 * @param value The byte data value.
7087 *
7088 * @return Returns the same Intent object, for chaining multiple calls
7089 * into a single statement.
7090 *
7091 * @see #putExtras
7092 * @see #removeExtra
7093 * @see #getByteExtra(String, byte)
7094 */
7095 public Intent putExtra(String name, byte value) {
7096 if (mExtras == null) {
7097 mExtras = new Bundle();
7098 }
7099 mExtras.putByte(name, value);
7100 return this;
7101 }
7102
7103 /**
7104 * Add extended data to the intent. The name must include a package
7105 * prefix, for example the app com.android.contacts would use names
7106 * like "com.android.contacts.ShowAll".
7107 *
7108 * @param name The name of the extra data, with package prefix.
7109 * @param value The char data value.
7110 *
7111 * @return Returns the same Intent object, for chaining multiple calls
7112 * into a single statement.
7113 *
7114 * @see #putExtras
7115 * @see #removeExtra
7116 * @see #getCharExtra(String, char)
7117 */
7118 public Intent putExtra(String name, char value) {
7119 if (mExtras == null) {
7120 mExtras = new Bundle();
7121 }
7122 mExtras.putChar(name, value);
7123 return this;
7124 }
7125
7126 /**
7127 * Add extended data to the intent. The name must include a package
7128 * prefix, for example the app com.android.contacts would use names
7129 * like "com.android.contacts.ShowAll".
7130 *
7131 * @param name The name of the extra data, with package prefix.
7132 * @param value The short data value.
7133 *
7134 * @return Returns the same Intent object, for chaining multiple calls
7135 * into a single statement.
7136 *
7137 * @see #putExtras
7138 * @see #removeExtra
7139 * @see #getShortExtra(String, short)
7140 */
7141 public Intent putExtra(String name, short value) {
7142 if (mExtras == null) {
7143 mExtras = new Bundle();
7144 }
7145 mExtras.putShort(name, value);
7146 return this;
7147 }
7148
7149 /**
7150 * Add extended data to the intent. The name must include a package
7151 * prefix, for example the app com.android.contacts would use names
7152 * like "com.android.contacts.ShowAll".
7153 *
7154 * @param name The name of the extra data, with package prefix.
7155 * @param value The integer data value.
7156 *
7157 * @return Returns the same Intent object, for chaining multiple calls
7158 * into a single statement.
7159 *
7160 * @see #putExtras
7161 * @see #removeExtra
7162 * @see #getIntExtra(String, int)
7163 */
7164 public Intent putExtra(String name, int value) {
7165 if (mExtras == null) {
7166 mExtras = new Bundle();
7167 }
7168 mExtras.putInt(name, value);
7169 return this;
7170 }
7171
7172 /**
7173 * Add extended data to the intent. The name must include a package
7174 * prefix, for example the app com.android.contacts would use names
7175 * like "com.android.contacts.ShowAll".
7176 *
7177 * @param name The name of the extra data, with package prefix.
7178 * @param value The long data value.
7179 *
7180 * @return Returns the same Intent object, for chaining multiple calls
7181 * into a single statement.
7182 *
7183 * @see #putExtras
7184 * @see #removeExtra
7185 * @see #getLongExtra(String, long)
7186 */
7187 public Intent putExtra(String name, long value) {
7188 if (mExtras == null) {
7189 mExtras = new Bundle();
7190 }
7191 mExtras.putLong(name, value);
7192 return this;
7193 }
7194
7195 /**
7196 * Add extended data to the intent. The name must include a package
7197 * prefix, for example the app com.android.contacts would use names
7198 * like "com.android.contacts.ShowAll".
7199 *
7200 * @param name The name of the extra data, with package prefix.
7201 * @param value The float data value.
7202 *
7203 * @return Returns the same Intent object, for chaining multiple calls
7204 * into a single statement.
7205 *
7206 * @see #putExtras
7207 * @see #removeExtra
7208 * @see #getFloatExtra(String, float)
7209 */
7210 public Intent putExtra(String name, float value) {
7211 if (mExtras == null) {
7212 mExtras = new Bundle();
7213 }
7214 mExtras.putFloat(name, value);
7215 return this;
7216 }
7217
7218 /**
7219 * Add extended data to the intent. The name must include a package
7220 * prefix, for example the app com.android.contacts would use names
7221 * like "com.android.contacts.ShowAll".
7222 *
7223 * @param name The name of the extra data, with package prefix.
7224 * @param value The double data value.
7225 *
7226 * @return Returns the same Intent object, for chaining multiple calls
7227 * into a single statement.
7228 *
7229 * @see #putExtras
7230 * @see #removeExtra
7231 * @see #getDoubleExtra(String, double)
7232 */
7233 public Intent putExtra(String name, double value) {
7234 if (mExtras == null) {
7235 mExtras = new Bundle();
7236 }
7237 mExtras.putDouble(name, value);
7238 return this;
7239 }
7240
7241 /**
7242 * Add extended data to the intent. The name must include a package
7243 * prefix, for example the app com.android.contacts would use names
7244 * like "com.android.contacts.ShowAll".
7245 *
7246 * @param name The name of the extra data, with package prefix.
7247 * @param value The String data value.
7248 *
7249 * @return Returns the same Intent object, for chaining multiple calls
7250 * into a single statement.
7251 *
7252 * @see #putExtras
7253 * @see #removeExtra
7254 * @see #getStringExtra(String)
7255 */
7256 public Intent putExtra(String name, String value) {
7257 if (mExtras == null) {
7258 mExtras = new Bundle();
7259 }
7260 mExtras.putString(name, value);
7261 return this;
7262 }
7263
7264 /**
7265 * Add extended data to the intent. The name must include a package
7266 * prefix, for example the app com.android.contacts would use names
7267 * like "com.android.contacts.ShowAll".
7268 *
7269 * @param name The name of the extra data, with package prefix.
7270 * @param value The CharSequence data value.
7271 *
7272 * @return Returns the same Intent object, for chaining multiple calls
7273 * into a single statement.
7274 *
7275 * @see #putExtras
7276 * @see #removeExtra
7277 * @see #getCharSequenceExtra(String)
7278 */
7279 public Intent putExtra(String name, CharSequence value) {
7280 if (mExtras == null) {
7281 mExtras = new Bundle();
7282 }
7283 mExtras.putCharSequence(name, value);
7284 return this;
7285 }
7286
7287 /**
7288 * Add extended data to the intent. The name must include a package
7289 * prefix, for example the app com.android.contacts would use names
7290 * like "com.android.contacts.ShowAll".
7291 *
7292 * @param name The name of the extra data, with package prefix.
7293 * @param value The Parcelable data value.
7294 *
7295 * @return Returns the same Intent object, for chaining multiple calls
7296 * into a single statement.
7297 *
7298 * @see #putExtras
7299 * @see #removeExtra
7300 * @see #getParcelableExtra(String)
7301 */
7302 public Intent putExtra(String name, Parcelable value) {
7303 if (mExtras == null) {
7304 mExtras = new Bundle();
7305 }
7306 mExtras.putParcelable(name, value);
7307 return this;
7308 }
7309
7310 /**
7311 * Add extended data to the intent. The name must include a package
7312 * prefix, for example the app com.android.contacts would use names
7313 * like "com.android.contacts.ShowAll".
7314 *
7315 * @param name The name of the extra data, with package prefix.
7316 * @param value The Parcelable[] data value.
7317 *
7318 * @return Returns the same Intent object, for chaining multiple calls
7319 * into a single statement.
7320 *
7321 * @see #putExtras
7322 * @see #removeExtra
7323 * @see #getParcelableArrayExtra(String)
7324 */
7325 public Intent putExtra(String name, Parcelable[] value) {
7326 if (mExtras == null) {
7327 mExtras = new Bundle();
7328 }
7329 mExtras.putParcelableArray(name, value);
7330 return this;
7331 }
7332
7333 /**
7334 * Add extended data to the intent. The name must include a package
7335 * prefix, for example the app com.android.contacts would use names
7336 * like "com.android.contacts.ShowAll".
7337 *
7338 * @param name The name of the extra data, with package prefix.
7339 * @param value The ArrayList<Parcelable> data value.
7340 *
7341 * @return Returns the same Intent object, for chaining multiple calls
7342 * into a single statement.
7343 *
7344 * @see #putExtras
7345 * @see #removeExtra
7346 * @see #getParcelableArrayListExtra(String)
7347 */
7348 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7349 if (mExtras == null) {
7350 mExtras = new Bundle();
7351 }
7352 mExtras.putParcelableArrayList(name, value);
7353 return this;
7354 }
7355
7356 /**
7357 * Add extended data to the intent. The name must include a package
7358 * prefix, for example the app com.android.contacts would use names
7359 * like "com.android.contacts.ShowAll".
7360 *
7361 * @param name The name of the extra data, with package prefix.
7362 * @param value The ArrayList<Integer> data value.
7363 *
7364 * @return Returns the same Intent object, for chaining multiple calls
7365 * into a single statement.
7366 *
7367 * @see #putExtras
7368 * @see #removeExtra
7369 * @see #getIntegerArrayListExtra(String)
7370 */
7371 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7372 if (mExtras == null) {
7373 mExtras = new Bundle();
7374 }
7375 mExtras.putIntegerArrayList(name, value);
7376 return this;
7377 }
7378
7379 /**
7380 * Add extended data to the intent. The name must include a package
7381 * prefix, for example the app com.android.contacts would use names
7382 * like "com.android.contacts.ShowAll".
7383 *
7384 * @param name The name of the extra data, with package prefix.
7385 * @param value The ArrayList<String> data value.
7386 *
7387 * @return Returns the same Intent object, for chaining multiple calls
7388 * into a single statement.
7389 *
7390 * @see #putExtras
7391 * @see #removeExtra
7392 * @see #getStringArrayListExtra(String)
7393 */
7394 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7395 if (mExtras == null) {
7396 mExtras = new Bundle();
7397 }
7398 mExtras.putStringArrayList(name, value);
7399 return this;
7400 }
7401
7402 /**
7403 * Add extended data to the intent. The name must include a package
7404 * prefix, for example the app com.android.contacts would use names
7405 * like "com.android.contacts.ShowAll".
7406 *
7407 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007408 * @param value The ArrayList<CharSequence> data value.
7409 *
7410 * @return Returns the same Intent object, for chaining multiple calls
7411 * into a single statement.
7412 *
7413 * @see #putExtras
7414 * @see #removeExtra
7415 * @see #getCharSequenceArrayListExtra(String)
7416 */
7417 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7418 if (mExtras == null) {
7419 mExtras = new Bundle();
7420 }
7421 mExtras.putCharSequenceArrayList(name, value);
7422 return this;
7423 }
7424
7425 /**
7426 * Add extended data to the intent. The name must include a package
7427 * prefix, for example the app com.android.contacts would use names
7428 * like "com.android.contacts.ShowAll".
7429 *
7430 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007431 * @param value The Serializable data value.
7432 *
7433 * @return Returns the same Intent object, for chaining multiple calls
7434 * into a single statement.
7435 *
7436 * @see #putExtras
7437 * @see #removeExtra
7438 * @see #getSerializableExtra(String)
7439 */
7440 public Intent putExtra(String name, Serializable value) {
7441 if (mExtras == null) {
7442 mExtras = new Bundle();
7443 }
7444 mExtras.putSerializable(name, value);
7445 return this;
7446 }
7447
7448 /**
7449 * Add extended data to the intent. The name must include a package
7450 * prefix, for example the app com.android.contacts would use names
7451 * like "com.android.contacts.ShowAll".
7452 *
7453 * @param name The name of the extra data, with package prefix.
7454 * @param value The boolean array data value.
7455 *
7456 * @return Returns the same Intent object, for chaining multiple calls
7457 * into a single statement.
7458 *
7459 * @see #putExtras
7460 * @see #removeExtra
7461 * @see #getBooleanArrayExtra(String)
7462 */
7463 public Intent putExtra(String name, boolean[] value) {
7464 if (mExtras == null) {
7465 mExtras = new Bundle();
7466 }
7467 mExtras.putBooleanArray(name, value);
7468 return this;
7469 }
7470
7471 /**
7472 * Add extended data to the intent. The name must include a package
7473 * prefix, for example the app com.android.contacts would use names
7474 * like "com.android.contacts.ShowAll".
7475 *
7476 * @param name The name of the extra data, with package prefix.
7477 * @param value The byte array data value.
7478 *
7479 * @return Returns the same Intent object, for chaining multiple calls
7480 * into a single statement.
7481 *
7482 * @see #putExtras
7483 * @see #removeExtra
7484 * @see #getByteArrayExtra(String)
7485 */
7486 public Intent putExtra(String name, byte[] value) {
7487 if (mExtras == null) {
7488 mExtras = new Bundle();
7489 }
7490 mExtras.putByteArray(name, value);
7491 return this;
7492 }
7493
7494 /**
7495 * Add extended data to the intent. The name must include a package
7496 * prefix, for example the app com.android.contacts would use names
7497 * like "com.android.contacts.ShowAll".
7498 *
7499 * @param name The name of the extra data, with package prefix.
7500 * @param value The short array data value.
7501 *
7502 * @return Returns the same Intent object, for chaining multiple calls
7503 * into a single statement.
7504 *
7505 * @see #putExtras
7506 * @see #removeExtra
7507 * @see #getShortArrayExtra(String)
7508 */
7509 public Intent putExtra(String name, short[] value) {
7510 if (mExtras == null) {
7511 mExtras = new Bundle();
7512 }
7513 mExtras.putShortArray(name, value);
7514 return this;
7515 }
7516
7517 /**
7518 * Add extended data to the intent. The name must include a package
7519 * prefix, for example the app com.android.contacts would use names
7520 * like "com.android.contacts.ShowAll".
7521 *
7522 * @param name The name of the extra data, with package prefix.
7523 * @param value The char array data value.
7524 *
7525 * @return Returns the same Intent object, for chaining multiple calls
7526 * into a single statement.
7527 *
7528 * @see #putExtras
7529 * @see #removeExtra
7530 * @see #getCharArrayExtra(String)
7531 */
7532 public Intent putExtra(String name, char[] value) {
7533 if (mExtras == null) {
7534 mExtras = new Bundle();
7535 }
7536 mExtras.putCharArray(name, value);
7537 return this;
7538 }
7539
7540 /**
7541 * Add extended data to the intent. The name must include a package
7542 * prefix, for example the app com.android.contacts would use names
7543 * like "com.android.contacts.ShowAll".
7544 *
7545 * @param name The name of the extra data, with package prefix.
7546 * @param value The int array data value.
7547 *
7548 * @return Returns the same Intent object, for chaining multiple calls
7549 * into a single statement.
7550 *
7551 * @see #putExtras
7552 * @see #removeExtra
7553 * @see #getIntArrayExtra(String)
7554 */
7555 public Intent putExtra(String name, int[] value) {
7556 if (mExtras == null) {
7557 mExtras = new Bundle();
7558 }
7559 mExtras.putIntArray(name, value);
7560 return this;
7561 }
7562
7563 /**
7564 * Add extended data to the intent. The name must include a package
7565 * prefix, for example the app com.android.contacts would use names
7566 * like "com.android.contacts.ShowAll".
7567 *
7568 * @param name The name of the extra data, with package prefix.
7569 * @param value The byte array data value.
7570 *
7571 * @return Returns the same Intent object, for chaining multiple calls
7572 * into a single statement.
7573 *
7574 * @see #putExtras
7575 * @see #removeExtra
7576 * @see #getLongArrayExtra(String)
7577 */
7578 public Intent putExtra(String name, long[] value) {
7579 if (mExtras == null) {
7580 mExtras = new Bundle();
7581 }
7582 mExtras.putLongArray(name, value);
7583 return this;
7584 }
7585
7586 /**
7587 * Add extended data to the intent. The name must include a package
7588 * prefix, for example the app com.android.contacts would use names
7589 * like "com.android.contacts.ShowAll".
7590 *
7591 * @param name The name of the extra data, with package prefix.
7592 * @param value The float array data value.
7593 *
7594 * @return Returns the same Intent object, for chaining multiple calls
7595 * into a single statement.
7596 *
7597 * @see #putExtras
7598 * @see #removeExtra
7599 * @see #getFloatArrayExtra(String)
7600 */
7601 public Intent putExtra(String name, float[] value) {
7602 if (mExtras == null) {
7603 mExtras = new Bundle();
7604 }
7605 mExtras.putFloatArray(name, value);
7606 return this;
7607 }
7608
7609 /**
7610 * Add extended data to the intent. The name must include a package
7611 * prefix, for example the app com.android.contacts would use names
7612 * like "com.android.contacts.ShowAll".
7613 *
7614 * @param name The name of the extra data, with package prefix.
7615 * @param value The double array data value.
7616 *
7617 * @return Returns the same Intent object, for chaining multiple calls
7618 * into a single statement.
7619 *
7620 * @see #putExtras
7621 * @see #removeExtra
7622 * @see #getDoubleArrayExtra(String)
7623 */
7624 public Intent putExtra(String name, double[] value) {
7625 if (mExtras == null) {
7626 mExtras = new Bundle();
7627 }
7628 mExtras.putDoubleArray(name, value);
7629 return this;
7630 }
7631
7632 /**
7633 * Add extended data to the intent. The name must include a package
7634 * prefix, for example the app com.android.contacts would use names
7635 * like "com.android.contacts.ShowAll".
7636 *
7637 * @param name The name of the extra data, with package prefix.
7638 * @param value The String array data value.
7639 *
7640 * @return Returns the same Intent object, for chaining multiple calls
7641 * into a single statement.
7642 *
7643 * @see #putExtras
7644 * @see #removeExtra
7645 * @see #getStringArrayExtra(String)
7646 */
7647 public Intent putExtra(String name, String[] value) {
7648 if (mExtras == null) {
7649 mExtras = new Bundle();
7650 }
7651 mExtras.putStringArray(name, value);
7652 return this;
7653 }
7654
7655 /**
7656 * Add extended data to the intent. The name must include a package
7657 * prefix, for example the app com.android.contacts would use names
7658 * like "com.android.contacts.ShowAll".
7659 *
7660 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007661 * @param value The CharSequence array data value.
7662 *
7663 * @return Returns the same Intent object, for chaining multiple calls
7664 * into a single statement.
7665 *
7666 * @see #putExtras
7667 * @see #removeExtra
7668 * @see #getCharSequenceArrayExtra(String)
7669 */
7670 public Intent putExtra(String name, CharSequence[] value) {
7671 if (mExtras == null) {
7672 mExtras = new Bundle();
7673 }
7674 mExtras.putCharSequenceArray(name, value);
7675 return this;
7676 }
7677
7678 /**
7679 * Add extended data to the intent. The name must include a package
7680 * prefix, for example the app com.android.contacts would use names
7681 * like "com.android.contacts.ShowAll".
7682 *
7683 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007684 * @param value The Bundle data value.
7685 *
7686 * @return Returns the same Intent object, for chaining multiple calls
7687 * into a single statement.
7688 *
7689 * @see #putExtras
7690 * @see #removeExtra
7691 * @see #getBundleExtra(String)
7692 */
7693 public Intent putExtra(String name, Bundle value) {
7694 if (mExtras == null) {
7695 mExtras = new Bundle();
7696 }
7697 mExtras.putBundle(name, value);
7698 return this;
7699 }
7700
7701 /**
7702 * Add extended data to the intent. The name must include a package
7703 * prefix, for example the app com.android.contacts would use names
7704 * like "com.android.contacts.ShowAll".
7705 *
7706 * @param name The name of the extra data, with package prefix.
7707 * @param value The IBinder data value.
7708 *
7709 * @return Returns the same Intent object, for chaining multiple calls
7710 * into a single statement.
7711 *
7712 * @see #putExtras
7713 * @see #removeExtra
7714 * @see #getIBinderExtra(String)
7715 *
7716 * @deprecated
7717 * @hide
7718 */
7719 @Deprecated
7720 public Intent putExtra(String name, IBinder value) {
7721 if (mExtras == null) {
7722 mExtras = new Bundle();
7723 }
7724 mExtras.putIBinder(name, value);
7725 return this;
7726 }
7727
7728 /**
7729 * Copy all extras in 'src' in to this intent.
7730 *
7731 * @param src Contains the extras to copy.
7732 *
7733 * @see #putExtra
7734 */
7735 public Intent putExtras(Intent src) {
7736 if (src.mExtras != null) {
7737 if (mExtras == null) {
7738 mExtras = new Bundle(src.mExtras);
7739 } else {
7740 mExtras.putAll(src.mExtras);
7741 }
7742 }
7743 return this;
7744 }
7745
7746 /**
7747 * Add a set of extended data to the intent. The keys must include a package
7748 * prefix, for example the app com.android.contacts would use names
7749 * like "com.android.contacts.ShowAll".
7750 *
7751 * @param extras The Bundle of extras to add to this intent.
7752 *
7753 * @see #putExtra
7754 * @see #removeExtra
7755 */
7756 public Intent putExtras(Bundle extras) {
7757 if (mExtras == null) {
7758 mExtras = new Bundle();
7759 }
7760 mExtras.putAll(extras);
7761 return this;
7762 }
7763
7764 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007765 * Completely replace the extras in the Intent with the extras in the
7766 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007767 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007768 * @param src The exact extras contained in this Intent are copied
7769 * into the target intent, replacing any that were previously there.
7770 */
7771 public Intent replaceExtras(Intent src) {
7772 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7773 return this;
7774 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007775
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007776 /**
7777 * Completely replace the extras in the Intent with the given Bundle of
7778 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007779 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007780 * @param extras The new set of extras in the Intent, or null to erase
7781 * all extras.
7782 */
7783 public Intent replaceExtras(Bundle extras) {
7784 mExtras = extras != null ? new Bundle(extras) : null;
7785 return this;
7786 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007787
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007788 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007789 * Remove extended data from the intent.
7790 *
7791 * @see #putExtra
7792 */
7793 public void removeExtra(String name) {
7794 if (mExtras != null) {
7795 mExtras.remove(name);
7796 if (mExtras.size() == 0) {
7797 mExtras = null;
7798 }
7799 }
7800 }
7801
7802 /**
7803 * Set special flags controlling how this intent is handled. Most values
7804 * here depend on the type of component being executed by the Intent,
7805 * specifically the FLAG_ACTIVITY_* flags are all for use with
7806 * {@link Context#startActivity Context.startActivity()} and the
7807 * FLAG_RECEIVER_* flags are all for use with
7808 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7809 *
Scott Main7aee61f2011-02-08 11:25:01 -08007810 * <p>See the
7811 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7812 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007813 * the behavior of your application.
7814 *
7815 * @param flags The desired flags.
7816 *
7817 * @return Returns the same Intent object, for chaining multiple calls
7818 * into a single statement.
7819 *
7820 * @see #getFlags
7821 * @see #addFlags
7822 *
7823 * @see #FLAG_GRANT_READ_URI_PERMISSION
7824 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007825 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7826 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007827 * @see #FLAG_DEBUG_LOG_RESOLUTION
7828 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007829 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007830 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007831 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007832 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007833 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7834 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007835 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007836 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007837 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007838 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007839 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007840 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007841 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007842 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7843 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007844 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007845 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007846 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007847 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7848 */
7849 public Intent setFlags(int flags) {
7850 mFlags = flags;
7851 return this;
7852 }
7853
7854 /**
7855 * Add additional flags to the intent (or with existing flags
7856 * value).
7857 *
7858 * @param flags The new flags to set.
7859 *
7860 * @return Returns the same Intent object, for chaining multiple calls
7861 * into a single statement.
7862 *
7863 * @see #setFlags
7864 */
7865 public Intent addFlags(int flags) {
7866 mFlags |= flags;
7867 return this;
7868 }
7869
7870 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007871 * (Usually optional) Set an explicit application package name that limits
7872 * the components this Intent will resolve to. If left to the default
7873 * value of null, all components in all applications will considered.
7874 * If non-null, the Intent can only match the components in the given
7875 * application package.
7876 *
7877 * @param packageName The name of the application package to handle the
7878 * intent, or null to allow any application package.
7879 *
7880 * @return Returns the same Intent object, for chaining multiple calls
7881 * into a single statement.
7882 *
7883 * @see #getPackage
7884 * @see #resolveActivity
7885 */
7886 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007887 if (packageName != null && mSelector != null) {
7888 throw new IllegalArgumentException(
7889 "Can't set package name when selector is already set");
7890 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007891 mPackage = packageName;
7892 return this;
7893 }
7894
7895 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007896 * (Usually optional) Explicitly set the component to handle the intent.
7897 * If left with the default value of null, the system will determine the
7898 * appropriate class to use based on the other fields (action, data,
7899 * type, categories) in the Intent. If this class is defined, the
7900 * specified class will always be used regardless of the other fields. You
7901 * should only set this value when you know you absolutely want a specific
7902 * class to be used; otherwise it is better to let the system find the
7903 * appropriate class so that you will respect the installed applications
7904 * and user preferences.
7905 *
7906 * @param component The name of the application component to handle the
7907 * intent, or null to let the system find one for you.
7908 *
7909 * @return Returns the same Intent object, for chaining multiple calls
7910 * into a single statement.
7911 *
7912 * @see #setClass
7913 * @see #setClassName(Context, String)
7914 * @see #setClassName(String, String)
7915 * @see #getComponent
7916 * @see #resolveActivity
7917 */
7918 public Intent setComponent(ComponentName component) {
7919 mComponent = component;
7920 return this;
7921 }
7922
7923 /**
7924 * Convenience for calling {@link #setComponent} with an
7925 * explicit class name.
7926 *
7927 * @param packageContext A Context of the application package implementing
7928 * this class.
7929 * @param className The name of a class inside of the application package
7930 * that will be used as the component for this Intent.
7931 *
7932 * @return Returns the same Intent object, for chaining multiple calls
7933 * into a single statement.
7934 *
7935 * @see #setComponent
7936 * @see #setClass
7937 */
7938 public Intent setClassName(Context packageContext, String className) {
7939 mComponent = new ComponentName(packageContext, className);
7940 return this;
7941 }
7942
7943 /**
7944 * Convenience for calling {@link #setComponent} with an
7945 * explicit application package name and class name.
7946 *
7947 * @param packageName The name of the package implementing the desired
7948 * component.
7949 * @param className The name of a class inside of the application package
7950 * that will be used as the component for this Intent.
7951 *
7952 * @return Returns the same Intent object, for chaining multiple calls
7953 * into a single statement.
7954 *
7955 * @see #setComponent
7956 * @see #setClass
7957 */
7958 public Intent setClassName(String packageName, String className) {
7959 mComponent = new ComponentName(packageName, className);
7960 return this;
7961 }
7962
7963 /**
7964 * Convenience for calling {@link #setComponent(ComponentName)} with the
7965 * name returned by a {@link Class} object.
7966 *
7967 * @param packageContext A Context of the application package implementing
7968 * this class.
7969 * @param cls The class name to set, equivalent to
7970 * <code>setClassName(context, cls.getName())</code>.
7971 *
7972 * @return Returns the same Intent object, for chaining multiple calls
7973 * into a single statement.
7974 *
7975 * @see #setComponent
7976 */
7977 public Intent setClass(Context packageContext, Class<?> cls) {
7978 mComponent = new ComponentName(packageContext, cls);
7979 return this;
7980 }
7981
7982 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007983 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7984 * used as a hint to the receiver for animations and the like. Null means that there
7985 * is no source bounds.
7986 */
7987 public void setSourceBounds(Rect r) {
7988 if (r != null) {
7989 mSourceBounds = new Rect(r);
7990 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007991 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007992 }
7993 }
7994
Tor Norbyed9273d62013-05-30 15:59:53 -07007995 /** @hide */
7996 @IntDef(flag = true,
7997 value = {
7998 FILL_IN_ACTION,
7999 FILL_IN_DATA,
8000 FILL_IN_CATEGORIES,
8001 FILL_IN_COMPONENT,
8002 FILL_IN_PACKAGE,
8003 FILL_IN_SOURCE_BOUNDS,
8004 FILL_IN_SELECTOR,
8005 FILL_IN_CLIP_DATA
8006 })
8007 @Retention(RetentionPolicy.SOURCE)
8008 public @interface FillInFlags {}
8009
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008011 * Use with {@link #fillIn} to allow the current action value to be
8012 * overwritten, even if it is already set.
8013 */
8014 public static final int FILL_IN_ACTION = 1<<0;
8015
8016 /**
8017 * Use with {@link #fillIn} to allow the current data or type value
8018 * overwritten, even if it is already set.
8019 */
8020 public static final int FILL_IN_DATA = 1<<1;
8021
8022 /**
8023 * Use with {@link #fillIn} to allow the current categories to be
8024 * overwritten, even if they are already set.
8025 */
8026 public static final int FILL_IN_CATEGORIES = 1<<2;
8027
8028 /**
8029 * Use with {@link #fillIn} to allow the current component value to be
8030 * overwritten, even if it is already set.
8031 */
8032 public static final int FILL_IN_COMPONENT = 1<<3;
8033
8034 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008035 * Use with {@link #fillIn} to allow the current package value to be
8036 * overwritten, even if it is already set.
8037 */
8038 public static final int FILL_IN_PACKAGE = 1<<4;
8039
8040 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008041 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008042 * overwritten, even if it is already set.
8043 */
8044 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8045
8046 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008047 * Use with {@link #fillIn} to allow the current selector to be
8048 * overwritten, even if it is already set.
8049 */
8050 public static final int FILL_IN_SELECTOR = 1<<6;
8051
8052 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008053 * Use with {@link #fillIn} to allow the current ClipData to be
8054 * overwritten, even if it is already set.
8055 */
8056 public static final int FILL_IN_CLIP_DATA = 1<<7;
8057
8058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008059 * Copy the contents of <var>other</var> in to this object, but only
8060 * where fields are not defined by this object. For purposes of a field
8061 * being defined, the following pieces of data in the Intent are
8062 * considered to be separate fields:
8063 *
8064 * <ul>
8065 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008066 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008067 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8068 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008069 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008070 * <li> component, as set by {@link #setComponent(ComponentName)} or
8071 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008072 * <li> source bounds, as set by {@link #setSourceBounds}.
8073 * <li> selector, as set by {@link #setSelector(Intent)}.
8074 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008075 * <li> each top-level name in the associated extras.
8076 * </ul>
8077 *
8078 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008079 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008080 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8081 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8082 * the restriction where the corresponding field will not be replaced if
8083 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008084 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008085 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8086 * is explicitly specified. The selector will only be copied if
8087 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008088 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008089 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8090 * and Intent B with {action="gotit", data-type="some/thing",
8091 * categories="one","two"}.
8092 *
8093 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8094 * containing: {action="gotit", data-type="some/thing",
8095 * categories="bar"}.
8096 *
8097 * @param other Another Intent whose values are to be used to fill in
8098 * the current one.
8099 * @param flags Options to control which fields can be filled in.
8100 *
8101 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008102 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008103 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8104 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8105 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008106 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008107 @FillInFlags
8108 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008109 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008110 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008111 if (other.mAction != null
8112 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008113 mAction = other.mAction;
8114 changes |= FILL_IN_ACTION;
8115 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008116 if ((other.mData != null || other.mType != null)
8117 && ((mData == null && mType == null)
8118 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008119 mData = other.mData;
8120 mType = other.mType;
8121 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008122 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008123 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008124 if (other.mCategories != null
8125 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008126 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008127 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008128 }
8129 changes |= FILL_IN_CATEGORIES;
8130 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008131 if (other.mPackage != null
8132 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008133 // Only do this if mSelector is not set.
8134 if (mSelector == null) {
8135 mPackage = other.mPackage;
8136 changes |= FILL_IN_PACKAGE;
8137 }
8138 }
8139 // Selector is special: it can only be set if explicitly allowed,
8140 // for the same reason as the component name.
8141 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8142 if (mPackage == null) {
8143 mSelector = new Intent(other.mSelector);
8144 mPackage = null;
8145 changes |= FILL_IN_SELECTOR;
8146 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008147 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008148 if (other.mClipData != null
8149 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8150 mClipData = other.mClipData;
8151 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008152 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008153 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008154 // Component is special: it can -only- be set if explicitly allowed,
8155 // since otherwise the sender could force the intent somewhere the
8156 // originator didn't intend.
8157 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008158 mComponent = other.mComponent;
8159 changes |= FILL_IN_COMPONENT;
8160 }
8161 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008162 if (other.mSourceBounds != null
8163 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8164 mSourceBounds = new Rect(other.mSourceBounds);
8165 changes |= FILL_IN_SOURCE_BOUNDS;
8166 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008167 if (mExtras == null) {
8168 if (other.mExtras != null) {
8169 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008170 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008171 }
8172 } else if (other.mExtras != null) {
8173 try {
8174 Bundle newb = new Bundle(other.mExtras);
8175 newb.putAll(mExtras);
8176 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008177 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008178 } catch (RuntimeException e) {
8179 // Modifying the extras can cause us to unparcel the contents
8180 // of the bundle, and if we do this in the system process that
8181 // may fail. We really should handle this (i.e., the Bundle
8182 // impl shouldn't be on top of a plain map), but for now just
8183 // ignore it and keep the original contents. :(
8184 Log.w("Intent", "Failure filling in extras", e);
8185 }
8186 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008187 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8188 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8189 mContentUserHint = other.mContentUserHint;
8190 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008191 return changes;
8192 }
8193
8194 /**
8195 * Wrapper class holding an Intent and implementing comparisons on it for
8196 * the purpose of filtering. The class implements its
8197 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8198 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8199 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8200 * on the wrapped Intent.
8201 */
8202 public static final class FilterComparison {
8203 private final Intent mIntent;
8204 private final int mHashCode;
8205
8206 public FilterComparison(Intent intent) {
8207 mIntent = intent;
8208 mHashCode = intent.filterHashCode();
8209 }
8210
8211 /**
8212 * Return the Intent that this FilterComparison represents.
8213 * @return Returns the Intent held by the FilterComparison. Do
8214 * not modify!
8215 */
8216 public Intent getIntent() {
8217 return mIntent;
8218 }
8219
8220 @Override
8221 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008222 if (obj instanceof FilterComparison) {
8223 Intent other = ((FilterComparison)obj).mIntent;
8224 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008225 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008226 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008227 }
8228
8229 @Override
8230 public int hashCode() {
8231 return mHashCode;
8232 }
8233 }
8234
8235 /**
8236 * Determine if two intents are the same for the purposes of intent
8237 * resolution (filtering). That is, if their action, data, type,
8238 * class, and categories are the same. This does <em>not</em> compare
8239 * any extra data included in the intents.
8240 *
8241 * @param other The other Intent to compare against.
8242 *
8243 * @return Returns true if action, data, type, class, and categories
8244 * are the same.
8245 */
8246 public boolean filterEquals(Intent other) {
8247 if (other == null) {
8248 return false;
8249 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008250 if (!Objects.equals(this.mAction, other.mAction)) return false;
8251 if (!Objects.equals(this.mData, other.mData)) return false;
8252 if (!Objects.equals(this.mType, other.mType)) return false;
8253 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8254 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8255 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008256
8257 return true;
8258 }
8259
8260 /**
8261 * Generate hash code that matches semantics of filterEquals().
8262 *
8263 * @return Returns the hash value of the action, data, type, class, and
8264 * categories.
8265 *
8266 * @see #filterEquals
8267 */
8268 public int filterHashCode() {
8269 int code = 0;
8270 if (mAction != null) {
8271 code += mAction.hashCode();
8272 }
8273 if (mData != null) {
8274 code += mData.hashCode();
8275 }
8276 if (mType != null) {
8277 code += mType.hashCode();
8278 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008279 if (mPackage != null) {
8280 code += mPackage.hashCode();
8281 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008282 if (mComponent != null) {
8283 code += mComponent.hashCode();
8284 }
8285 if (mCategories != null) {
8286 code += mCategories.hashCode();
8287 }
8288 return code;
8289 }
8290
8291 @Override
8292 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008293 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008294
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008295 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008296 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008297 b.append(" }");
8298
8299 return b.toString();
8300 }
8301
8302 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008303 public String toInsecureString() {
8304 StringBuilder b = new StringBuilder(128);
8305
8306 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008307 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008308 b.append(" }");
8309
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008310 return b.toString();
8311 }
Romain Guy4969af72009-06-17 10:53:19 -07008312
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008313 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008314 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008315 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008316
8317 b.append("Intent { ");
8318 toShortString(b, false, true, true, true);
8319 b.append(" }");
8320
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008321 return b.toString();
8322 }
8323
8324 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008325 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8326 StringBuilder b = new StringBuilder(128);
8327 toShortString(b, secure, comp, extras, clip);
8328 return b.toString();
8329 }
8330
8331 /** @hide */
8332 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8333 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008334 boolean first = true;
8335 if (mAction != null) {
8336 b.append("act=").append(mAction);
8337 first = false;
8338 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008339 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008340 if (!first) {
8341 b.append(' ');
8342 }
8343 first = false;
8344 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008345 for (int i=0; i<mCategories.size(); i++) {
8346 if (i > 0) b.append(',');
8347 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008348 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008349 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008350 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008351 if (mData != null) {
8352 if (!first) {
8353 b.append(' ');
8354 }
8355 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008356 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008357 if (secure) {
8358 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008359 } else {
8360 b.append(mData);
8361 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008362 }
8363 if (mType != null) {
8364 if (!first) {
8365 b.append(' ');
8366 }
8367 first = false;
8368 b.append("typ=").append(mType);
8369 }
8370 if (mFlags != 0) {
8371 if (!first) {
8372 b.append(' ');
8373 }
8374 first = false;
8375 b.append("flg=0x").append(Integer.toHexString(mFlags));
8376 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008377 if (mPackage != null) {
8378 if (!first) {
8379 b.append(' ');
8380 }
8381 first = false;
8382 b.append("pkg=").append(mPackage);
8383 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008384 if (comp && mComponent != null) {
8385 if (!first) {
8386 b.append(' ');
8387 }
8388 first = false;
8389 b.append("cmp=").append(mComponent.flattenToShortString());
8390 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008391 if (mSourceBounds != null) {
8392 if (!first) {
8393 b.append(' ');
8394 }
8395 first = false;
8396 b.append("bnds=").append(mSourceBounds.toShortString());
8397 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008398 if (mClipData != null) {
8399 if (!first) {
8400 b.append(' ');
8401 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008402 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008403 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008404 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008405 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008406 if (mClipData.getDescription() != null) {
8407 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8408 } else {
8409 first = true;
8410 }
8411 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008412 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008413 first = false;
8414 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008415 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008416 if (extras && mExtras != null) {
8417 if (!first) {
8418 b.append(' ');
8419 }
8420 first = false;
8421 b.append("(has extras)");
8422 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008423 if (mContentUserHint != UserHandle.USER_CURRENT) {
8424 if (!first) {
8425 b.append(' ');
8426 }
8427 first = false;
8428 b.append("u=").append(mContentUserHint);
8429 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008430 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008431 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008432 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008433 b.append("}");
8434 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008435 }
8436
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008437 /**
8438 * Call {@link #toUri} with 0 flags.
8439 * @deprecated Use {@link #toUri} instead.
8440 */
8441 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008442 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008443 return toUri(0);
8444 }
8445
8446 /**
8447 * Convert this Intent into a String holding a URI representation of it.
8448 * The returned URI string has been properly URI encoded, so it can be
8449 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8450 * Intent's data as the base URI, with an additional fragment describing
8451 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008452 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008453 * <p>You can convert the returned string back to an Intent with
8454 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008455 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008456 * @param flags Additional operating flags. Either 0,
8457 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008458 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008459 * @return Returns a URI encoding URI string describing the entire contents
8460 * of the Intent.
8461 */
8462 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008463 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008464 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8465 if (mPackage == null) {
8466 throw new IllegalArgumentException(
8467 "Intent must include an explicit package name to build an android-app: "
8468 + this);
8469 }
8470 uri.append("android-app://");
8471 uri.append(mPackage);
8472 String scheme = null;
8473 if (mData != null) {
8474 scheme = mData.getScheme();
8475 if (scheme != null) {
8476 uri.append('/');
8477 uri.append(scheme);
8478 String authority = mData.getEncodedAuthority();
8479 if (authority != null) {
8480 uri.append('/');
8481 uri.append(authority);
8482 String path = mData.getEncodedPath();
8483 if (path != null) {
8484 uri.append(path);
8485 }
8486 String queryParams = mData.getEncodedQuery();
8487 if (queryParams != null) {
8488 uri.append('?');
8489 uri.append(queryParams);
8490 }
8491 String fragment = mData.getEncodedFragment();
8492 if (fragment != null) {
8493 uri.append('#');
8494 uri.append(fragment);
8495 }
8496 }
8497 }
8498 }
8499 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8500 mPackage, flags);
8501 return uri.toString();
8502 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008503 String scheme = null;
8504 if (mData != null) {
8505 String data = mData.toString();
8506 if ((flags&URI_INTENT_SCHEME) != 0) {
8507 final int N = data.length();
8508 for (int i=0; i<N; i++) {
8509 char c = data.charAt(i);
8510 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8511 || c == '.' || c == '-') {
8512 continue;
8513 }
8514 if (c == ':' && i > 0) {
8515 // Valid scheme.
8516 scheme = data.substring(0, i);
8517 uri.append("intent:");
8518 data = data.substring(i+1);
8519 break;
8520 }
Tom Taylord4a47292009-12-21 13:59:18 -08008521
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008522 // No scheme.
8523 break;
8524 }
8525 }
8526 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008527
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008528 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8529 uri.append("intent:");
8530 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008531
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008532 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008533
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008534 return uri.toString();
8535 }
8536
8537 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8538 String defPackage, int flags) {
8539 StringBuilder frag = new StringBuilder(128);
8540
8541 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008542 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008543 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008544 // Note that for now we are not going to try to handle the
8545 // data part; not clear how to represent this as a URI, and
8546 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008547 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8548 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008549 }
8550
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008551 if (frag.length() > 0) {
8552 uri.append("#Intent;");
8553 uri.append(frag);
8554 uri.append("end");
8555 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008556 }
8557
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008558 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8559 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008560 if (scheme != null) {
8561 uri.append("scheme=").append(scheme).append(';');
8562 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008563 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008564 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008565 }
8566 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008567 for (int i=0; i<mCategories.size(); i++) {
8568 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008569 }
8570 }
8571 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008572 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008573 }
8574 if (mFlags != 0) {
8575 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8576 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008577 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008578 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8579 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008580 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008581 uri.append("component=").append(Uri.encode(
8582 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008583 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008584 if (mSourceBounds != null) {
8585 uri.append("sourceBounds=")
8586 .append(Uri.encode(mSourceBounds.flattenToString()))
8587 .append(';');
8588 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008589 if (mExtras != null) {
8590 for (String key : mExtras.keySet()) {
8591 final Object value = mExtras.get(key);
8592 char entryType =
8593 value instanceof String ? 'S' :
8594 value instanceof Boolean ? 'B' :
8595 value instanceof Byte ? 'b' :
8596 value instanceof Character ? 'c' :
8597 value instanceof Double ? 'd' :
8598 value instanceof Float ? 'f' :
8599 value instanceof Integer ? 'i' :
8600 value instanceof Long ? 'l' :
8601 value instanceof Short ? 's' :
8602 '\0';
8603
8604 if (entryType != '\0') {
8605 uri.append(entryType);
8606 uri.append('.');
8607 uri.append(Uri.encode(key));
8608 uri.append('=');
8609 uri.append(Uri.encode(value.toString()));
8610 uri.append(';');
8611 }
8612 }
8613 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008614 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008615
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008616 public int describeContents() {
8617 return (mExtras != null) ? mExtras.describeContents() : 0;
8618 }
8619
8620 public void writeToParcel(Parcel out, int flags) {
8621 out.writeString(mAction);
8622 Uri.writeToParcel(out, mData);
8623 out.writeString(mType);
8624 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008625 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008626 ComponentName.writeToParcel(mComponent, out);
8627
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008628 if (mSourceBounds != null) {
8629 out.writeInt(1);
8630 mSourceBounds.writeToParcel(out, flags);
8631 } else {
8632 out.writeInt(0);
8633 }
8634
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008635 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008636 final int N = mCategories.size();
8637 out.writeInt(N);
8638 for (int i=0; i<N; i++) {
8639 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008640 }
8641 } else {
8642 out.writeInt(0);
8643 }
8644
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008645 if (mSelector != null) {
8646 out.writeInt(1);
8647 mSelector.writeToParcel(out, flags);
8648 } else {
8649 out.writeInt(0);
8650 }
8651
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008652 if (mClipData != null) {
8653 out.writeInt(1);
8654 mClipData.writeToParcel(out, flags);
8655 } else {
8656 out.writeInt(0);
8657 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008658 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008659 out.writeBundle(mExtras);
8660 }
8661
8662 public static final Parcelable.Creator<Intent> CREATOR
8663 = new Parcelable.Creator<Intent>() {
8664 public Intent createFromParcel(Parcel in) {
8665 return new Intent(in);
8666 }
8667 public Intent[] newArray(int size) {
8668 return new Intent[size];
8669 }
8670 };
8671
Dianne Hackborneb034652009-09-07 00:49:58 -07008672 /** @hide */
8673 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008674 readFromParcel(in);
8675 }
8676
8677 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008678 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 mData = Uri.CREATOR.createFromParcel(in);
8680 mType = in.readString();
8681 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008682 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008683 mComponent = ComponentName.readFromParcel(in);
8684
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008685 if (in.readInt() != 0) {
8686 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8687 }
8688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008689 int N = in.readInt();
8690 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008691 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008692 int i;
8693 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008694 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008695 }
8696 } else {
8697 mCategories = null;
8698 }
8699
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008700 if (in.readInt() != 0) {
8701 mSelector = new Intent(in);
8702 }
8703
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008704 if (in.readInt() != 0) {
8705 mClipData = new ClipData(in);
8706 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008707 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008708 mExtras = in.readBundle();
8709 }
8710
8711 /**
8712 * Parses the "intent" element (and its children) from XML and instantiates
8713 * an Intent object. The given XML parser should be located at the tag
8714 * where parsing should start (often named "intent"), from which the
8715 * basic action, data, type, and package and class name will be
8716 * retrieved. The function will then parse in to any child elements,
8717 * looking for <category android:name="xxx"> tags to add categories and
8718 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8719 * to the intent.
8720 *
8721 * @param resources The Resources to use when inflating resources.
8722 * @param parser The XML parser pointing at an "intent" tag.
8723 * @param attrs The AttributeSet interface for retrieving extended
8724 * attribute data at the current <var>parser</var> location.
8725 * @return An Intent object matching the XML data.
8726 * @throws XmlPullParserException If there was an XML parsing error.
8727 * @throws IOException If there was an I/O error.
8728 */
8729 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8730 throws XmlPullParserException, IOException {
8731 Intent intent = new Intent();
8732
8733 TypedArray sa = resources.obtainAttributes(attrs,
8734 com.android.internal.R.styleable.Intent);
8735
8736 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8737
8738 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8739 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8740 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8741
8742 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8743 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8744 if (packageName != null && className != null) {
8745 intent.setComponent(new ComponentName(packageName, className));
8746 }
8747
8748 sa.recycle();
8749
8750 int outerDepth = parser.getDepth();
8751 int type;
8752 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8753 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8754 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8755 continue;
8756 }
8757
8758 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008759 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008760 sa = resources.obtainAttributes(attrs,
8761 com.android.internal.R.styleable.IntentCategory);
8762 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8763 sa.recycle();
8764
8765 if (cat != null) {
8766 intent.addCategory(cat);
8767 }
8768 XmlUtils.skipCurrentTag(parser);
8769
Craig Mautner21d24a22014-04-23 11:45:37 -07008770 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008771 if (intent.mExtras == null) {
8772 intent.mExtras = new Bundle();
8773 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008774 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008775 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008776
8777 } else {
8778 XmlUtils.skipCurrentTag(parser);
8779 }
8780 }
8781
8782 return intent;
8783 }
Nick Pellyccae4122012-01-09 14:12:58 -08008784
Craig Mautner21d24a22014-04-23 11:45:37 -07008785 /** @hide */
8786 public void saveToXml(XmlSerializer out) throws IOException {
8787 if (mAction != null) {
8788 out.attribute(null, ATTR_ACTION, mAction);
8789 }
8790 if (mData != null) {
8791 out.attribute(null, ATTR_DATA, mData.toString());
8792 }
8793 if (mType != null) {
8794 out.attribute(null, ATTR_TYPE, mType);
8795 }
8796 if (mComponent != null) {
8797 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8798 }
8799 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8800
8801 if (mCategories != null) {
8802 out.startTag(null, TAG_CATEGORIES);
8803 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8804 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8805 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008806 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008807 }
8808 }
8809
8810 /** @hide */
8811 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8812 XmlPullParserException {
8813 Intent intent = new Intent();
8814 final int outerDepth = in.getDepth();
8815
8816 int attrCount = in.getAttributeCount();
8817 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8818 final String attrName = in.getAttributeName(attrNdx);
8819 final String attrValue = in.getAttributeValue(attrNdx);
8820 if (ATTR_ACTION.equals(attrName)) {
8821 intent.setAction(attrValue);
8822 } else if (ATTR_DATA.equals(attrName)) {
8823 intent.setData(Uri.parse(attrValue));
8824 } else if (ATTR_TYPE.equals(attrName)) {
8825 intent.setType(attrValue);
8826 } else if (ATTR_COMPONENT.equals(attrName)) {
8827 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8828 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008829 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008830 } else {
8831 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8832 }
8833 }
8834
8835 int event;
8836 String name;
8837 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8838 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8839 if (event == XmlPullParser.START_TAG) {
8840 name = in.getName();
8841 if (TAG_CATEGORIES.equals(name)) {
8842 attrCount = in.getAttributeCount();
8843 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8844 intent.addCategory(in.getAttributeValue(attrNdx));
8845 }
8846 } else {
8847 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8848 XmlUtils.skipCurrentTag(in);
8849 }
8850 }
8851 }
8852
8853 return intent;
8854 }
8855
Nick Pellyccae4122012-01-09 14:12:58 -08008856 /**
8857 * Normalize a MIME data type.
8858 *
8859 * <p>A normalized MIME type has white-space trimmed,
8860 * content-type parameters removed, and is lower-case.
8861 * This aligns the type with Android best practices for
8862 * intent filtering.
8863 *
8864 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8865 * "text/x-vCard" becomes "text/x-vcard".
8866 *
8867 * <p>All MIME types received from outside Android (such as user input,
8868 * or external sources like Bluetooth, NFC, or the Internet) should
8869 * be normalized before they are used to create an Intent.
8870 *
8871 * @param type MIME data type to normalize
8872 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008873 * @see #setType
8874 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008875 */
8876 public static String normalizeMimeType(String type) {
8877 if (type == null) {
8878 return null;
8879 }
8880
Elliott Hughescb64d432013-08-02 10:00:44 -07008881 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008882
8883 final int semicolonIndex = type.indexOf(';');
8884 if (semicolonIndex != -1) {
8885 type = type.substring(0, semicolonIndex);
8886 }
8887 return type;
8888 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008889
8890 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008891 * Prepare this {@link Intent} to leave an app process.
8892 *
8893 * @hide
8894 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008895 public void prepareToLeaveProcess(Context context) {
8896 final boolean leavingPackage = (mComponent == null)
8897 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8898 prepareToLeaveProcess(leavingPackage);
8899 }
8900
8901 /**
8902 * Prepare this {@link Intent} to leave an app process.
8903 *
8904 * @hide
8905 */
8906 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008907 setAllowFds(false);
8908
8909 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008910 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008911 }
8912 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008913 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008914 }
8915
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008916 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8917 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008918 switch (mAction) {
8919 case ACTION_MEDIA_REMOVED:
8920 case ACTION_MEDIA_UNMOUNTED:
8921 case ACTION_MEDIA_CHECKING:
8922 case ACTION_MEDIA_NOFS:
8923 case ACTION_MEDIA_MOUNTED:
8924 case ACTION_MEDIA_SHARED:
8925 case ACTION_MEDIA_UNSHARED:
8926 case ACTION_MEDIA_BAD_REMOVAL:
8927 case ACTION_MEDIA_UNMOUNTABLE:
8928 case ACTION_MEDIA_EJECT:
8929 case ACTION_MEDIA_SCANNER_STARTED:
8930 case ACTION_MEDIA_SCANNER_FINISHED:
8931 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008932 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8933 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008934 // Ignore legacy actions
8935 break;
8936 default:
8937 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008938 }
8939 }
8940 }
8941
8942 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008943 * @hide
8944 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008945 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008946 // We just entered destination process, so we should be able to read all
8947 // parcelables inside.
8948 setDefusable(true);
8949
8950 if (mSelector != null) {
8951 mSelector.prepareToEnterProcess();
8952 }
8953 if (mClipData != null) {
8954 mClipData.prepareToEnterProcess();
8955 }
8956
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008957 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008958 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8959 fixUris(mContentUserHint);
8960 mContentUserHint = UserHandle.USER_CURRENT;
8961 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008962 }
8963 }
8964
8965 /**
8966 * @hide
8967 */
8968 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008969 Uri data = getData();
8970 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008971 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008972 }
8973 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008974 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008975 }
8976 String action = getAction();
8977 if (ACTION_SEND.equals(action)) {
8978 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8979 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008980 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008981 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008982 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008983 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8984 if (streams != null) {
8985 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8986 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008987 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008988 }
8989 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8990 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008991 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8992 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8993 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8994 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8995 if (output != null) {
8996 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8997 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008998 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008999 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009000
9001 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009002 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009003 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9004 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009005 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009006 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009007 * @hide
9008 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009009 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009010 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009011 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009012
9013 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009014 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009015
9016 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009017 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009018 // Inspect contained intents to see if we need to migrate extras. We
9019 // don't promote ClipData to the parent, since ChooserActivity will
9020 // already start the picked item as the caller, and we can't combine
9021 // the flags in a safe way.
9022
9023 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009024 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009025 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9026 if (intent != null) {
9027 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009028 }
9029 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009030 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009031 try {
9032 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9033 if (intents != null) {
9034 for (int i = 0; i < intents.length; i++) {
9035 final Intent intent = (Intent) intents[i];
9036 if (intent != null) {
9037 migrated |= intent.migrateExtraStreamToClipData();
9038 }
9039 }
9040 }
9041 } catch (ClassCastException e) {
9042 }
9043 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009044
9045 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009046 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009047 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9048 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9049 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9050 if (stream != null || text != null || htmlText != null) {
9051 final ClipData clipData = new ClipData(
9052 null, new String[] { getType() },
9053 new ClipData.Item(text, htmlText, null, stream));
9054 setClipData(clipData);
9055 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009056 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009057 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009058 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009059 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009060
9061 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009062 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009063 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9064 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9065 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9066 int num = -1;
9067 if (streams != null) {
9068 num = streams.size();
9069 }
9070 if (texts != null) {
9071 if (num >= 0 && num != texts.size()) {
9072 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009073 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009074 }
9075 num = texts.size();
9076 }
9077 if (htmlTexts != null) {
9078 if (num >= 0 && num != htmlTexts.size()) {
9079 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009080 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009081 }
9082 num = htmlTexts.size();
9083 }
9084 if (num > 0) {
9085 final ClipData clipData = new ClipData(
9086 null, new String[] { getType() },
9087 makeClipItem(streams, texts, htmlTexts, 0));
9088
9089 for (int i = 1; i < num; i++) {
9090 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9091 }
9092
9093 setClipData(clipData);
9094 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009095 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009096 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009097 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009098 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009099 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9100 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9101 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9102 final Uri output;
9103 try {
9104 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9105 } catch (ClassCastException e) {
9106 return false;
9107 }
9108 if (output != null) {
9109 setClipData(ClipData.newRawUri("", output));
9110 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9111 return true;
9112 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009113 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009114
9115 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009116 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009117
9118 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9119 ArrayList<String> htmlTexts, int which) {
9120 Uri uri = streams != null ? streams.get(which) : null;
9121 CharSequence text = texts != null ? texts.get(which) : null;
9122 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9123 return new ClipData.Item(text, htmlText, null, uri);
9124 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009125
9126 /** @hide */
9127 public boolean isDocument() {
9128 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9129 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009130}