blob: 4eecd48df646e951a25fcc032b639a189e8cb75a [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700118 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700189 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700342 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700361 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * </ul>
573 *
574 * <h3>Standard Extra Data</h3>
575 *
576 * <p>These are the current standard fields that can be used as extra data via
577 * {@link #putExtra}.
578 *
579 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_ALARM_COUNT}
581 * <li> {@link #EXTRA_BCC}
582 * <li> {@link #EXTRA_CC}
583 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
584 * <li> {@link #EXTRA_DATA_REMOVED}
585 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500586 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_DOCK_STATE_CAR}
589 * <li> {@link #EXTRA_DOCK_STATE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
591 * <li> {@link #EXTRA_DONT_KILL_APP}
592 * <li> {@link #EXTRA_EMAIL}
593 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700596 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700598 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
600 * <li> {@link #EXTRA_REPLACING}
601 * <li> {@link #EXTRA_SHORTCUT_ICON}
602 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
603 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_SHORTCUT_NAME}
606 * <li> {@link #EXTRA_SUBJECT}
607 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_TITLE}
610 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * </ul>
612 *
613 * <h3>Flags</h3>
614 *
615 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
617 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800619public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700620 private static final String ATTR_ACTION = "action";
621 private static final String TAG_CATEGORIES = "categories";
622 private static final String ATTR_CATEGORY = "category";
623 private static final String TAG_EXTRA = "extra";
624 private static final String ATTR_TYPE = "type";
625 private static final String ATTR_COMPONENT = "component";
626 private static final String ATTR_DATA = "data";
627 private static final String ATTR_FLAGS = "flags";
628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 // ---------------------------------------------------------------------
630 // ---------------------------------------------------------------------
631 // Standard intent activity actions (see action variable).
632
633 /**
634 * Activity Action: Start as a main entry point, does not expect to
635 * receive data.
636 * <p>Input: nothing
637 * <p>Output: nothing
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Display the data to the user. This is the most common
644 * action performed on data -- it is the generic action you can use on
645 * a piece of data to get the most reasonable thing to occur. For example,
646 * when used on a contacts entry it will view the entry; when used on a
647 * mailto: URI it will bring up a compose window filled with the information
648 * supplied by the URI; when used with a tel: URI it will invoke the
649 * dialer.
650 * <p>Input: {@link #getData} is URI from which to retrieve data.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
658 * performed on a piece of data.
659 */
660 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900663 * Activity Action: Quick view the data. Launches a quick viewer for
664 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900665 * <p>Activities handling this intent action should handle the vast majority of
666 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * <p>Input: {@link #getData} is a mandatory content URI of the item to
668 * preview. {@link #getClipData} contains an optional list of content URIs
669 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
670 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700671 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
675
676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * Used to indicate that some piece of data should be attached to some other
678 * place. For example, image data could be attached to a contact. It is up
679 * to the recipient to decide where the data should be attached; the intent
680 * does not specify the ultimate destination.
681 * <p>Input: {@link #getData} is URI of data to be attached.
682 * <p>Output: nothing.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Provide explicit editable access to the given data.
689 * <p>Input: {@link #getData} is URI of data to be edited.
690 * <p>Output: nothing.
691 */
692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
693 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700695 /**
696 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
697 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
698 * The extras can contain type specific data to pass through to the editing/creating
699 * activity.
700 * <p>Output: The URI of the item that was picked. This must be a content:
701 * URI so that any receiver can access it.
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800705
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700706 /**
707 * Activity Action: Pick an item from the data, returning what was selected.
708 * <p>Input: {@link #getData} is URI containing a directory of data
709 * (vnd.android.cursor.dir/*) from which to pick an item.
710 * <p>Output: The URI of the item that was picked.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 * <p>Output: An Intent representing the shortcut. The intent must contain three
719 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
720 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * (value: ShortcutIconResource).</p>
722 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 * @see #EXTRA_SHORTCUT_INTENT
724 * @see #EXTRA_SHORTCUT_NAME
725 * @see #EXTRA_SHORTCUT_ICON
726 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
727 * @see android.content.Intent.ShortcutIconResource
728 */
729 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
730 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
731
732 /**
733 * The name of the extra used to define the Intent of a shortcut.
734 *
735 * @see #ACTION_CREATE_SHORTCUT
736 */
737 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
738 /**
739 * The name of the extra used to define the name of a shortcut.
740 *
741 * @see #ACTION_CREATE_SHORTCUT
742 */
743 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
744 /**
745 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
746 *
747 * @see #ACTION_CREATE_SHORTCUT
748 */
749 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
750 /**
751 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
752 *
753 * @see #ACTION_CREATE_SHORTCUT
754 * @see android.content.Intent.ShortcutIconResource
755 */
756 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
757 "android.intent.extra.shortcut.ICON_RESOURCE";
758
759 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500760 * An activity that provides a user interface for adjusting application preferences.
761 * Optional but recommended settings for all applications which have settings.
762 */
763 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
764 public static final String ACTION_APPLICATION_PREFERENCES
765 = "android.intent.action.APPLICATION_PREFERENCES";
766
767 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700768 * Activity Action: Launch an activity showing the app information.
769 * For applications which install other applications (such as app stores), it is recommended
770 * to handle this action for providing the app information to the user.
771 *
772 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
773 * to be displayed.
774 * <p>Output: Nothing.
775 */
776 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
777 public static final String ACTION_SHOW_APP_INFO
778 = "android.intent.action.SHOW_APP_INFO";
779
780 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800781 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 *
783 * @see Intent#ACTION_CREATE_SHORTCUT
784 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800785 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
786 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 */
788 public static class ShortcutIconResource implements Parcelable {
789 /**
790 * The package name of the application containing the icon.
791 */
792 public String packageName;
793
794 /**
795 * The resource name of the icon, including package, name and type.
796 */
797 public String resourceName;
798
799 /**
800 * Creates a new ShortcutIconResource for the specified context and resource
801 * identifier.
802 *
803 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700804 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700805 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700806 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700807 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700808 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700809 ShortcutIconResource icon = new ShortcutIconResource();
810 icon.packageName = context.getPackageName();
811 icon.resourceName = context.getResources().getResourceName(resourceId);
812 return icon;
813 }
814
815 /**
816 * Used to read a ShortcutIconResource from a Parcel.
817 */
818 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
819 new Parcelable.Creator<ShortcutIconResource>() {
820
821 public ShortcutIconResource createFromParcel(Parcel source) {
822 ShortcutIconResource icon = new ShortcutIconResource();
823 icon.packageName = source.readString();
824 icon.resourceName = source.readString();
825 return icon;
826 }
827
828 public ShortcutIconResource[] newArray(int size) {
829 return new ShortcutIconResource[size];
830 }
831 };
832
833 /**
834 * No special parcel contents.
835 */
836 public int describeContents() {
837 return 0;
838 }
839
840 public void writeToParcel(Parcel dest, int flags) {
841 dest.writeString(packageName);
842 dest.writeString(resourceName);
843 }
844
845 @Override
846 public String toString() {
847 return resourceName;
848 }
849 }
850
851 /**
852 * Activity Action: Display an activity chooser, allowing the user to pick
853 * what they want to before proceeding. This can be used as an alternative
854 * to the standard activity picker that is displayed by the system when
855 * you try to start an activity with multiple possible matches, with these
856 * differences in behavior:
857 * <ul>
858 * <li>You can specify the title that will appear in the activity chooser.
859 * <li>The user does not have the option to make one of the matching
860 * activities a preferred activity, and all possible activities will
861 * always be shown even if one of them is currently marked as the
862 * preferred activity.
863 * </ul>
864 * <p>
865 * This action should be used when the user will naturally expect to
866 * select an activity in order to proceed. An example if when not to use
867 * it is when the user clicks on a "mailto:" link. They would naturally
868 * expect to go directly to their mail app, so startActivity() should be
869 * called directly: it will
870 * either launch the current preferred app, or put up a dialog allowing the
871 * user to pick an app to use and optionally marking that as preferred.
872 * <p>
873 * In contrast, if the user is selecting a menu item to send a picture
874 * they are viewing to someone else, there are many different things they
875 * may want to do at this point: send it through e-mail, upload it to a
876 * web service, etc. In this case the CHOOSER action should be used, to
877 * always present to the user a list of the things they can do, with a
878 * nice title given by the caller such as "Send this photo with:".
879 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700880 * If you need to grant URI permissions through a chooser, you must specify
881 * the permissions to be granted on the ACTION_CHOOSER Intent
882 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
883 * {@link #setClipData} to specify the URIs to be granted as well as
884 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
885 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
886 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 * As a convenience, an Intent of this form can be created with the
888 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700889 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700890 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700891 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
892 * and can optionally have a {@link #EXTRA_TITLE} field containing the
893 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700894 * <p>
895 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700896 */
897 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
898 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
899
900 /**
901 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
902 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700903 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
904 * target intent, also optionally supplying a title. If the target
905 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
906 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
907 * set in the returned chooser intent, with its ClipData set appropriately:
908 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500909 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700910 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * @param target The Intent that the user will be selecting an activity
912 * to perform.
913 * @param title Optional title that will be displayed in the chooser.
914 * @return Return a new Intent object that you can hand to
915 * {@link Context#startActivity(Intent) Context.startActivity()} and
916 * related methods.
917 */
918 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700919 return createChooser(target, title, null);
920 }
921
922 /**
923 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
924 *
925 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
926 * target intent, also optionally supplying a title. If the target
927 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
928 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
929 * set in the returned chooser intent, with its ClipData set appropriately:
930 * either a direct reflection of {@link #getClipData()} if that is non-null,
931 * or a new ClipData built from {@link #getData()}.</p>
932 *
933 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
934 * when the user makes a choice. This can be useful if the calling application wants
935 * to remember the last chosen target and surface it as a more prominent or one-touch
936 * affordance elsewhere in the UI for next time.</p>
937 *
938 * @param target The Intent that the user will be selecting an activity
939 * to perform.
940 * @param title Optional title that will be displayed in the chooser.
941 * @param sender Optional IntentSender to be called when a choice is made.
942 * @return Return a new Intent object that you can hand to
943 * {@link Context#startActivity(Intent) Context.startActivity()} and
944 * related methods.
945 */
946 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 Intent intent = new Intent(ACTION_CHOOSER);
948 intent.putExtra(EXTRA_INTENT, target);
949 if (title != null) {
950 intent.putExtra(EXTRA_TITLE, title);
951 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700952
Adam Powell0b3c1122014-10-09 12:50:14 -0700953 if (sender != null) {
954 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
955 }
956
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700957 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700958 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
959 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
960 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700961 if (permFlags != 0) {
962 ClipData targetClipData = target.getClipData();
963 if (targetClipData == null && target.getData() != null) {
964 ClipData.Item item = new ClipData.Item(target.getData());
965 String[] mimeTypes;
966 if (target.getType() != null) {
967 mimeTypes = new String[] { target.getType() };
968 } else {
969 mimeTypes = new String[] { };
970 }
971 targetClipData = new ClipData(null, mimeTypes, item);
972 }
973 if (targetClipData != null) {
974 intent.setClipData(targetClipData);
975 intent.addFlags(permFlags);
976 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700977 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700979 return intent;
980 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 /**
983 * Activity Action: Allow the user to select a particular kind of data and
984 * return it. This is different than {@link #ACTION_PICK} in that here we
985 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800986 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700987 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900988 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700989 * etc.
990 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900991 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700992 * of data, such as a person contact, you set the MIME type to the kind of
993 * data you want and launch it with {@link Context#startActivity(Intent)}.
994 * The system will then launch the best application to select that kind
995 * of data for you.
996 * <p>
997 * You may also be interested in any of a set of types of content the user
998 * can pick. For example, an e-mail application that wants to allow the
999 * user to add an attachment to an e-mail message can use this action to
1000 * bring up a list of all of the types of content the user can attach.
1001 * <p>
1002 * In this case, you should wrap the GET_CONTENT intent with a chooser
1003 * (through {@link #createChooser}), which will give the proper interface
1004 * for the user to pick how to send your data and allow you to specify
1005 * a prompt indicating what they are doing. You will usually specify a
1006 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1007 * broad range of content types the user can select from.
1008 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001009 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001010 * only pick from data that can be represented as a stream. This is
1011 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1012 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001013 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001014 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001015 * is locally available on the device. For example, if this extra is set
1016 * to true then an image picker should not show any pictures that are available
1017 * from a remote server but not already on the local device (thus requiring
1018 * they be downloaded when opened).
1019 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001020 * If the caller can handle multiple returned items (the user performing
1021 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1022 * to indicate this.
1023 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1025 * that no URI is supplied in the intent, as there are no constraints on
1026 * where the returned data originally comes from. You may also include the
1027 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001028 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001029 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1030 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001031 * <p>
1032 * Output: The URI of the item that was picked. This must be a content:
1033 * URI so that any receiver can access it.
1034 */
1035 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1036 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1037 /**
1038 * Activity Action: Dial a number as specified by the data. This shows a
1039 * UI with the number being dialed, allowing the user to explicitly
1040 * initiate the call.
1041 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1042 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1043 * number.
1044 * <p>Output: nothing.
1045 */
1046 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1047 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1048 /**
1049 * Activity Action: Perform a call to someone specified by the data.
1050 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1051 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1052 * number.
1053 * <p>Output: nothing.
1054 *
1055 * <p>Note: there will be restrictions on which applications can initiate a
1056 * call; most applications should use the {@link #ACTION_DIAL}.
1057 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1058 * numbers. Applications can <strong>dial</strong> emergency numbers using
1059 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001060 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001061 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001062 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001063 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001064 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 */
1066 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1067 public static final String ACTION_CALL = "android.intent.action.CALL";
1068 /**
1069 * Activity Action: Perform a call to an emergency number specified by the
1070 * data.
1071 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1072 * tel: URI of an explicit phone number.
1073 * <p>Output: nothing.
1074 * @hide
1075 */
1076 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1077 /**
1078 * Activity action: Perform a call to any number (emergency or not)
1079 * specified by the data.
1080 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1081 * tel: URI of an explicit phone number.
1082 * <p>Output: nothing.
1083 * @hide
1084 */
1085 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1086 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001087 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1088 * sending this intent is a no-op.
1089 * <p>Input: No data should be specified. get*Extra may have an optional
1090 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1091 * send the activation result.
1092 * <p>Output: nothing.
1093 * @hide
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1097 "android.intent.action.SIM_ACTIVATION_REQUEST";
1098 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001099 * Activity Action: Send a message to someone specified by the data.
1100 * <p>Input: {@link #getData} is URI describing the target.
1101 * <p>Output: nothing.
1102 */
1103 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1104 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1105 /**
1106 * Activity Action: Deliver some data to someone else. Who the data is
1107 * being delivered to is not specified; it is up to the receiver of this
1108 * action to ask the user where the data should be sent.
1109 * <p>
1110 * When launching a SEND intent, you should usually wrap it in a chooser
1111 * (through {@link #createChooser}), which will give the proper interface
1112 * for the user to pick how to send your data and allow you to specify
1113 * a prompt indicating what they are doing.
1114 * <p>
1115 * Input: {@link #getType} is the MIME type of the data being sent.
1116 * get*Extra can have either a {@link #EXTRA_TEXT}
1117 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1118 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1119 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1120 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001121 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1122 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1123 * your text with HTML formatting.
1124 * <p>
1125 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1126 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1127 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1128 * content: URIs and other advanced features of {@link ClipData}. If
1129 * using this approach, you still must supply the same data through the
1130 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1131 * for compatibility with old applications. If you don't set a ClipData,
1132 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001133 * <p>
1134 * Optional standard extras, which may be interpreted by some recipients as
1135 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1136 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1137 * <p>
1138 * Output: nothing.
1139 */
1140 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1141 public static final String ACTION_SEND = "android.intent.action.SEND";
1142 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001143 * Activity Action: Deliver multiple data to someone else.
1144 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001145 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001146 * <p>
1147 * Input: {@link #getType} is the MIME type of the data being sent.
1148 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001149 * #EXTRA_STREAM} field, containing the data to be sent. If using
1150 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1151 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001152 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001153 * Multiple types are supported, and receivers should handle mixed types
1154 * whenever possible. The right way for the receiver to check them is to
1155 * use the content resolver on each URI. The intent sender should try to
1156 * put the most concrete mime type in the intent type, but it can fall
1157 * back to {@literal <type>/*} or {@literal *}/* as needed.
1158 * <p>
1159 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1160 * be image/jpg, but if you are sending image/jpg and image/png, then the
1161 * intent's type should be image/*.
1162 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001163 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1164 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1165 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1166 * content: URIs and other advanced features of {@link ClipData}. If
1167 * using this approach, you still must supply the same data through the
1168 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1169 * for compatibility with old applications. If you don't set a ClipData,
1170 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1171 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001172 * Optional standard extras, which may be interpreted by some recipients as
1173 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1174 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1175 * <p>
1176 * Output: nothing.
1177 */
1178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1179 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1180 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001181 * Activity Action: Handle an incoming phone call.
1182 * <p>Input: nothing.
1183 * <p>Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1187 /**
1188 * Activity Action: Insert an empty item into the given container.
1189 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1190 * in which to place the data.
1191 * <p>Output: URI of the new data that was created.
1192 */
1193 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1194 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1195 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001196 * Activity Action: Create a new item in the given container, initializing it
1197 * from the current contents of the clipboard.
1198 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1199 * in which to place the data.
1200 * <p>Output: URI of the new data that was created.
1201 */
1202 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1203 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1204 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001205 * Activity Action: Delete the given data from its container.
1206 * <p>Input: {@link #getData} is URI of data to be deleted.
1207 * <p>Output: nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1211 /**
1212 * Activity Action: Run the data, whatever that means.
1213 * <p>Input: ? (Note: this is currently specific to the test harness.)
1214 * <p>Output: nothing.
1215 */
1216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1217 public static final String ACTION_RUN = "android.intent.action.RUN";
1218 /**
1219 * Activity Action: Perform a data synchronization.
1220 * <p>Input: ?
1221 * <p>Output: ?
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1225 /**
1226 * Activity Action: Pick an activity given an intent, returning the class
1227 * selected.
1228 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1229 * used with {@link PackageManager#queryIntentActivities} to determine the
1230 * set of activities from which to pick.
1231 * <p>Output: Class name of the activity that was selected.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1235 /**
1236 * Activity Action: Perform a search.
1237 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1238 * is the text to search for. If empty, simply
1239 * enter your search results Activity with the search UI activated.
1240 * <p>Output: nothing.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1244 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001245 * Activity Action: Start the platform-defined tutorial
1246 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1247 * is the text to search for. If empty, simply
1248 * enter your search results Activity with the search UI activated.
1249 * <p>Output: nothing.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001254 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001255 * <p>
1256 * Input: {@link android.app.SearchManager#QUERY
1257 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1258 * a url starts with http or https, the site will be opened. If it is plain
1259 * text, Google search will be applied.
1260 * <p>
1261 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001265
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001266 /**
Jim Miller07994402012-05-02 14:22:27 -07001267 * Activity Action: Perform assist action.
1268 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001269 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1270 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001271 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1272 * information.
Jim Miller07994402012-05-02 14:22:27 -07001273 * Output: nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001277
1278 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001279 * Activity Action: Perform voice assist action.
1280 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001281 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1282 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001283 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001284 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001285 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1289
1290 /**
Adam Skory7140a252013-09-11 12:04:58 +01001291 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1292 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001293 */
1294 public static final String EXTRA_ASSIST_PACKAGE
1295 = "android.intent.extra.ASSIST_PACKAGE";
1296
1297 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001298 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1299 * application package at the time the assist was invoked.
1300 */
1301 public static final String EXTRA_ASSIST_UID
1302 = "android.intent.extra.ASSIST_UID";
1303
1304 /**
Adam Skory7140a252013-09-11 12:04:58 +01001305 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1306 * information supplied by the current foreground app at the time of the assist request.
1307 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001308 */
1309 public static final String EXTRA_ASSIST_CONTEXT
1310 = "android.intent.extra.ASSIST_CONTEXT";
1311
Jim Miller07994402012-05-02 14:22:27 -07001312 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001313 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1314 * keyboard as the primary input device for assistance.
1315 */
1316 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1317 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1318
1319 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001320 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1321 * that was used to invoke the assist.
1322 */
1323 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1324 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1325
1326 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001327 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 * <p>Input: Nothing.
1329 * <p>Output: nothing.
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1333 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001334 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001335 * <p>Input: Nothing.
1336 * <p>Output: Nothing.
1337 */
1338 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1339 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1340
1341 /**
1342 * Activity Action: Show activity for reporting a bug.
1343 * <p>Input: Nothing.
1344 * <p>Output: Nothing.
1345 */
1346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1347 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1348
1349 /**
1350 * Activity Action: Main entry point for factory tests. Only used when
1351 * the device is booting in factory test node. The implementing package
1352 * must be installed in the system image.
1353 * <p>Input: nothing
1354 * <p>Output: nothing
1355 */
1356 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1357
1358 /**
1359 * Activity Action: The user pressed the "call" button to go to the dialer
1360 * or other appropriate UI for placing a call.
1361 * <p>Input: Nothing.
1362 * <p>Output: Nothing.
1363 */
1364 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1365 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1366
1367 /**
1368 * Activity Action: Start Voice Command.
1369 * <p>Input: Nothing.
1370 * <p>Output: Nothing.
1371 */
1372 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1373 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001374
1375 /**
1376 * Activity Action: Start action associated with long pressing on the
1377 * search key.
1378 * <p>Input: Nothing.
1379 * <p>Output: Nothing.
1380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001383
Jacek Surazski86b6c532009-05-13 14:38:28 +02001384 /**
1385 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1386 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001387 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001388 * <p>Input: No data is specified. The bug report is passed in using
1389 * an {@link #EXTRA_BUG_REPORT} field.
1390 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001391 *
1392 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001396
1397 /**
1398 * Activity Action: Show power usage information to the user.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 */
1402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1403 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001404
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001405 /**
1406 * Activity Action: Setup wizard to launch after a platform update. This
1407 * activity should have a string meta-data field associated with it,
1408 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1409 * the platform for setup. The activity will be launched only if
1410 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1411 * same value.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 * @hide
1415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001418
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001419 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001420 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1421 * <p>Input: Nothing.
1422 * <p>Output: Nothing.
1423 * @hide
1424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1427 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1428
1429 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001430 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1431 * <p>Input: Nothing.
1432 * <p>Output: Nothing.
1433 * @hide
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1437 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1438
1439 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001440 * Activity Action: Show settings for managing network data usage of a
1441 * specific application. Applications should define an activity that offers
1442 * options to control data usage.
1443 */
1444 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1445 public static final String ACTION_MANAGE_NETWORK_USAGE =
1446 "android.intent.action.MANAGE_NETWORK_USAGE";
1447
1448 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001449 * Activity Action: Launch application installer.
1450 * <p>
Todd Kennedy9cc589a2016-08-18 16:23:17 -07001451 * Input: The data must be a content: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001452 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1453 * you can also use "package:<package-name>" to install an application for the
1454 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001455 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1456 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1457 * <p>
1458 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1459 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001460 * <p>
1461 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1462 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1463 * in order to launch the application installer.
1464 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 *
1466 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1467 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1468 * @see #EXTRA_RETURN_RESULT
1469 */
1470 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1471 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1472
1473 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001474 * Activity Action: Launch ephemeral installer.
1475 * <p>
1476 * Input: The data must be a http: URI that the ephemeral application is registered
1477 * to handle.
1478 * <p class="note">
1479 * This is a protected intent that can only be sent by the system.
1480 * </p>
1481 *
1482 * @hide
1483 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001484 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1485 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1486 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1487
1488 /**
1489 * Service Action: Resolve ephemeral application.
1490 * <p>
1491 * The system will have a persistent connection to this service.
1492 * This is a protected intent that can only be sent by the system.
1493 * </p>
1494 *
1495 * @hide
1496 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001497 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1498 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1499 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1500
1501 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001502 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1503 * package. Specifies the installer package name; this package will receive the
1504 * {@link #ACTION_APP_ERROR} intent.
1505 */
1506 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1507 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1508
1509 /**
1510 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1511 * package. Specifies that the application being installed should not be
1512 * treated as coming from an unknown source, but as coming from the app
1513 * invoking the Intent. For this to work you must start the installer with
1514 * startActivityForResult().
1515 */
1516 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1517 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1518
1519 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001520 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1521 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001522 * data field originated from.
1523 */
rich cannings706e8ba2012-08-20 13:20:14 -07001524 public static final String EXTRA_ORIGINATING_URI
1525 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001526
1527 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001528 * This extra can be used with any Intent used to launch an activity, supplying information
1529 * about who is launching that activity. This field contains a {@link android.net.Uri}
1530 * object, typically an http: or https: URI of the web site that the referral came from;
1531 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1532 * a native application that it came from.
1533 *
1534 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1535 * instead of directly retrieving the extra. It is also valid for applications to
1536 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1537 * a string, not a Uri; the field here, if supplied, will always take precedence,
1538 * however.</p>
1539 *
1540 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001541 */
1542 public static final String EXTRA_REFERRER
1543 = "android.intent.extra.REFERRER";
1544
1545 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001546 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1547 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1548 * not be created, in particular when Intent extras are supplied through the
1549 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1550 * schemes.
1551 *
1552 * @see #EXTRA_REFERRER
1553 */
1554 public static final String EXTRA_REFERRER_NAME
1555 = "android.intent.extra.REFERRER_NAME";
1556
1557 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001558 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001559 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001560 * @hide
1561 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001562 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001563 public static final String EXTRA_ORIGINATING_UID
1564 = "android.intent.extra.ORIGINATING_UID";
1565
1566 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001567 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1568 * package. Tells the installer UI to skip the confirmation with the user
1569 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001570 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1571 * will no longer show an interstitial message about updating existing
1572 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001573 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001574 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001575 public static final String EXTRA_ALLOW_REPLACE
1576 = "android.intent.extra.ALLOW_REPLACE";
1577
1578 /**
1579 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1580 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1581 * return to the application the result code of the install/uninstall. The returned result
1582 * code will be {@link android.app.Activity#RESULT_OK} on success or
1583 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1584 */
1585 public static final String EXTRA_RETURN_RESULT
1586 = "android.intent.extra.RETURN_RESULT";
1587
1588 /**
1589 * Package manager install result code. @hide because result codes are not
1590 * yet ready to be exposed.
1591 */
1592 public static final String EXTRA_INSTALL_RESULT
1593 = "android.intent.extra.INSTALL_RESULT";
1594
1595 /**
1596 * Activity Action: Launch application uninstaller.
1597 * <p>
1598 * Input: The data must be a package: URI whose scheme specific part is
1599 * the package name of the current installed package to be uninstalled.
1600 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1601 * <p>
1602 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1603 * succeeded.
1604 */
1605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1606 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1607
1608 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001609 * Specify whether the package should be uninstalled for all users.
1610 * @hide because these should not be part of normal application flow.
1611 */
1612 public static final String EXTRA_UNINSTALL_ALL_USERS
1613 = "android.intent.extra.UNINSTALL_ALL_USERS";
1614
1615 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001616 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1617 * describing the last run version of the platform that was setup.
1618 * @hide
1619 */
1620 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1621
Svet Ganov3695b8a2015-03-24 16:30:25 -07001622 /**
1623 * Activity action: Launch UI to manage the permissions of an app.
1624 * <p>
1625 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1626 * will be managed by the launched UI.
1627 * </p>
1628 * <p>
1629 * Output: Nothing.
1630 * </p>
1631 *
1632 * @see #EXTRA_PACKAGE_NAME
1633 *
1634 * @hide
1635 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001636 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001637 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1638 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1639 "android.intent.action.MANAGE_APP_PERMISSIONS";
1640
1641 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001642 * Activity action: Launch UI to manage permissions.
1643 * <p>
1644 * Input: Nothing.
1645 * </p>
1646 * <p>
1647 * Output: Nothing.
1648 * </p>
1649 *
1650 * @hide
1651 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001652 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1654 public static final String ACTION_MANAGE_PERMISSIONS =
1655 "android.intent.action.MANAGE_PERMISSIONS";
1656
1657 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001658 * Activity action: Launch UI to review permissions for an app.
1659 * The system uses this intent if permission review for apps not
1660 * supporting the new runtime permissions model is enabled. In
1661 * this mode a permission review is required before any of the
1662 * app components can run.
1663 * <p>
1664 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1665 * permissions will be reviewed (mandatory).
1666 * </p>
1667 * <p>
1668 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1669 * be fired after the permission review (optional).
1670 * </p>
1671 * <p>
1672 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1673 * be invoked after the permission review (optional).
1674 * </p>
1675 * <p>
1676 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1677 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1678 * </p>
1679 * <p>
1680 * Output: Nothing.
1681 * </p>
1682 *
1683 * @see #EXTRA_PACKAGE_NAME
1684 * @see #EXTRA_INTENT
1685 * @see #EXTRA_REMOTE_CALLBACK
1686 * @see #EXTRA_RESULT_NEEDED
1687 *
1688 * @hide
1689 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001690 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1692 public static final String ACTION_REVIEW_PERMISSIONS =
1693 "android.intent.action.REVIEW_PERMISSIONS";
1694
1695 /**
1696 * Intent extra: A callback for reporting remote result as a bundle.
1697 * <p>
1698 * Type: IRemoteCallback
1699 * </p>
1700 *
1701 * @hide
1702 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001703 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001704 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1705
1706 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001707 * Intent extra: An app package name.
1708 * <p>
1709 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001710 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001711 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001712 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001713 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1714
1715 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001716 * Intent extra: An extra for specifying whether a result is needed.
1717 * <p>
1718 * Type: boolean
1719 * </p>
1720 *
1721 * @hide
1722 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001723 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001724 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1725
1726 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001727 * Activity action: Launch UI to manage which apps have a given permission.
1728 * <p>
1729 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1730 * to which will be managed by the launched UI.
1731 * </p>
1732 * <p>
1733 * Output: Nothing.
1734 * </p>
1735 *
1736 * @see #EXTRA_PERMISSION_NAME
1737 *
1738 * @hide
1739 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001740 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001741 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1742 public static final String ACTION_MANAGE_PERMISSION_APPS =
1743 "android.intent.action.MANAGE_PERMISSION_APPS";
1744
1745 /**
1746 * Intent extra: The name of a permission.
1747 * <p>
1748 * Type: String
1749 * </p>
1750 *
1751 * @hide
1752 */
1753 @SystemApi
1754 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1755
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001756 // ---------------------------------------------------------------------
1757 // ---------------------------------------------------------------------
1758 // Standard intent broadcast actions (see action variable).
1759
1760 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001761 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1762 * <p>
1763 * For historical reasons, the name of this broadcast action refers to the power
1764 * state of the screen but it is actually sent in response to changes in the
1765 * overall interactive state of the device.
1766 * </p><p>
1767 * This broadcast is sent when the device becomes non-interactive which may have
1768 * nothing to do with the screen turning off. To determine the
1769 * actual state of the screen, use {@link android.view.Display#getState}.
1770 * </p><p>
1771 * See {@link android.os.PowerManager#isInteractive} for details.
1772 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001773 * You <em>cannot</em> receive this through components declared in
1774 * manifests, only by explicitly registering for it with
1775 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1776 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001777 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001778 * <p class="note">This is a protected intent that can only be sent
1779 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001780 */
1781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1782 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001784 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001785 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1786 * <p>
1787 * For historical reasons, the name of this broadcast action refers to the power
1788 * state of the screen but it is actually sent in response to changes in the
1789 * overall interactive state of the device.
1790 * </p><p>
1791 * This broadcast is sent when the device becomes interactive which may have
1792 * nothing to do with the screen turning on. To determine the
1793 * actual state of the screen, use {@link android.view.Display#getState}.
1794 * </p><p>
1795 * See {@link android.os.PowerManager#isInteractive} for details.
1796 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001797 * You <em>cannot</em> receive this through components declared in
1798 * manifests, only by explicitly registering for it with
1799 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1800 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001801 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001802 * <p class="note">This is a protected intent that can only be sent
1803 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001804 */
1805 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1806 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001807
1808 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001809 * Broadcast Action: Sent after the system stops dreaming.
1810 *
1811 * <p class="note">This is a protected intent that can only be sent by the system.
1812 * It is only sent to registered receivers.</p>
1813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1816
1817 /**
1818 * Broadcast Action: Sent after the system starts dreaming.
1819 *
1820 * <p class="note">This is a protected intent that can only be sent by the system.
1821 * It is only sent to registered receivers.</p>
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1825
1826 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001827 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001828 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001829 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001830 * <p class="note">This is a protected intent that can only be sent
1831 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001834 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001835
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 /**
1837 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001838 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001839 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1841 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1848 /**
1849 * Broadcast Action: The time was set.
1850 */
1851 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1852 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1853 /**
1854 * Broadcast Action: The date has changed.
1855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1858 /**
1859 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1860 * <ul>
1861 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1862 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001863 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001864 * <p class="note">This is a protected intent that can only be sent
1865 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1869 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001870 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1871 * DNS entries should be tossed.
1872 * @hide
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1876 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001877 * Alarm Changed Action: This is broadcast when the AlarmClock
1878 * application's alarm is set or unset. It is used by the
1879 * AlarmClock application and the StatusBar service.
1880 * @hide
1881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001884
1885 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001886 * Broadcast Action: This is broadcast once, after the user has finished
1887 * booting, but while still in the "locked" state. It can be used to perform
1888 * application-specific initialization, such as installing alarms. You must
1889 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1890 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001891 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001892 * This broadcast is sent immediately at boot by all devices (regardless of
1893 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1894 * higher. Upon receipt of this broadcast, the user is still locked and only
1895 * device-protected storage can be accessed safely. If you want to access
1896 * credential-protected storage, you need to wait for the user to be
1897 * unlocked (typically by entering their lock pattern or PIN for the first
1898 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1899 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1900 * <p>
1901 * To receive this broadcast, your receiver component must be marked as
1902 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001903 * <p class="note">
1904 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001905 *
1906 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1910
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001912 * Broadcast Action: This is broadcast once, after the user has finished
1913 * booting. It can be used to perform application-specific initialization,
1914 * such as installing alarms. You must hold the
1915 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1916 * order to receive this broadcast.
1917 * <p>
1918 * This broadcast is sent at boot by all devices (both with and without
1919 * direct boot support). Upon receipt of this broadcast, the user is
1920 * unlocked and both device-protected and credential-protected storage can
1921 * accessed safely.
1922 * <p>
1923 * If you need to run while the user is still locked (before they've entered
1924 * their lock pattern or PIN for the first time), you can listen for the
1925 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1926 * <p class="note">
1927 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001931
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 /**
1933 * Broadcast Action: This is broadcast when a user action should request a
1934 * temporary system dialog to dismiss. Some examples of temporary system
1935 * dialogs are the notification window-shade and the recent tasks dialog.
1936 */
1937 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1938 /**
1939 * Broadcast Action: Trigger the download and eventual installation
1940 * of a package.
1941 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001942 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001943 * <p class="note">This is a protected intent that can only be sent
1944 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001945 *
1946 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001948 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1951 /**
1952 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001953 * device. The data contains the name of the package. Note that the
1954 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001955 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001956 * <ul>
1957 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1958 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1959 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1960 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001961 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001962 * <p class="note">This is a protected intent that can only be sent
1963 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1967 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001968 * Broadcast Action: A new version of an application package has been
1969 * installed, replacing an existing version that was previously installed.
1970 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001971 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001972 * <ul>
1973 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1974 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001975 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001976 * <p class="note">This is a protected intent that can only be sent
1977 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001978 */
1979 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1980 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1981 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001982 * Broadcast Action: A new version of your application has been installed
1983 * over an existing one. This is only sent to the application that was
1984 * replaced. It does not contain any additional data; to receive it, just
1985 * use an intent filter for this action.
1986 *
1987 * <p class="note">This is a protected intent that can only be sent
1988 * by the system.
1989 */
1990 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1991 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 * Broadcast Action: An existing application package has been removed from
1994 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07001995 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001996 * <ul>
1997 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1998 * to the package.
1999 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2000 * application -- data and code -- is being removed.
2001 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2002 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2003 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002004 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002005 * <p class="note">This is a protected intent that can only be sent
2006 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2010 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002011 * Broadcast Action: An existing application package has been completely
2012 * removed from the device. The data contains the name of the package.
2013 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2014 * {@link #EXTRA_DATA_REMOVED} is true and
2015 * {@link #EXTRA_REPLACING} is false of that broadcast.
2016 *
2017 * <ul>
2018 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2019 * to the package.
2020 * </ul>
2021 *
2022 * <p class="note">This is a protected intent that can only be sent
2023 * by the system.
2024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_PACKAGE_FULLY_REMOVED
2027 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2028 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002029 * Broadcast Action: An existing application package has been changed (for
2030 * example, a component has been enabled or disabled). The data contains
2031 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002032 * <ul>
2033 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002034 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002035 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002036 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2037 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002039 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002040 * <p class="note">This is a protected intent that can only be sent
2041 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002042 */
2043 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2044 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2045 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002046 * @hide
2047 * Broadcast Action: Ask system services if there is any reason to
2048 * restart the given package. The data contains the name of the
2049 * package.
2050 * <ul>
2051 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2052 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2053 * </ul>
2054 *
2055 * <p class="note">This is a protected intent that can only be sent
2056 * by the system.
2057 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002058 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2061 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002062 * Broadcast Action: The user has restarted a package, and all of its
2063 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002065 * be removed. Note that the restarted package does <em>not</em>
2066 * receive this broadcast.
2067 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002068 * <ul>
2069 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2070 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002071 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002072 * <p class="note">This is a protected intent that can only be sent
2073 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2077 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 * Broadcast Action: The user has cleared the data of a package. This should
2079 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002080 * its persistent data is erased and this broadcast sent.
2081 * Note that the cleared package does <em>not</em>
2082 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 * <ul>
2084 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2085 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002086 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2092 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002093 * Broadcast Action: Packages have been suspended.
2094 * <p>Includes the following extras:
2095 * <ul>
2096 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2097 * </ul>
2098 *
2099 * <p class="note">This is a protected intent that can only be sent
2100 * by the system. It is only sent to registered receivers.
2101 */
2102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2103 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2104 /**
2105 * Broadcast Action: Packages have been unsuspended.
2106 * <p>Includes the following extras:
2107 * <ul>
2108 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2109 * </ul>
2110 *
2111 * <p class="note">This is a protected intent that can only be sent
2112 * by the system. It is only sent to registered receivers.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2116 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002117 * Broadcast Action: A user ID has been removed from the system. The user
2118 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002119 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002122 */
2123 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2124 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002125
2126 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002127 * Broadcast Action: Sent to the installer package of an application when
2128 * that application is first launched (that is the first time it is moved
2129 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002130 *
2131 * <p class="note">This is a protected intent that can only be sent
2132 * by the system.
2133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2136
2137 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002138 * Broadcast Action: Sent to the system package verifier when a package
2139 * needs to be verified. The data contains the package URI.
2140 * <p class="note">
2141 * This is a protected intent that can only be sent by the system.
2142 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2146
2147 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002148 * Broadcast Action: Sent to the system package verifier when a package is
2149 * verified. The data contains the package URI.
2150 * <p class="note">
2151 * This is a protected intent that can only be sent by the system.
2152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2155
2156 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002157 * Broadcast Action: Sent to the system intent filter verifier when an
2158 * intent filter needs to be verified. The data contains the filter data
2159 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002160 * <p class="note">
2161 * This is a protected intent that can only be sent by the system.
2162 * </p>
2163 *
2164 * @hide
2165 */
2166 @SystemApi
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2169
2170 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002171 * Broadcast Action: Resources for a set of packages (which were
2172 * previously unavailable) are currently
2173 * available since the media on which they exist is available.
2174 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2175 * list of packages whose availability changed.
2176 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2177 * list of uids of packages whose availability changed.
2178 * Note that the
2179 * packages in this list do <em>not</em> receive this broadcast.
2180 * The specified set of packages are now available on the system.
2181 * <p>Includes the following extras:
2182 * <ul>
2183 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2184 * whose resources(were previously unavailable) are currently available.
2185 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2186 * packages whose resources(were previously unavailable)
2187 * are currently available.
2188 * </ul>
2189 *
2190 * <p class="note">This is a protected intent that can only be sent
2191 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002192 */
2193 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002194 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2195 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002196
2197 /**
2198 * Broadcast Action: Resources for a set of packages are currently
2199 * unavailable since the media on which they exist is unavailable.
2200 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2201 * list of packages whose availability changed.
2202 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2203 * list of uids of packages whose availability changed.
2204 * The specified set of packages can no longer be
2205 * launched and are practically unavailable on the system.
2206 * <p>Inclues the following extras:
2207 * <ul>
2208 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2209 * whose resources are no longer available.
2210 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2211 * whose resources are no longer available.
2212 * </ul>
2213 *
2214 * <p class="note">This is a protected intent that can only be sent
2215 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002216 */
2217 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002218 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002219 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002220
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002221 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002222 * Broadcast Action: preferred activities have changed *explicitly*.
2223 *
2224 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2225 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2226 * be sent.
2227 *
2228 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2229 *
2230 * @hide
2231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2233 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2234 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2235
2236
2237 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002238 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002239 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002240 * This should <em>only</em> be used to determine when the wallpaper
2241 * has changed to show the new wallpaper to the user. You should certainly
2242 * never, in response to this, change the wallpaper or other attributes of
2243 * it such as the suggested size. That would be crazy, right? You'd cause
2244 * all kinds of loops, especially if other apps are doing similar things,
2245 * right? Of course. So please don't do this.
2246 *
2247 * @deprecated Modern applications should use
2248 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2249 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2250 * shown behind their UI, rather than watching for this broadcast and
2251 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002252 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002253 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002254 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2255 /**
2256 * Broadcast Action: The current device {@link android.content.res.Configuration}
2257 * (orientation, locale, etc) has changed. When such a change happens, the
2258 * UIs (view hierarchy) will need to be rebuilt based on this new
2259 * information; for the most part, applications don't need to worry about
2260 * this, because the system will take care of stopping and restarting the
2261 * application to make sure it sees the new changes. Some system code that
2262 * can not be restarted will need to watch for this action and handle it
2263 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002264 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002265 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002266 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002267 * in manifests, only by explicitly registering for it with
2268 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2269 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002270 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002271 * <p class="note">This is a protected intent that can only be sent
2272 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002273 *
2274 * @see android.content.res.Configuration
2275 */
2276 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2277 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2278 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002279 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002280 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
2283 */
2284 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2285 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2286 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002287 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2288 * charging state, level, and other information about the battery.
2289 * See {@link android.os.BatteryManager} for documentation on the
2290 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002291 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002292 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002293 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002294 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002295 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002296 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2297 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2298 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2299 * broadcasts that are sent and can be received through manifest
2300 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002301 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002302 * <p class="note">This is a protected intent that can only be sent
2303 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 */
2305 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2306 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2307 /**
2308 * Broadcast Action: Indicates low battery condition on the device.
2309 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002310 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * <p class="note">This is a protected intent that can only be sent
2312 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2316 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002317 * Broadcast Action: Indicates the battery is now okay after being low.
2318 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2319 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002321 * <p class="note">This is a protected intent that can only be sent
2322 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002323 */
2324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2325 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2326 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002327 * Broadcast Action: External power has been connected to the device.
2328 * This is intended for applications that wish to register specifically to this notification.
2329 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2330 * stay active to receive this notification. This action can be used to implement actions
2331 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002332 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002333 * <p class="note">This is a protected intent that can only be sent
2334 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002335 */
2336 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002337 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002338 /**
2339 * Broadcast Action: External power has been removed from the device.
2340 * This is intended for applications that wish to register specifically to this notification.
2341 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2342 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002343 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002344 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002345 * <p class="note">This is a protected intent that can only be sent
2346 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002347 */
2348 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002349 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002350 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002351 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002352 * Broadcast Action: Device is shutting down.
2353 * This is broadcast when the device is being shut down (completely turned
2354 * off, not sleeping). Once the broadcast is complete, the final shutdown
2355 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002356 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002357 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002358 * <p class="note">This is a protected intent that can only be sent
2359 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002360 * <p>May include the following extras:
2361 * <ul>
2362 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2363 * shutdown is only for userspace processes. If not set, assumed to be false.
2364 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002365 */
2366 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002367 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002368 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002369 * Activity Action: Start this activity to request system shutdown.
2370 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002371 * to request confirmation from the user before shutting down. The optional boolean
2372 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2373 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002374 *
2375 * <p class="note">This is a protected intent that can only be sent
2376 * by the system.
2377 *
2378 * {@hide}
2379 */
2380 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2381 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002382 * Broadcast Action: A sticky broadcast that indicates low memory
2383 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002384 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002385 * <p class="note">This is a protected intent that can only be sent
2386 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002387 */
2388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2389 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2390 /**
2391 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002392 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002393 * <p class="note">This is a protected intent that can only be sent
2394 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2397 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2398 /**
Jake Hambybb371632010-08-23 18:16:48 -07002399 * Broadcast Action: A sticky broadcast that indicates a memory full
2400 * condition on the device. This is intended for activities that want
2401 * to be able to fill the data partition completely, leaving only
2402 * enough free space to prevent system-wide SQLite failures.
2403 *
2404 * <p class="note">This is a protected intent that can only be sent
2405 * by the system.
2406 *
2407 * {@hide}
2408 */
2409 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2410 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2411 /**
2412 * Broadcast Action: Indicates memory full condition on the device
2413 * no longer exists.
2414 *
2415 * <p class="note">This is a protected intent that can only be sent
2416 * by the system.
2417 *
2418 * {@hide}
2419 */
2420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2421 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2422 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002423 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2424 * and package management should be started.
2425 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2426 * notification.
2427 */
2428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2429 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2430 /**
2431 * Broadcast Action: The device has entered USB Mass Storage mode.
2432 * This is used mainly for the USB Settings panel.
2433 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2434 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002435 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002436 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002437 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002438 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2439
2440 /**
2441 * Broadcast Action: The device has exited USB Mass Storage mode.
2442 * This is used mainly for the USB Settings panel.
2443 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2444 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002445 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002446 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002447 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002448 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2449
2450 /**
2451 * Broadcast Action: External media has been removed.
2452 * The path to the mount point for the removed media is contained in the Intent.mData field.
2453 */
2454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2455 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2456
2457 /**
2458 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002459 * 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 -07002460 */
2461 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2462 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2463
2464 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002465 * Broadcast Action: External media is present, and being disk-checked
2466 * 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 -08002467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2470
2471 /**
2472 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2473 * 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 -08002474 */
2475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2476 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2477
2478 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002479 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002480 * 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 -07002481 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2482 * media was mounted read only.
2483 */
2484 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2485 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2486
2487 /**
2488 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002489 * 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 -07002490 */
2491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2492 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2493
2494 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002495 * Broadcast Action: External media is no longer being shared via USB mass storage.
2496 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2497 *
2498 * @hide
2499 */
2500 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2501
2502 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002503 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2504 * The path to the mount point for the removed media is contained in the Intent.mData field.
2505 */
2506 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2507 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2508
2509 /**
2510 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002511 * 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 -07002512 */
2513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2514 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2515
2516 /**
2517 * Broadcast Action: User has expressed the desire to remove the external storage media.
2518 * Applications should close all files they have open within the mount point when they receive this intent.
2519 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2520 */
2521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2522 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2523
2524 /**
2525 * Broadcast Action: The media scanner has started scanning a directory.
2526 * The path to the directory being scanned is contained in the Intent.mData field.
2527 */
2528 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2529 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2530
2531 /**
2532 * Broadcast Action: The media scanner has finished scanning a directory.
2533 * The path to the scanned directory is contained in the Intent.mData field.
2534 */
2535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2536 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2537
2538 /**
2539 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2540 * The path to the file is contained in the Intent.mData field.
2541 */
2542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2543 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2544
2545 /**
2546 * Broadcast Action: The "Media Button" was pressed. Includes a single
2547 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2548 * caused the broadcast.
2549 */
2550 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2551 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2552
2553 /**
2554 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2555 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2556 * caused the broadcast.
2557 */
2558 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2559 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2560
2561 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2562 // location; they are not general-purpose actions.
2563
2564 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002565 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2569 "android.intent.action.GTALK_CONNECTED";
2570
2571 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002572 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002573 */
2574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2575 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2576 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002577
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002578 /**
2579 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002580 */
2581 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2582 public static final String ACTION_INPUT_METHOD_CHANGED =
2583 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002584
2585 /**
2586 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2587 * more radios have been turned off or on. The intent will have the following extra value:</p>
2588 * <ul>
2589 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2590 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2591 * turned off</li>
2592 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002593 *
Peng Xua35b5532016-01-20 00:05:45 -08002594 * <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 -07002595 */
2596 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2597 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2598
2599 /**
2600 * Broadcast Action: Some content providers have parts of their namespace
2601 * where they publish new events or items that the user may be especially
2602 * interested in. For these things, they may broadcast this action when the
2603 * set of interesting items change.
2604 *
2605 * For example, GmailProvider sends this notification when the set of unread
2606 * mail in the inbox changes.
2607 *
2608 * <p>The data of the intent identifies which part of which provider
2609 * changed. When queried through the content resolver, the data URI will
2610 * return the data set in question.
2611 *
2612 * <p>The intent will have the following extra values:
2613 * <ul>
2614 * <li><em>count</em> - The number of items in the data set. This is the
2615 * same as the number of items in the cursor returned by querying the
2616 * data URI. </li>
2617 * </ul>
2618 *
2619 * This intent will be sent at boot (if the count is non-zero) and when the
2620 * data set changes. It is possible for the data set to change without the
2621 * count changing (for example, if a new unread message arrives in the same
2622 * sync operation in which a message is archived). The phone should still
2623 * ring/vibrate/etc as normal in this case.
2624 */
2625 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2626 public static final String ACTION_PROVIDER_CHANGED =
2627 "android.intent.action.PROVIDER_CHANGED";
2628
2629 /**
2630 * Broadcast Action: Wired Headset plugged in or unplugged.
2631 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002632 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2633 * and documentation.
2634 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002635 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002636 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002637 */
2638 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002639 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002640
2641 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002642 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2643 * <ul>
2644 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2645 * </ul>
2646 *
2647 * <p class="note">This is a protected intent that can only be sent
2648 * by the system.
2649 *
2650 * @hide
2651 */
2652 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2653 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2654 = "android.intent.action.ADVANCED_SETTINGS";
2655
2656 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002657 * Broadcast Action: Sent after application restrictions are changed.
2658 *
2659 * <p class="note">This is a protected intent that can only be sent
2660 * by the system.</p>
2661 */
2662 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2663 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2664 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2665
2666 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002667 * Broadcast Action: An outgoing call is about to be placed.
2668 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002669 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002670 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002671 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002672 * the phone number originally intended to be dialed.</li>
2673 * </ul>
2674 * <p>Once the broadcast is finished, the resultData is used as the actual
2675 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002676 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002677 * outgoing call in turn: for example, a parental control application
2678 * might verify that the user is authorized to place the call at that
2679 * time, then a number-rewriting application might add an area code if
2680 * one was not specified.</p>
2681 * <p>For consistency, any receiver whose purpose is to prohibit phone
2682 * calls should have a priority of 0, to ensure it will see the final
2683 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002684 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002685 * should have a positive priority.
2686 * Negative priorities are reserved for the system for this broadcast;
2687 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002688 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2689 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002690 * <p>Emergency calls cannot be intercepted using this mechanism, and
2691 * other calls cannot be modified to call emergency numbers using this
2692 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002693 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2694 * call to use their own service instead. Those apps should first prevent
2695 * the call from being placed by setting resultData to <code>null</code>
2696 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002697 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2699 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002700 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002701 * <p class="note">This is a protected intent that can only be sent
2702 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002703 */
2704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2705 public static final String ACTION_NEW_OUTGOING_CALL =
2706 "android.intent.action.NEW_OUTGOING_CALL";
2707
2708 /**
2709 * Broadcast Action: Have the device reboot. This is only for use by
2710 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002711 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002712 * <p class="note">This is a protected intent that can only be sent
2713 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002714 */
2715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2716 public static final String ACTION_REBOOT =
2717 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002718
Wei Huang97ecc9c2009-05-11 17:44:20 -07002719 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002720 * Broadcast Action: A sticky broadcast for changes in the physical
2721 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002722 *
2723 * <p>The intent will have the following extra values:
2724 * <ul>
2725 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002726 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002727 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002728 * <p>This is intended for monitoring the current physical dock state.
2729 * See {@link android.app.UiModeManager} for the normal API dealing with
2730 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002731 */
2732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2733 public static final String ACTION_DOCK_EVENT =
2734 "android.intent.action.DOCK_EVENT";
2735
2736 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002737 * Broadcast Action: A broadcast when idle maintenance can be started.
2738 * This means that the user is not interacting with the device and is
2739 * not expected to do so soon. Typical use of the idle maintenance is
2740 * to perform somehow expensive tasks that can be postponed at a moment
2741 * when they will not degrade user experience.
2742 * <p>
2743 * <p class="note">In order to keep the device responsive in case of an
2744 * unexpected user interaction, implementations of a maintenance task
2745 * should be interruptible. In such a scenario a broadcast with action
2746 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2747 * should not do the maintenance work in
2748 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2749 * maintenance service by {@link Context#startService(Intent)}. Also
2750 * you should hold a wake lock while your maintenance service is running
2751 * to prevent the device going to sleep.
2752 * </p>
2753 * <p>
2754 * <p class="note">This is a protected intent that can only be sent by
2755 * the system.
2756 * </p>
2757 *
2758 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002759 *
2760 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002761 */
2762 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2763 public static final String ACTION_IDLE_MAINTENANCE_START =
2764 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2765
2766 /**
2767 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2768 * This means that the user was not interacting with the device as a result
2769 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2770 * was sent and now the user started interacting with the device. Typical
2771 * use of the idle maintenance is to perform somehow expensive tasks that
2772 * can be postponed at a moment when they will not degrade user experience.
2773 * <p>
2774 * <p class="note">In order to keep the device responsive in case of an
2775 * unexpected user interaction, implementations of a maintenance task
2776 * should be interruptible. Hence, on receiving a broadcast with this
2777 * action, the maintenance task should be interrupted as soon as possible.
2778 * In other words, you should not do the maintenance work in
2779 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2780 * maintenance service that was started on receiving of
2781 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2782 * lock you acquired when your maintenance service started.
2783 * </p>
2784 * <p class="note">This is a protected intent that can only be sent
2785 * by the system.
2786 *
2787 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002788 *
2789 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002790 */
2791 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2792 public static final String ACTION_IDLE_MAINTENANCE_END =
2793 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2794
2795 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002796 * Broadcast Action: a remote intent is to be broadcasted.
2797 *
2798 * A remote intent is used for remote RPC between devices. The remote intent
2799 * is serialized and sent from one device to another device. The receiving
2800 * device parses the remote intent and broadcasts it. Note that anyone can
2801 * broadcast a remote intent. However, if the intent receiver of the remote intent
2802 * does not trust intent broadcasts from arbitrary intent senders, it should require
2803 * the sender to hold certain permissions so only trusted sender's broadcast will be
2804 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002805 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002806 */
2807 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002808 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002809
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002810 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002811 * Broadcast Action: This is broadcast once when the user is booting after a
2812 * system update. It can be used to perform cleanup or upgrades after a
2813 * system update.
2814 * <p>
2815 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2816 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2817 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2818 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002819 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002820 * @hide
2821 */
2822 public static final String ACTION_PRE_BOOT_COMPLETED =
2823 "android.intent.action.PRE_BOOT_COMPLETED";
2824
Amith Yamasani13593602012-03-22 16:16:17 -07002825 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002826 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002827 * on restricted users. The broadcast intent contains an extra
2828 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2829 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2830 * String[] depending on the restriction type.<p/>
2831 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002832 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2833 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2834 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002835 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2836 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002837 * @see RestrictionEntry
2838 */
2839 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2840 "android.intent.action.GET_RESTRICTION_ENTRIES";
2841
2842 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002843 * Sent the first time a user is starting, to allow system apps to
2844 * perform one time initialization. (This will not be seen by third
2845 * party applications because a newly initialized user does not have any
2846 * third party applications installed for it.) This is sent early in
2847 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002848 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2849 * broadcast, since it is part of a visible user interaction; be as quick
2850 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002851 */
2852 public static final String ACTION_USER_INITIALIZE =
2853 "android.intent.action.USER_INITIALIZE";
2854
2855 /**
2856 * Sent when a user switch is happening, causing the process's user to be
2857 * brought to the foreground. This is only sent to receivers registered
2858 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2859 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002860 * foreground. This is sent as a foreground
2861 * broadcast, since it is part of a visible user interaction; be as quick
2862 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002863 */
2864 public static final String ACTION_USER_FOREGROUND =
2865 "android.intent.action.USER_FOREGROUND";
2866
2867 /**
2868 * Sent when a user switch is happening, causing the process's user to be
2869 * sent to the background. This is only sent to receivers registered
2870 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2871 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002872 * background. This is sent as a foreground
2873 * broadcast, since it is part of a visible user interaction; be as quick
2874 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002875 */
2876 public static final String ACTION_USER_BACKGROUND =
2877 "android.intent.action.USER_BACKGROUND";
2878
2879 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002880 * Broadcast sent to the system when a user is added. Carries an extra
2881 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2882 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002883 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002884 * @hide
2885 */
2886 public static final String ACTION_USER_ADDED =
2887 "android.intent.action.USER_ADDED";
2888
2889 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002890 * Broadcast sent by the system when a user is started. Carries an extra
2891 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002892 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002893 * that has been started. This is sent as a foreground
2894 * broadcast, since it is part of a visible user interaction; be as quick
2895 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002896 * @hide
2897 */
2898 public static final String ACTION_USER_STARTED =
2899 "android.intent.action.USER_STARTED";
2900
2901 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002902 * Broadcast sent when a user is in the process of starting. Carries an extra
2903 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2904 * sent to registered receivers, not manifest receivers. It is sent to all
2905 * users (including the one that is being started). You must hold
2906 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2907 * this broadcast. This is sent as a background broadcast, since
2908 * its result is not part of the primary UX flow; to safely keep track of
2909 * started/stopped state of a user you can use this in conjunction with
2910 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2911 * other user state broadcasts since those are foreground broadcasts so can
2912 * execute in a different order.
2913 * @hide
2914 */
2915 public static final String ACTION_USER_STARTING =
2916 "android.intent.action.USER_STARTING";
2917
2918 /**
2919 * Broadcast sent when a user is going to be stopped. Carries an extra
2920 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2921 * sent to registered receivers, not manifest receivers. It is sent to all
2922 * users (including the one that is being stopped). You must hold
2923 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2924 * this broadcast. The user will not stop until all receivers have
2925 * handled the broadcast. This is sent as a background broadcast, since
2926 * its result is not part of the primary UX flow; to safely keep track of
2927 * started/stopped state of a user you can use this in conjunction with
2928 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2929 * other user state broadcasts since those are foreground broadcasts so can
2930 * execute in a different order.
2931 * @hide
2932 */
2933 public static final String ACTION_USER_STOPPING =
2934 "android.intent.action.USER_STOPPING";
2935
2936 /**
2937 * Broadcast sent to the system when a user is stopped. Carries an extra
2938 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2939 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2940 * specific package. This is only sent to registered receivers, not manifest
2941 * receivers. It is sent to all running users <em>except</em> the one that
2942 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002943 * @hide
2944 */
2945 public static final String ACTION_USER_STOPPED =
2946 "android.intent.action.USER_STOPPED";
2947
2948 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002949 * 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 -07002950 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002951 * one that has been removed. The user will not be completely removed until all receivers have
2952 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002953 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002954 * @hide
2955 */
2956 public static final String ACTION_USER_REMOVED =
2957 "android.intent.action.USER_REMOVED";
2958
2959 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002960 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002961 * the userHandle of the user to become the current one. This is only sent to
2962 * registered receivers, not manifest receivers. It is sent to all running users.
2963 * You must hold
2964 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002965 * @hide
2966 */
2967 public static final String ACTION_USER_SWITCHED =
2968 "android.intent.action.USER_SWITCHED";
2969
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002970 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002971 * Broadcast Action: Sent when the credential-encrypted private storage has
2972 * become unlocked for the target user. This is only sent to registered
2973 * receivers, not manifest receivers.
2974 */
2975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2976 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2977
2978 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002979 * Broadcast sent to the system when a user's information changes. Carries an extra
2980 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002981 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002982 * @hide
2983 */
2984 public static final String ACTION_USER_INFO_CHANGED =
2985 "android.intent.action.USER_INFO_CHANGED";
2986
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002987 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002988 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2989 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002990 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2991 * that need to display merged content across both primary and managed profiles need to
2992 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002993 * not manifest receivers.
2994 */
2995 public static final String ACTION_MANAGED_PROFILE_ADDED =
2996 "android.intent.action.MANAGED_PROFILE_ADDED";
2997
2998 /**
2999 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003000 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3001 * Only applications (for example Launchers) that need to display merged content across both
3002 * primary and managed profiles need to worry about this broadcast. This is only sent to
3003 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003004 */
3005 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3006 "android.intent.action.MANAGED_PROFILE_REMOVED";
3007
3008 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003009 * Broadcast sent to the primary user when the credential-encrypted private storage for
3010 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3011 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3012 * Launchers) that need to display merged content across both primary and managed profiles
3013 * need to worry about this broadcast. This is only sent to registered receivers,
3014 * not manifest receivers.
3015 */
3016 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3017 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3018
3019 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003020 * Broadcast sent to the primary user when an associated managed profile has become available.
3021 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003022 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3023 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3024 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003025 */
Rubin Xue95057a2016-04-01 16:49:25 +01003026 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3027 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3028
3029 /**
3030 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3031 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3032 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3033 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3034 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3035 */
3036 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3037 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003038
3039 /**
Robin Lee92b83c62016-08-31 13:27:51 +01003040 * Broadcast sent to the system user when the 'device locked' state changes for any user.
3041 * Carries an extra {@link #EXTRA_USER_HANDLE} that specifies the ID of the user for which
3042 * the device was locked or unlocked.
3043 *
3044 * This is only sent to registered receivers.
3045 *
3046 * @hide
3047 */
3048 public static final String ACTION_DEVICE_LOCKED_CHANGED =
3049 "android.intent.action.DEVICE_LOCKED_CHANGED";
3050
3051 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003052 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3053 */
3054 public static final String ACTION_QUICK_CLOCK =
3055 "android.intent.action.QUICK_CLOCK";
3056
Michael Wright0087a142013-02-05 16:29:39 -08003057 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003058 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003059 * @hide
3060 */
3061 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3062 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3063
Justin Kohd378ad72013-04-01 12:18:26 -07003064 /**
3065 * Broadcast Action: A global button was pressed. Includes a single
3066 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3067 * caused the broadcast.
3068 * @hide
3069 */
3070 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3071
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003072 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003073 * Broadcast Action: Sent when media resource is granted.
3074 * <p>
3075 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3076 * granted.
3077 * </p>
3078 * <p class="note">
3079 * This is a protected intent that can only be sent by the system.
3080 * </p>
3081 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003082 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003083 * </p>
3084 *
3085 * @hide
3086 */
3087 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3088 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3089
3090 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003091 * Activity Action: Allow the user to select and return one or more existing
3092 * documents. When invoked, the system will display the various
3093 * {@link DocumentsProvider} instances installed on the device, letting the
3094 * user interactively navigate through them. These documents include local
3095 * media, such as photos and video, and documents provided by installed
3096 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003097 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003098 * Each document is represented as a {@code content://} URI backed by a
3099 * {@link DocumentsProvider}, which can be opened as a stream with
3100 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3101 * {@link android.provider.DocumentsContract.Document} metadata.
3102 * <p>
3103 * All selected documents are returned to the calling application with
3104 * persistable read and write permission grants. If you want to maintain
3105 * access to the documents across device reboots, you need to explicitly
3106 * take the persistable permissions using
3107 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3108 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003109 * Callers must indicate the acceptable document MIME types through
3110 * {@link #setType(String)}. For example, to select photos, use
3111 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3112 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3113 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003114 * <p>
3115 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003116 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3117 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003118 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003119 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3120 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003121 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003122 * <p>
Garfield Tan0b3cf662016-10-31 12:59:45 -07003123 * Callers can set a document URI through {@link #setData(Uri)} to indicate
3124 * the initial location of documents navigator. System will do its best to
3125 * launch the navigator in the specified document if it's a folder, or the
3126 * folder that contains the specified document if not.
3127 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003128 * Output: The URI of the item that was picked, returned in
3129 * {@link #getData()}. This must be a {@code content://} URI so that any
3130 * receiver can access it. If multiple documents were selected, they are
3131 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003132 *
3133 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003134 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003135 * @see #ACTION_CREATE_DOCUMENT
3136 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003137 */
3138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3139 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3140
3141 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003142 * Activity Action: Allow the user to create a new document. When invoked,
3143 * the system will display the various {@link DocumentsProvider} instances
3144 * installed on the device, letting the user navigate through them. The
3145 * returned document may be a newly created document with no content, or it
3146 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003147 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003148 * Each document is represented as a {@code content://} URI backed by a
3149 * {@link DocumentsProvider}, which can be opened as a stream with
3150 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3151 * {@link android.provider.DocumentsContract.Document} metadata.
3152 * <p>
3153 * Callers must indicate the concrete MIME type of the document being
3154 * created by setting {@link #setType(String)}. This MIME type cannot be
3155 * changed after the document is created.
3156 * <p>
3157 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3158 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003159 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003160 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3161 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003162 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003163 * <p>
Garfield Tan0b3cf662016-10-31 12:59:45 -07003164 * Callers can set a document URI through {@link #setData(Uri)} to indicate
3165 * the initial location of documents navigator. System will do its best to
3166 * launch the navigator in the specified document if it's a folder, or the
3167 * folder that contains the specified document if not.
3168 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003169 * Output: The URI of the item that was created. This must be a
3170 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003171 *
3172 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003173 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003174 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003175 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003176 */
3177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3178 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3179
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003180 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003181 * Activity Action: Allow the user to pick a directory subtree. When
3182 * invoked, the system will display the various {@link DocumentsProvider}
3183 * instances installed on the device, letting the user navigate through
3184 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003185 * <p>
3186 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003187 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3188 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3189 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003190 * <p>
Garfield Tan0b3cf662016-10-31 12:59:45 -07003191 * Callers can set a document URI through {@link #setData(Uri)} to indicate
3192 * the initial location of documents navigator. System will do its best to
3193 * initiate the navigator in the specified document if it's a folder, or
3194 * the folder that contains the specified document if not.
3195 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003196 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003197 *
3198 * @see DocumentsContract
3199 */
3200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003201 public static final String
3202 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003203
Felipe Lemec7b1f892016-01-15 15:02:31 -08003204 /**
Peng Xua35b5532016-01-20 00:05:45 -08003205 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3206 * exisiting sensor being disconnected.
3207 *
3208 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3209 *
3210 * {@hide}
3211 */
3212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3213 public static final String
3214 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3215
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003216 /** {@hide} */
3217 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3218
Christopher Tate6597e342015-02-17 12:15:25 -08003219 /**
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003220 * Boolean intent extra to be used with {@link ACTION_MASTER_CLEAR} in order to force a factory
3221 * reset even if {@link android.os.UserManager.DISALLOW_FACTORY_RESET} is set.
3222 * @hide
3223 */
3224 public static final String EXTRA_FORCE_MASTER_CLEAR =
3225 "android.intent.extra.FORCE_MASTER_CLEAR";
3226
3227 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003228 * Broadcast action: report that a settings element is being restored from backup. The intent
3229 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3230 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3231 * is the value of that settings entry prior to the restore operation. All of these values are
3232 * represented as strings.
3233 *
3234 * <p>This broadcast is sent only for settings provider entries known to require special handling
3235 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3236 * the provider's backup agent implementation.
3237 *
3238 * @see #EXTRA_SETTING_NAME
3239 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3240 * @see #EXTRA_SETTING_NEW_VALUE
3241 * {@hide}
3242 */
3243 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3244
3245 /** {@hide} */
3246 public static final String EXTRA_SETTING_NAME = "setting_name";
3247 /** {@hide} */
3248 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3249 /** {@hide} */
3250 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3251
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003252 /**
3253 * Activity Action: Process a piece of text.
3254 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3255 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3256 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3257 */
3258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3259 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3260 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003261 * The name of the extra used to define the text to be processed, as a
3262 * CharSequence. Note that this may be a styled CharSequence, so you must use
3263 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003264 */
3265 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3266 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003267 * 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 +00003268 */
3269 public static final String EXTRA_PROCESS_TEXT_READONLY =
3270 "android.intent.extra.PROCESS_TEXT_READONLY";
3271
Bryce Leebc58f592015-09-25 16:43:01 -07003272 /**
3273 * Broadcast action: reports when a new thermal event has been reached. When the device
3274 * is reaching its maximum temperatue, the thermal level reported
3275 * {@hide}
3276 */
3277 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3278 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3279
3280 /** {@hide} */
3281 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3282
3283 /**
3284 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003285 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003286 * {@hide}
3287 */
3288 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3289
3290 /**
3291 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003292 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003293 * {@hide}
3294 */
3295 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3296
3297 /**
3298 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003299 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003300 * {@hide}
3301 */
3302 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3303
3304
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003305 // ---------------------------------------------------------------------
3306 // ---------------------------------------------------------------------
3307 // Standard intent categories (see addCategory()).
3308
3309 /**
3310 * Set if the activity should be an option for the default action
3311 * (center press) to perform on a piece of data. Setting this will
3312 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003313 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003314 * Intent when initiating an action -- it is for use in intent filters
3315 * specified in packages.
3316 */
3317 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3318 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3319 /**
3320 * Activities that can be safely invoked from a browser must support this
3321 * category. For example, if the user is viewing a web page or an e-mail
3322 * and clicks on a link in the text, the Intent generated execute that
3323 * link will require the BROWSABLE category, so that only activities
3324 * supporting this category will be considered as possible actions. By
3325 * supporting this category, you are promising that there is nothing
3326 * damaging (without user intervention) that can happen by invoking any
3327 * matching Intent.
3328 */
3329 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3330 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3331 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003332 * Categories for activities that can participate in voice interaction.
3333 * An activity that supports this category must be prepared to run with
3334 * no UI shown at all (though in some case it may have a UI shown), and
3335 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3336 */
3337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3338 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3339 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003340 * Set if the activity should be considered as an alternative action to
3341 * the data the user is currently viewing. See also
3342 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3343 * applies to the selection in a list of items.
3344 *
3345 * <p>Supporting this category means that you would like your activity to be
3346 * displayed in the set of alternative things the user can do, usually as
3347 * part of the current activity's options menu. You will usually want to
3348 * include a specific label in the &lt;intent-filter&gt; of this action
3349 * describing to the user what it does.
3350 *
3351 * <p>The action of IntentFilter with this category is important in that it
3352 * describes the specific action the target will perform. This generally
3353 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3354 * a specific name such as "com.android.camera.action.CROP. Only one
3355 * alternative of any particular action will be shown to the user, so using
3356 * a specific action like this makes sure that your alternative will be
3357 * displayed while also allowing other applications to provide their own
3358 * overrides of that particular action.
3359 */
3360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3361 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3362 /**
3363 * Set if the activity should be considered as an alternative selection
3364 * action to the data the user has currently selected. This is like
3365 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3366 * of items from which the user can select, giving them alternatives to the
3367 * default action that will be performed on it.
3368 */
3369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3370 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3371 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003372 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003373 */
3374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3375 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3376 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003377 * Should be displayed in the top-level launcher.
3378 */
3379 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3380 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3381 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003382 * Indicates an activity optimized for Leanback mode, and that should
3383 * be displayed in the Leanback launcher.
3384 */
3385 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3386 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3387 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003388 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3389 * @hide
3390 */
3391 @SystemApi
3392 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3393 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003394 * Provides information about the package it is in; typically used if
3395 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3396 * a front-door to the user without having to be shown in the all apps list.
3397 */
3398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3399 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003401 * This is the home activity, that is the first activity that is displayed
3402 * when the device boots.
3403 */
3404 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3405 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3406 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003407 * This is the home activity that is displayed when the device is finished setting up and ready
3408 * for use.
3409 * @hide
3410 */
3411 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3412 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3413 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003414 * This is the setup wizard activity, that is the first activity that is displayed
3415 * when the user sets up the device for the first time.
3416 * @hide
3417 */
3418 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3419 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3420 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 * This activity is a preference panel.
3422 */
3423 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3424 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3425 /**
3426 * This activity is a development preference panel.
3427 */
3428 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3429 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3430 /**
3431 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003432 */
3433 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3434 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3435 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003436 * This activity allows the user to browse and download new applications.
3437 */
3438 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3439 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3440 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441 * This activity may be exercised by the monkey or other automated test tools.
3442 */
3443 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3444 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3445 /**
3446 * To be used as a test (not part of the normal user experience).
3447 */
3448 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3449 /**
3450 * To be used as a unit test (run through the Test Harness).
3451 */
3452 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3453 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003454 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003455 * experience).
3456 */
3457 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003459 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003460 * Used to indicate that an intent only wants URIs that can be opened with
3461 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3462 * must support at least the columns defined in {@link OpenableColumns} when
3463 * queried.
3464 *
3465 * @see #ACTION_GET_CONTENT
3466 * @see #ACTION_OPEN_DOCUMENT
3467 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 */
3469 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3470 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3471
3472 /**
3473 * To be used as code under test for framework instrumentation tests.
3474 */
3475 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3476 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003477 /**
3478 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003479 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3480 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003481 */
3482 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3483 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3484 /**
3485 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003486 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3487 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003488 */
3489 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3490 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003491 /**
3492 * An activity to run when device is inserted into a analog (low end) dock.
3493 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3494 * information, see {@link android.app.UiModeManager}.
3495 */
3496 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3497 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3498
3499 /**
3500 * An activity to run when device is inserted into a digital (high end) dock.
3501 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3502 * information, see {@link android.app.UiModeManager}.
3503 */
3504 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3505 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003506
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003507 /**
3508 * Used to indicate that the activity can be used in a car environment.
3509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3512
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003513 // ---------------------------------------------------------------------
3514 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003515 // Application launch intent categories (see addCategory()).
3516
3517 /**
3518 * Used with {@link #ACTION_MAIN} to launch the browser application.
3519 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003520 * <p>NOTE: This should not be used as the primary key of an Intent,
3521 * since it will not result in the app launching with the correct
3522 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003523 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003524 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003525 */
3526 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3527 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3528
3529 /**
3530 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3531 * The activity should be able to perform standard arithmetic operations.
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_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3540
3541 /**
3542 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3543 * The activity should be able to view and manipulate calendar entries.
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_CALENDAR = "android.intent.category.APP_CALENDAR";
3552
3553 /**
3554 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3555 * The activity should be able to view and manipulate address book entries.
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_CONTACTS = "android.intent.category.APP_CONTACTS";
3564
3565 /**
3566 * Used with {@link #ACTION_MAIN} to launch the email application.
3567 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003568 * <p>NOTE: This should not be used as the primary key of an Intent,
3569 * since it will not result in the app launching with the correct
3570 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003571 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003572 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003573 */
3574 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3575 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3576
3577 /**
3578 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3579 * The activity should be able to view and manipulate image and video files
3580 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003581 * <p>NOTE: This should not be used as the primary key of an Intent,
3582 * since it will not result in the app launching with the correct
3583 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003584 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003585 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003586 */
3587 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3588 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3589
3590 /**
3591 * Used with {@link #ACTION_MAIN} to launch the maps application.
3592 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003593 * <p>NOTE: This should not be used as the primary key of an Intent,
3594 * since it will not result in the app launching with the correct
3595 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003596 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003597 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003598 */
3599 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3600 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3601
3602 /**
3603 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3604 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003605 * <p>NOTE: This should not be used as the primary key of an Intent,
3606 * since it will not result in the app launching with the correct
3607 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003608 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003609 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003610 */
3611 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3612 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3613
3614 /**
3615 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003616 * The activity should be able to play, browse, or manipulate music files
3617 * stored on the device.
3618 * <p>NOTE: This should not be used as the primary key of an Intent,
3619 * since it will not result in the app launching with the correct
3620 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003621 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003622 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003623 */
3624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3625 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3626
3627 // ---------------------------------------------------------------------
3628 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629 // Standard extra data keys.
3630
3631 /**
3632 * The initial data to place in a newly created record. Use with
3633 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3634 * fields as would be given to the underlying ContentProvider.insert()
3635 * call.
3636 */
3637 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3638
3639 /**
3640 * A constant CharSequence that is associated with the Intent, used with
3641 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3642 * this may be a styled CharSequence, so you must use
3643 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3644 * retrieve it.
3645 */
3646 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3647
3648 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003649 * A constant String that is associated with the Intent, used with
3650 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3651 * as HTML formatted text. Note that you <em>must</em> also supply
3652 * {@link #EXTRA_TEXT}.
3653 */
3654 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3655
3656 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 * A content: URI holding a stream of data associated with the Intent,
3658 * used with {@link #ACTION_SEND} to supply the data being sent.
3659 */
3660 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3661
3662 /**
3663 * A String[] holding e-mail addresses that should be delivered to.
3664 */
3665 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3666
3667 /**
3668 * A String[] holding e-mail addresses that should be carbon copied.
3669 */
3670 public static final String EXTRA_CC = "android.intent.extra.CC";
3671
3672 /**
3673 * A String[] holding e-mail addresses that should be blind carbon copied.
3674 */
3675 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3676
3677 /**
3678 * A constant string holding the desired subject line of a message.
3679 */
3680 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3681
3682 /**
3683 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003684 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003685 */
3686 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3687
3688 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003689 * An int representing the user id to be used.
3690 *
3691 * @hide
3692 */
3693 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3694
3695 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003696 * An int representing the task id to be retrieved. This is used when a launch from recents is
3697 * intercepted by another action such as credentials confirmation to remember which task should
3698 * be resumed when complete.
3699 *
3700 * @hide
3701 */
3702 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3703
3704 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003705 * An Intent[] describing additional, alternate choices you would like shown with
3706 * {@link #ACTION_CHOOSER}.
3707 *
3708 * <p>An app may be capable of providing several different payload types to complete a
3709 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3710 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3711 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3712 * photo data or a hosted link where the photos can be viewed.</p>
3713 *
3714 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3715 * first/primary/preferred intent in the set. Additional intents specified in
3716 * this extra are ordered; by default intents that appear earlier in the array will be
3717 * preferred over intents that appear later in the array as matches for the same
3718 * target component. To alter this preference, a calling app may also supply
3719 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3720 */
3721 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3722
3723 /**
Adam Powell52c39212016-04-07 15:14:18 -07003724 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3725 * and omitted from a list of components presented to the user.
3726 *
3727 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3728 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3729 * from your own package or other apps from your organization if the idea of sending to those
3730 * targets would be redundant with other app functionality. Filtered components will not
3731 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3732 */
3733 public static final String EXTRA_EXCLUDE_COMPONENTS
3734 = "android.intent.extra.EXCLUDE_COMPONENTS";
3735
3736 /**
3737 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3738 * describing additional high-priority deep-link targets for the chooser to present to the user.
3739 *
3740 * <p>Targets provided in this way will be presented inline with all other targets provided
3741 * by services from other apps. They will be prioritized before other service targets, but
3742 * after those targets provided by sources that the user has manually pinned to the front.</p>
3743 *
3744 * @see #ACTION_CHOOSER
3745 */
3746 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3747
3748 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003749 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3750 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3751 *
3752 * <p>An app preparing an action for another app to complete may wish to allow the user to
3753 * disambiguate between several options for completing the action based on the chosen target
3754 * or otherwise refine the action before it is invoked.
3755 * </p>
3756 *
3757 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3758 * <ul>
3759 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3760 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3761 * chosen target beyond the first</li>
3762 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3763 * should fill in and send once the disambiguation is complete</li>
3764 * </ul>
3765 */
3766 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3767 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3768
3769 /**
3770 * A {@link ResultReceiver} used to return data back to the sender.
3771 *
3772 * <p>Used to complete an app-specific
3773 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3774 *
3775 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3776 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3777 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3778 * when the user selects a target component from the chooser. It is up to the recipient
3779 * to send a result to this ResultReceiver to signal that disambiguation is complete
3780 * and that the chooser should invoke the user's choice.</p>
3781 *
3782 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3783 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3784 * to match and fill in the final Intent or ChooserTarget before starting it.
3785 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3786 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3787 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3788 *
3789 * <p>The result code passed to the ResultReceiver should be
3790 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3791 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3792 * the chooser should finish without starting a target.</p>
3793 */
3794 public static final String EXTRA_RESULT_RECEIVER
3795 = "android.intent.extra.RESULT_RECEIVER";
3796
3797 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003798 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003799 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003800 */
3801 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3802
3803 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003804 * A Parcelable[] of {@link Intent} or
3805 * {@link android.content.pm.LabeledIntent} objects as set with
3806 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3807 * a the front of the list of choices, when shown to the user with a
3808 * {@link #ACTION_CHOOSER}.
3809 */
3810 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3811
3812 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003813 * A {@link IntentSender} to start after ephemeral installation success.
3814 * @hide
3815 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003816 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3817
3818 /**
3819 * A {@link IntentSender} to start after ephemeral installation failure.
3820 * @hide
3821 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003822 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3823
3824 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003825 * A Bundle forming a mapping of potential target package names to different extras Bundles
3826 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3827 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3828 * be currently installed on the device.
3829 *
3830 * <p>An application may choose to provide alternate extras for the case where a user
3831 * selects an activity from a predetermined set of target packages. If the activity
3832 * the user selects from the chooser belongs to a package with its package name as
3833 * a key in this bundle, the corresponding extras for that package will be merged with
3834 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3835 * extra has the same key as an extra already present in the intent it will overwrite
3836 * the extra from the intent.</p>
3837 *
3838 * <p><em>Examples:</em>
3839 * <ul>
3840 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3841 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3842 * parameters for that target.</li>
3843 * <li>An application may offer additional metadata for known targets of a given intent
3844 * to pass along information only relevant to that target such as account or content
3845 * identifiers already known to that application.</li>
3846 * </ul></p>
3847 */
3848 public static final String EXTRA_REPLACEMENT_EXTRAS =
3849 "android.intent.extra.REPLACEMENT_EXTRAS";
3850
3851 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003852 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3853 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3854 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3855 * {@link ComponentName} of the chosen component.
3856 *
3857 * <p>In some situations this callback may never come, for example if the user abandons
3858 * the chooser, switches to another task or any number of other reasons. Apps should not
3859 * be written assuming that this callback will always occur.</p>
3860 */
3861 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3862 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3863
3864 /**
3865 * The {@link ComponentName} chosen by the user to complete an action.
3866 *
3867 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3868 */
3869 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3870
3871 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003872 * A {@link android.view.KeyEvent} object containing the event that
3873 * triggered the creation of the Intent it is in.
3874 */
3875 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3876
3877 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003878 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3879 * before shutting down.
3880 *
3881 * {@hide}
3882 */
3883 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3884
3885 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003886 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3887 * requested by the user.
3888 *
3889 * {@hide}
3890 */
3891 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3892 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3893
3894 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003895 * 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 -07003896 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3897 * of restarting the application.
3898 */
3899 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3900
3901 /**
3902 * A String holding the phone number originally entered in
3903 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3904 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3905 */
3906 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003907
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003908 /**
3909 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3910 * intents to supply the uid the package had been assigned. Also an optional
3911 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3912 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3913 * purpose.
3914 */
3915 public static final String EXTRA_UID = "android.intent.extra.UID";
3916
3917 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003918 * @hide String array of package names.
3919 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003920 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003921 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3922
3923 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003924 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3925 * intents to indicate whether this represents a full uninstall (removing
3926 * both the code and its data) or a partial uninstall (leaving its data,
3927 * implying that this is an update).
3928 */
3929 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003930
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003931 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003932 * @hide
3933 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3934 * intents to indicate that at this point the package has been removed for
3935 * all users on the device.
3936 */
3937 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3938 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3939
3940 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003941 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3942 * intents to indicate that this is a replacement of the package, so this
3943 * broadcast will immediately be followed by an add broadcast for a
3944 * different version of the same package.
3945 */
3946 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003947
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003948 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003949 * Used as an int extra field in {@link android.app.AlarmManager} intents
3950 * to tell the application being invoked how many pending alarms are being
3951 * delievered with the intent. For one-shot alarms this will always be 1.
3952 * For recurring alarms, this might be greater than 1 if the device was
3953 * asleep or powered off at the time an earlier alarm would have been
3954 * delivered.
3955 */
3956 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003957
Jacek Surazski86b6c532009-05-13 14:38:28 +02003958 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003959 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3960 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003961 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3962 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003963 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3964 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3965 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003966 */
3967 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3968
3969 /**
3970 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3971 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003972 */
3973 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3974
3975 /**
3976 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3977 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003978 */
3979 public static final int EXTRA_DOCK_STATE_DESK = 1;
3980
3981 /**
3982 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3983 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003984 */
3985 public static final int EXTRA_DOCK_STATE_CAR = 2;
3986
3987 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003988 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3989 * to represent that the phone is in a analog (low end) dock.
3990 */
3991 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3992
3993 /**
3994 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3995 * to represent that the phone is in a digital (high end) dock.
3996 */
3997 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3998
3999 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004000 * Boolean that can be supplied as meta-data with a dock activity, to
4001 * indicate that the dock should take over the home key when it is active.
4002 */
4003 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004004
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004005 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004006 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4007 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004008 */
4009 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4010
4011 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004012 * Used in the extra field in the remote intent. It's astring token passed with the
4013 * remote intent.
4014 */
4015 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4016 "android.intent.extra.remote_intent_token";
4017
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004018 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004019 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004020 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004021 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004022 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004023 "android.intent.extra.changed_component_name";
4024
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004025 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004026 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004027 * and contains a string array of all of the components that have changed. If
4028 * the state of the overall package has changed, then it will contain an entry
4029 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004030 */
4031 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4032 "android.intent.extra.changed_component_name_list";
4033
4034 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004035 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004036 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004037 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4038 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4039 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004040 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004041 */
4042 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4043 "android.intent.extra.changed_package_list";
4044
4045 /**
4046 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004047 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4048 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004049 * and contains an integer array of uids of all of the components
4050 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004051 */
4052 public static final String EXTRA_CHANGED_UID_LIST =
4053 "android.intent.extra.changed_uid_list";
4054
4055 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004056 * @hide
4057 * Magic extra system code can use when binding, to give a label for
4058 * who it is that has bound to a service. This is an integer giving
4059 * a framework string resource that can be displayed to the user.
4060 */
4061 public static final String EXTRA_CLIENT_LABEL =
4062 "android.intent.extra.client_label";
4063
4064 /**
4065 * @hide
4066 * Magic extra system code can use when binding, to give a PendingIntent object
4067 * that can be launched for the user to disable the system's use of this
4068 * service.
4069 */
4070 public static final String EXTRA_CLIENT_INTENT =
4071 "android.intent.extra.client_intent";
4072
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004073 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004074 * Extra used to indicate that an intent should only return data that is on
4075 * the local device. This is a boolean extra; the default is false. If true,
4076 * an implementation should only allow the user to select data that is
4077 * already on the device, not requiring it be downloaded from a remote
4078 * service when opened.
4079 *
4080 * @see #ACTION_GET_CONTENT
4081 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004082 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004083 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004084 */
4085 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004086 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004087
Amith Yamasani13593602012-03-22 16:16:17 -07004088 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004089 * Extra used to indicate that an intent can allow the user to select and
4090 * return multiple items. This is a boolean extra; the default is false. If
4091 * true, an implementation is allowed to present the user with a UI where
4092 * they can pick multiple items that are all returned to the caller. When
4093 * this happens, they should be returned as the {@link #getClipData()} part
4094 * of the result Intent.
4095 *
4096 * @see #ACTION_GET_CONTENT
4097 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004098 */
4099 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004100 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004101
4102 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004103 * The integer userHandle carried with broadcast intents related to addition, removal and
4104 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4105 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4106 *
Amith Yamasani13593602012-03-22 16:16:17 -07004107 * @hide
4108 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004109 public static final String EXTRA_USER_HANDLE =
4110 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004111
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004112 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004113 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4114 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4115 */
4116 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004117 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004118
4119 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004120 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004121 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4122 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004123 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004124 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4125
4126 /**
4127 * Extra sent in the intent to the BroadcastReceiver that handles
4128 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4129 * the restrictions as key/value pairs.
4130 */
4131 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4132 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004133
Amith Yamasani86118ba2013-03-28 14:33:16 -07004134 /**
4135 * Extra used in the response from a BroadcastReceiver that handles
4136 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4137 */
4138 public static final String EXTRA_RESTRICTIONS_INTENT =
4139 "android.intent.extra.restrictions_intent";
4140
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004141 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004142 * Extra used to communicate a set of acceptable MIME types. The type of the
4143 * extra is {@code String[]}. Values may be a combination of concrete MIME
4144 * types (such as "image/png") and/or partial MIME types (such as
4145 * "audio/*").
4146 *
4147 * @see #ACTION_GET_CONTENT
4148 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004149 */
4150 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4151
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004152 /**
4153 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4154 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004155 * When this is true, hardware devices can use this information to determine that
4156 * they shouldn't do a complete shutdown of their device since this is not a
4157 * complete shutdown down to the kernel, but only user space restarting.
4158 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004159 */
4160 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4161 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4162
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004163 /**
4164 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4165 * user has set their time format preferences to the 24 hour format.
4166 *
4167 * @hide for internal use only.
4168 */
4169 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4170 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4171
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004172 /** {@hide} */
4173 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4174
Rubin Xue8490f12015-06-25 12:17:48 +01004175 /** {@hide} */
4176 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4177
Santos Cordon15a13782015-03-31 18:32:31 -07004178 /**
4179 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4180 * activation request.
4181 * TODO: Add information about the structure and response data used with the pending intent.
4182 * @hide
4183 */
4184 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4185 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4186
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004187 /**
4188 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004189 *
4190 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004191 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004192 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4193
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004194 /**
4195 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004196 * When a profile goes into quiet mode, all apps in the profile are killed and the
4197 * profile user is stopped. Widgets originating from the profile are masked, and app
4198 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004199 */
4200 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004201
4202 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004203 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004204 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004205 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4206 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004207 *
4208 * @hide
4209 */
4210 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4211 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4212
4213 /**
Ben Lin145b0ca2016-10-14 14:23:40 -07004214 * Used as a boolean extra field in {@link #ACTION_CHOOSER} intents to specify
4215 * whether to show the chooser or not when there is only one application available
4216 * to choose from.
4217 *
4218 * @hide
4219 */
4220 public static final String EXTRA_AUTO_LAUNCH_SINGLE_CHOICE =
4221 "android.intent.extra.AUTO_LAUNCH_SINGLE_CHOICE";
4222
4223 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004224 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004225 * to represent that a video codec is allowed to use.
4226 *
4227 * @hide
4228 */
4229 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4230
4231 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004232 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004233 * to represent that a audio codec is allowed to use.
4234 *
4235 * @hide
4236 */
4237 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4238
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004239 // ---------------------------------------------------------------------
4240 // ---------------------------------------------------------------------
4241 // Intent flags (see mFlags variable).
4242
Tor Norbyed9273d62013-05-30 15:59:53 -07004243 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004244 @IntDef(flag = true, value = {
4245 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4246 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004247 @Retention(RetentionPolicy.SOURCE)
4248 public @interface GrantUriMode {}
4249
Jeff Sharkey846318a2014-04-04 12:12:41 -07004250 /** @hide */
4251 @IntDef(flag = true, value = {
4252 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4253 @Retention(RetentionPolicy.SOURCE)
4254 public @interface AccessUriMode {}
4255
4256 /**
4257 * Test if given mode flags specify an access mode, which must be at least
4258 * read and/or write.
4259 *
4260 * @hide
4261 */
4262 public static boolean isAccessUriMode(int modeFlags) {
4263 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4264 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4265 }
4266
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004267 /**
4268 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004269 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004270 * specified in its ClipData. When applying to an Intent's ClipData,
4271 * all URIs as well as recursive traversals through data or other ClipData
4272 * in Intent items will be granted; only the grant flags of the top-level
4273 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004274 */
4275 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4276 /**
4277 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004278 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004279 * specified in its ClipData. When applying to an Intent's ClipData,
4280 * all URIs as well as recursive traversals through data or other ClipData
4281 * in Intent items will be granted; only the grant flags of the top-level
4282 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004283 */
4284 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4285 /**
4286 * Can be set by the caller to indicate that this Intent is coming from
4287 * a background operation, not from direct user interaction.
4288 */
4289 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4290 /**
4291 * A flag you can enable for debugging: when set, log messages will be
4292 * printed during the resolution of this intent to show you what has
4293 * been found to create the final resolved list.
4294 */
4295 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004296 /**
4297 * If set, this intent will not match any components in packages that
4298 * are currently stopped. If this is not set, then the default behavior
4299 * is to include such applications in the result.
4300 */
4301 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4302 /**
4303 * If set, this intent will always match any components in packages that
4304 * are currently stopped. This is the default behavior when
4305 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4306 * flags are set, this one wins (it allows overriding of exclude for
4307 * places where the framework may automatically set the exclude flag).
4308 */
4309 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004310
4311 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004312 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004313 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004314 * persisted across device reboots until explicitly revoked with
4315 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4316 * grant for possible persisting; the receiving application must call
4317 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4318 * actually persist.
4319 *
4320 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4321 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4322 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004323 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004324 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004325 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004326
4327 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004328 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4329 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4330 * applies to any URI that is a prefix match against the original granted
4331 * URI. (Without this flag, the URI must match exactly for access to be
4332 * granted.) Another URI is considered a prefix match only when scheme,
4333 * authority, and all path segments defined by the prefix are an exact
4334 * match.
4335 */
4336 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4337
4338 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004339 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004340 * homework and verified that they correctly handle packages and components
4341 * that come and go over time. In particular:
4342 * <ul>
4343 * <li>Apps installed on external storage, which will appear to be
4344 * uninstalled while the the device is ejected.
4345 * <li>Apps with encryption unaware components, which will appear to not
4346 * exist while the device is locked.
4347 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004348 *
4349 * @hide
4350 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004351 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004352
4353 /**
Todd Kennedy8e2d9d12016-06-28 14:09:55 -07004354 * Internal flag used to indicate ephemeral applications should not be
4355 * considered when resolving the intent.
4356 *
4357 * @hide
4358 */
4359 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4360
4361 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004362 * If set, the new activity is not kept in the history stack. As soon as
4363 * the user navigates away from it, the activity is finished. This may also
4364 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4365 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004366 *
4367 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4368 * is never invoked when the current activity starts a new activity which
4369 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004370 */
4371 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4372 /**
4373 * If set, the activity will not be launched if it is already running
4374 * at the top of the history stack.
4375 */
4376 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4377 /**
4378 * If set, this activity will become the start of a new task on this
4379 * history stack. A task (from the activity that started it to the
4380 * next task activity) defines an atomic group of activities that the
4381 * user can move to. Tasks can be moved to the foreground and background;
4382 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004383 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004384 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4385 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004386 *
4387 * <p>This flag is generally used by activities that want
4388 * to present a "launcher" style behavior: they give the user a list of
4389 * separate things that can be done, which otherwise run completely
4390 * independently of the activity launching them.
4391 *
4392 * <p>When using this flag, if a task is already running for the activity
4393 * you are now starting, then a new activity will not be started; instead,
4394 * the current task will simply be brought to the front of the screen with
4395 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4396 * to disable this behavior.
4397 *
4398 * <p>This flag can not be used when the caller is requesting a result from
4399 * the activity being launched.
4400 */
4401 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4402 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004403 * This flag is used to create a new task and launch an activity into it.
4404 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4405 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4406 * search through existing tasks for ones matching this Intent. Only if no such
4407 * task is found would a new task be created. When paired with
4408 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4409 * the search for a matching task and unconditionally start a new task.
4410 *
4411 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4412 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004413 * top-level application launcher.</strong> Used in conjunction with
4414 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4415 * behavior of bringing an existing task to the foreground. When set,
4416 * a new task is <em>always</em> started to host the Activity for the
4417 * Intent, regardless of whether there is already an existing task running
4418 * the same thing.
4419 *
4420 * <p><strong>Because the default system does not include graphical task management,
4421 * you should not use this flag unless you provide some way for a user to
4422 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004423 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004424 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4425 * creating new document tasks.
4426 *
4427 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004428 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004429 *
Scott Main7aee61f2011-02-08 11:25:01 -08004430 * <p>See
4431 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4432 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004433 *
4434 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4435 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004436 */
4437 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4438 /**
4439 * If set, and the activity being launched is already running in the
4440 * current task, then instead of launching a new instance of that activity,
4441 * all of the other activities on top of it will be closed and this Intent
4442 * will be delivered to the (now on top) old activity as a new Intent.
4443 *
4444 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4445 * If D calls startActivity() with an Intent that resolves to the component
4446 * of activity B, then C and D will be finished and B receive the given
4447 * Intent, resulting in the stack now being: A, B.
4448 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004449 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004450 * either receive the new intent you are starting here in its
4451 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004452 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004453 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4454 * the same intent, then it will be finished and re-created; for all other
4455 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4456 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004457 *
4458 * <p>This launch mode can also be used to good effect in conjunction with
4459 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4460 * of a task, it will bring any currently running instance of that task
4461 * to the foreground, and then clear it to its root state. This is
4462 * especially useful, for example, when launching an activity from the
4463 * notification manager.
4464 *
Scott Main7aee61f2011-02-08 11:25:01 -08004465 * <p>See
4466 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4467 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004468 */
4469 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4470 /**
4471 * If set and this intent is being used to launch a new activity from an
4472 * existing one, then the reply target of the existing activity will be
4473 * transfered to the new activity. This way the new activity can call
4474 * {@link android.app.Activity#setResult} and have that result sent back to
4475 * the reply target of the original activity.
4476 */
4477 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4478 /**
4479 * If set and this intent is being used to launch a new activity from an
4480 * existing one, the current activity will not be counted as the top
4481 * activity for deciding whether the new intent should be delivered to
4482 * the top instead of starting a new one. The previous activity will
4483 * be used as the top, with the assumption being that the current activity
4484 * will finish itself immediately.
4485 */
4486 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4487 /**
4488 * If set, the new activity is not kept in the list of recently launched
4489 * activities.
4490 */
4491 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4492 /**
4493 * This flag is not normally set by application code, but set for you by
4494 * the system as described in the
4495 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4496 * launchMode} documentation for the singleTask mode.
4497 */
4498 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4499 /**
4500 * If set, and this activity is either being started in a new task or
4501 * bringing to the top an existing task, then it will be launched as
4502 * the front door of the task. This will result in the application of
4503 * any affinities needed to have that task in the proper state (either
4504 * moving activities to or from it), or simply resetting that task to
4505 * its initial state if needed.
4506 */
4507 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4508 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004509 * This flag is not normally set by application code, but set for you by
4510 * the system if this activity is being launched from history
4511 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004512 */
4513 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004514 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004515 * @deprecated As of API 21 this performs identically to
4516 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004517 */
Aurimas Liutikas514c5ef2016-05-24 15:22:55 -07004518 @Deprecated
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004519 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004520 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004521 * This flag is used to open a document into a new task rooted at the activity launched
4522 * by this Intent. Through the use of this flag, or its equivalent attribute,
4523 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004524 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004525 *
Craig Mautner026596b2014-05-21 15:35:44 -07004526 * <p>The use of the activity attribute form of this,
4527 * {@link android.R.attr#documentLaunchMode}, is
4528 * preferred over the Intent flag described here. The attribute form allows the
4529 * Activity to specify multiple document behavior for all launchers of the Activity
4530 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004531 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004532 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4533 * it is kept after the activity is finished is different than the use of
4534 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4535 * this flag is being used to create a new recents entry, then by default that entry
4536 * will be removed once the activity is finished. You can modify this behavior with
4537 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4538 *
Craig Mautner026596b2014-05-21 15:35:44 -07004539 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4540 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4541 * equivalent of the Activity manifest specifying {@link
4542 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4543 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4544 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004545 *
Craig Mautner026596b2014-05-21 15:35:44 -07004546 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004547 *
Craig Mautner026596b2014-05-21 15:35:44 -07004548 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004549 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4550 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004551 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004552 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004553 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004554 * callback from occurring on the current frontmost activity before it is
4555 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004556 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004557 * <p>Typically, an activity can rely on that callback to indicate that an
4558 * explicit user action has caused their activity to be moved out of the
4559 * foreground. The callback marks an appropriate point in the activity's
4560 * lifecycle for it to dismiss any notifications that it intends to display
4561 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004562 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004563 * <p>If an activity is ever started via any non-user-driven events such as
4564 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4565 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004566 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004567 */
4568 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004569 /**
4570 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4571 * this flag will cause the launched activity to be brought to the front of its
4572 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004573 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004574 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4575 * If D calls startActivity() with an Intent that resolves to the component
4576 * of activity B, then B will be brought to the front of the history stack,
4577 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004578 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004579 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004580 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004581 */
4582 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004583 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004584 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4585 * this flag will prevent the system from applying an activity transition
4586 * animation to go to the next activity state. This doesn't mean an
4587 * animation will never run -- if another activity change happens that doesn't
4588 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004589 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004590 * when you are going to do a series of activity operations but the
4591 * animation seen by the user shouldn't be driven by the first activity
4592 * change but rather a later one.
4593 */
4594 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4595 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004596 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4597 * this flag will cause any existing task that would be associated with the
4598 * activity to be cleared before the activity is started. That is, the activity
4599 * becomes the new root of an otherwise empty task, and any old activities
4600 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4601 */
4602 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4603 /**
4604 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4605 * this flag will cause a newly launching task to be placed on top of the current
4606 * home activity task (if there is one). That is, pressing back from the task
4607 * will always return the user to home even if that was not the last activity they
4608 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4609 */
4610 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4611 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004612 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4613 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004614 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004615 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004616 * this flag. When set and the task's activity is finished, the recents
4617 * entry will remain in the interface for the user to re-launch it, like a
4618 * recents entry for a top-level application.
4619 * <p>
4620 * The receiving activity can override this request with
4621 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4622 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004623 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004624 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004625 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004626
4627 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004628 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4629 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004630 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4631 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004632 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004633 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004634
4635 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004636 * If set, when sending a broadcast only registered receivers will be
4637 * called -- no BroadcastReceiver components will be launched.
4638 */
4639 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004640 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004641 * If set, when sending a broadcast the new broadcast will replace
4642 * any existing pending broadcast that matches it. Matching is defined
4643 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4644 * true for the intents of the two broadcasts. When a match is found,
4645 * the new broadcast (and receivers associated with it) will replace the
4646 * existing one in the pending broadcast list, remaining at the same
4647 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004648 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004649 * <p>This flag is most typically used with sticky broadcasts, which
4650 * only care about delivering the most recent values of the broadcast
4651 * to their receivers.
4652 */
4653 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4654 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004655 * If set, when sending a broadcast the recipient is allowed to run at
4656 * foreground priority, with a shorter timeout interval. During normal
4657 * broadcasts the receivers are not automatically hoisted out of the
4658 * background priority class.
4659 */
4660 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4661 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004662 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4663 * They can still propagate results through to later receivers, but they can not prevent
4664 * later receivers from seeing the broadcast.
4665 */
4666 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4667 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004668 * If set, when sending a broadcast <i>before boot has completed</i> only
4669 * registered receivers will be called -- no BroadcastReceiver components
4670 * will be launched. Sticky intent state will be recorded properly even
4671 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4672 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004673 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004674 * <p>This flag is only for use by system sevices as a convenience to
4675 * avoid having to implement a more complex mechanism around detection
4676 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004677 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004678 * @hide
4679 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004680 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004681 /**
4682 * Set when this broadcast is for a boot upgrade, a special mode that
4683 * allows the broadcast to be sent before the system is ready and launches
4684 * the app process with no providers running in it.
4685 * @hide
4686 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004687 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004688 /**
4689 * If set, the broadcast will always go to manifest receivers in background (cached
4690 * or not running) apps, regardless of whether that would be done by default. By
4691 * default they will only receive broadcasts if the broadcast has specified an
4692 * explicit component or package name.
4693 * @hide
4694 */
4695 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4696 /**
4697 * If set, the broadcast will never go to manifest receivers in background (cached
4698 * or not running) apps, regardless of whether that would be done by default. By
4699 * default they will receive broadcasts if the broadcast has specified an
4700 * explicit component or package name.
4701 * @hide
4702 */
4703 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004704
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004705 /**
4706 * @hide Flags that can't be changed with PendingIntent.
4707 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004708 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4709 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4710 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004711
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004712 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004713 // ---------------------------------------------------------------------
4714 // toUri() and parseUri() options.
4715
4716 /**
4717 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4718 * always has the "intent:" scheme. This syntax can be used when you want
4719 * to later disambiguate between URIs that are intended to describe an
4720 * Intent vs. all others that should be treated as raw URIs. When used
4721 * with {@link #parseUri}, any other scheme will result in a generic
4722 * VIEW action for that raw URI.
4723 */
4724 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004725
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004726 /**
4727 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4728 * always has the "android-app:" scheme. This is a variation of
4729 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4730 * http/https URI being delivered to a specific package name. The format
4731 * is:
4732 *
4733 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004734 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004735 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004736 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4737 * you must also include a scheme; including a path also requires both a host and a scheme.
4738 * The final #Intent; fragment can be used without a scheme, host, or path.
4739 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004740 * used with intents that have a {@link #setSelector}, since the base intent
4741 * will always have an explicit package name.</p>
4742 *
4743 * <p>Some examples of how this scheme maps to Intent objects:</p>
4744 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4745 * <colgroup align="left" />
4746 * <colgroup align="left" />
4747 * <thead>
4748 * <tr><th>URI</th> <th>Intent</th></tr>
4749 * </thead>
4750 *
4751 * <tbody>
4752 * <tr><td><code>android-app://com.example.app</code></td>
4753 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4754 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4755 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4756 * </table></td>
4757 * </tr>
4758 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4759 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4760 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4761 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4762 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4763 * </table></td>
4764 * </tr>
4765 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4766 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4767 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4768 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4769 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4770 * </table></td>
4771 * </tr>
4772 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4773 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4774 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4775 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4776 * </table></td>
4777 * </tr>
4778 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4779 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4780 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4781 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4782 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4783 * </table></td>
4784 * </tr>
4785 * <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>
4786 * <td><table border="" style="margin:0" >
4787 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4788 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4789 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4790 * </table></td>
4791 * </tr>
4792 * </tbody>
4793 * </table>
4794 */
4795 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4796
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004797 /**
4798 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4799 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4800 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4801 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4802 * generated Intent can not cause unexpected data access to happen.
4803 *
4804 * <p>If you do not trust the source of the URI being parsed, you should still do further
4805 * processing to protect yourself from it. In particular, when using it to start an
4806 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4807 * that can handle it.</p>
4808 */
4809 public static final int URI_ALLOW_UNSAFE = 1<<2;
4810
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004811 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004812
4813 private String mAction;
4814 private Uri mData;
4815 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004816 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004817 private ComponentName mComponent;
4818 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004819 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004820 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004821 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004822 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004823 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004824 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004825
4826 // ---------------------------------------------------------------------
4827
4828 /**
4829 * Create an empty intent.
4830 */
4831 public Intent() {
4832 }
4833
4834 /**
4835 * Copy constructor.
4836 */
4837 public Intent(Intent o) {
4838 this.mAction = o.mAction;
4839 this.mData = o.mData;
4840 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004841 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004842 this.mComponent = o.mComponent;
4843 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004844 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004845 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004846 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004847 }
4848 if (o.mExtras != null) {
4849 this.mExtras = new Bundle(o.mExtras);
4850 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004851 if (o.mSourceBounds != null) {
4852 this.mSourceBounds = new Rect(o.mSourceBounds);
4853 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004854 if (o.mSelector != null) {
4855 this.mSelector = new Intent(o.mSelector);
4856 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004857 if (o.mClipData != null) {
4858 this.mClipData = new ClipData(o.mClipData);
4859 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004860 }
4861
4862 @Override
4863 public Object clone() {
4864 return new Intent(this);
4865 }
4866
4867 private Intent(Intent o, boolean all) {
4868 this.mAction = o.mAction;
4869 this.mData = o.mData;
4870 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004871 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004872 this.mComponent = o.mComponent;
4873 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004874 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004875 }
4876 }
4877
4878 /**
4879 * Make a clone of only the parts of the Intent that are relevant for
4880 * filter matching: the action, data, type, component, and categories.
4881 */
4882 public Intent cloneFilter() {
4883 return new Intent(this, false);
4884 }
4885
4886 /**
4887 * Create an intent with a given action. All other fields (data, type,
4888 * class) are null. Note that the action <em>must</em> be in a
4889 * namespace because Intents are used globally in the system -- for
4890 * example the system VIEW action is android.intent.action.VIEW; an
4891 * application's custom action would be something like
4892 * com.google.app.myapp.CUSTOM_ACTION.
4893 *
4894 * @param action The Intent action, such as ACTION_VIEW.
4895 */
4896 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004897 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004898 }
4899
4900 /**
4901 * Create an intent with a given action and for a given data url. Note
4902 * that the action <em>must</em> be in a namespace because Intents are
4903 * used globally in the system -- for example the system VIEW action is
4904 * android.intent.action.VIEW; an application's custom action would be
4905 * something like com.google.app.myapp.CUSTOM_ACTION.
4906 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004907 * <p><em>Note: scheme and host name matching in the Android framework is
4908 * case-sensitive, unlike the formal RFC. As a result,
4909 * you should always ensure that you write your Uri with these elements
4910 * using lower case letters, and normalize any Uris you receive from
4911 * outside of Android to ensure the scheme and host is lower case.</em></p>
4912 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004913 * @param action The Intent action, such as ACTION_VIEW.
4914 * @param uri The Intent data URI.
4915 */
4916 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004917 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004918 mData = uri;
4919 }
4920
4921 /**
4922 * Create an intent for a specific component. All other fields (action, data,
4923 * type, class) are null, though they can be modified later with explicit
4924 * calls. This provides a convenient way to create an intent that is
4925 * intended to execute a hard-coded class name, rather than relying on the
4926 * system to find an appropriate class for you; see {@link #setComponent}
4927 * for more information on the repercussions of this.
4928 *
4929 * @param packageContext A Context of the application package implementing
4930 * this class.
4931 * @param cls The component class that is to be used for the intent.
4932 *
4933 * @see #setClass
4934 * @see #setComponent
4935 * @see #Intent(String, android.net.Uri , Context, Class)
4936 */
4937 public Intent(Context packageContext, Class<?> cls) {
4938 mComponent = new ComponentName(packageContext, cls);
4939 }
4940
4941 /**
4942 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004943 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004944 * construct the Intent and then calling {@link #setClass} to set its
4945 * class.
4946 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004947 * <p><em>Note: scheme and host name matching in the Android framework is
4948 * case-sensitive, unlike the formal RFC. As a result,
4949 * you should always ensure that you write your Uri with these elements
4950 * using lower case letters, and normalize any Uris you receive from
4951 * outside of Android to ensure the scheme and host is lower case.</em></p>
4952 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004953 * @param action The Intent action, such as ACTION_VIEW.
4954 * @param uri The Intent data URI.
4955 * @param packageContext A Context of the application package implementing
4956 * this class.
4957 * @param cls The component class that is to be used for the intent.
4958 *
4959 * @see #Intent(String, android.net.Uri)
4960 * @see #Intent(Context, Class)
4961 * @see #setClass
4962 * @see #setComponent
4963 */
4964 public Intent(String action, Uri uri,
4965 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004966 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004967 mData = uri;
4968 mComponent = new ComponentName(packageContext, cls);
4969 }
4970
4971 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004972 * Create an intent to launch the main (root) activity of a task. This
4973 * is the Intent that is started when the application's is launched from
4974 * Home. For anything else that wants to launch an application in the
4975 * same way, it is important that they use an Intent structured the same
4976 * way, and can use this function to ensure this is the case.
4977 *
4978 * <p>The returned Intent has the given Activity component as its explicit
4979 * component, {@link #ACTION_MAIN} as its action, and includes the
4980 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4981 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4982 * to do that through {@link #addFlags(int)} on the returned Intent.
4983 *
4984 * @param mainActivity The main activity component that this Intent will
4985 * launch.
4986 * @return Returns a newly created Intent that can be used to launch the
4987 * activity as a main application entry.
4988 *
4989 * @see #setClass
4990 * @see #setComponent
4991 */
4992 public static Intent makeMainActivity(ComponentName mainActivity) {
4993 Intent intent = new Intent(ACTION_MAIN);
4994 intent.setComponent(mainActivity);
4995 intent.addCategory(CATEGORY_LAUNCHER);
4996 return intent;
4997 }
4998
4999 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005000 * Make an Intent for the main activity of an application, without
5001 * specifying a specific activity to run but giving a selector to find
5002 * the activity. This results in a final Intent that is structured
5003 * the same as when the application is launched from
5004 * Home. For anything else that wants to launch an application in the
5005 * same way, it is important that they use an Intent structured the same
5006 * way, and can use this function to ensure this is the case.
5007 *
5008 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5009 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5010 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5011 * to do that through {@link #addFlags(int)} on the returned Intent.
5012 *
5013 * @param selectorAction The action name of the Intent's selector.
5014 * @param selectorCategory The name of a category to add to the Intent's
5015 * selector.
5016 * @return Returns a newly created Intent that can be used to launch the
5017 * activity as a main application entry.
5018 *
5019 * @see #setSelector(Intent)
5020 */
5021 public static Intent makeMainSelectorActivity(String selectorAction,
5022 String selectorCategory) {
5023 Intent intent = new Intent(ACTION_MAIN);
5024 intent.addCategory(CATEGORY_LAUNCHER);
5025 Intent selector = new Intent();
5026 selector.setAction(selectorAction);
5027 selector.addCategory(selectorCategory);
5028 intent.setSelector(selector);
5029 return intent;
5030 }
5031
5032 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005033 * Make an Intent that can be used to re-launch an application's task
5034 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5035 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5036 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5037 *
5038 * @param mainActivity The activity component that is the root of the
5039 * task; this is the activity that has been published in the application's
5040 * manifest as the main launcher icon.
5041 *
5042 * @return Returns a newly created Intent that can be used to relaunch the
5043 * activity's task in its root state.
5044 */
5045 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5046 Intent intent = makeMainActivity(mainActivity);
5047 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5048 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5049 return intent;
5050 }
5051
5052 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005053 * Call {@link #parseUri} with 0 flags.
5054 * @deprecated Use {@link #parseUri} instead.
5055 */
5056 @Deprecated
5057 public static Intent getIntent(String uri) throws URISyntaxException {
5058 return parseUri(uri, 0);
5059 }
Tom Taylord4a47292009-12-21 13:59:18 -08005060
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005061 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005062 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005063 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005064 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005065 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005066 *
5067 * <p>The URI given here must not be relative -- that is, it must include
5068 * the scheme and full path.
5069 *
5070 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005071 * @param flags Additional processing flags. Either 0,
5072 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005073 *
5074 * @return Intent The newly created Intent object.
5075 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005076 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5077 * it bad (as parsed by the Uri class) or the Intent data within the
5078 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005079 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005080 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005082 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005083 int i = 0;
5084 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005085 final boolean androidApp = uri.startsWith("android-app:");
5086
5087 // Validate intent scheme if requested.
5088 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5089 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005090 Intent intent = new Intent(ACTION_VIEW);
5091 try {
5092 intent.setData(Uri.parse(uri));
5093 } catch (IllegalArgumentException e) {
5094 throw new URISyntaxException(uri, e.getMessage());
5095 }
5096 return intent;
5097 }
5098 }
Tom Taylord4a47292009-12-21 13:59:18 -08005099
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005100 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005101 // simple case
5102 if (i == -1) {
5103 if (!androidApp) {
5104 return new Intent(ACTION_VIEW, Uri.parse(uri));
5105 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106
5107 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005108 } else if (!uri.startsWith("#Intent;", i)) {
5109 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005110 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005111 } else {
5112 i = -1;
5113 }
5114 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005115
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005116 // new format
5117 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005118 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005119 boolean explicitAction = false;
5120 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005121
5122 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005123 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005124 String data;
5125 if (i >= 0) {
5126 data = uri.substring(0, i);
5127 i += 8; // length of "#Intent;"
5128 } else {
5129 data = uri;
5130 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005131
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005132 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005133 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005134 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005135 if (eq < 0) eq = i-1;
5136 int semi = uri.indexOf(';', i);
5137 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005138
5139 // action
5140 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005141 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005142 if (!inSelector) {
5143 explicitAction = true;
5144 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005145 }
5146
5147 // categories
5148 else if (uri.startsWith("category=", i)) {
5149 intent.addCategory(value);
5150 }
5151
5152 // type
5153 else if (uri.startsWith("type=", i)) {
5154 intent.mType = value;
5155 }
5156
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005157 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005158 else if (uri.startsWith("launchFlags=", i)) {
5159 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005160 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5161 intent.mFlags &= ~IMMUTABLE_FLAGS;
5162 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005163 }
5164
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005165 // package
5166 else if (uri.startsWith("package=", i)) {
5167 intent.mPackage = value;
5168 }
5169
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005170 // component
5171 else if (uri.startsWith("component=", i)) {
5172 intent.mComponent = ComponentName.unflattenFromString(value);
5173 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005174
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005175 // scheme
5176 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005177 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005178 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005179 } else {
5180 scheme = value;
5181 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005182 }
5183
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005184 // source bounds
5185 else if (uri.startsWith("sourceBounds=", i)) {
5186 intent.mSourceBounds = Rect.unflattenFromString(value);
5187 }
5188
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005189 // selector
5190 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5191 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005192 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005193 }
5194
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005195 // extra
5196 else {
5197 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005198 // create Bundle if it doesn't already exist
5199 if (intent.mExtras == null) intent.mExtras = new Bundle();
5200 Bundle b = intent.mExtras;
5201 // add EXTRA
5202 if (uri.startsWith("S.", i)) b.putString(key, value);
5203 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5204 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5205 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5206 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5207 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5208 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5209 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5210 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5211 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5212 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005213
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005214 // move to the next item
5215 i = semi + 1;
5216 }
5217
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005218 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005219 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005220 if (baseIntent.mPackage == null) {
5221 baseIntent.setSelector(intent);
5222 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005223 intent = baseIntent;
5224 }
5225
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005226 if (data != null) {
5227 if (data.startsWith("intent:")) {
5228 data = data.substring(7);
5229 if (scheme != null) {
5230 data = scheme + ':' + data;
5231 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005232 } else if (data.startsWith("android-app:")) {
5233 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5234 // Correctly formed android-app, first part is package name.
5235 int end = data.indexOf('/', 14);
5236 if (end < 0) {
5237 // All we have is a package name.
5238 intent.mPackage = data.substring(14);
5239 if (!explicitAction) {
5240 intent.setAction(ACTION_MAIN);
5241 }
5242 data = "";
5243 } else {
5244 // Target the Intent at the given package name always.
5245 String authority = null;
5246 intent.mPackage = data.substring(14, end);
5247 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005248 if ((end+1) < data.length()) {
5249 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5250 // Found a scheme, remember it.
5251 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005252 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005253 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5254 // Found a authority, remember it.
5255 authority = data.substring(end+1, newEnd);
5256 end = newEnd;
5257 }
5258 } else {
5259 // All we have is a scheme.
5260 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005261 }
5262 }
5263 if (scheme == null) {
5264 // If there was no scheme, then this just targets the package.
5265 if (!explicitAction) {
5266 intent.setAction(ACTION_MAIN);
5267 }
5268 data = "";
5269 } else if (authority == null) {
5270 data = scheme + ":";
5271 } else {
5272 data = scheme + "://" + authority + data.substring(end);
5273 }
5274 }
5275 } else {
5276 data = "";
5277 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005278 }
Tom Taylord4a47292009-12-21 13:59:18 -08005279
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005280 if (data.length() > 0) {
5281 try {
5282 intent.mData = Uri.parse(data);
5283 } catch (IllegalArgumentException e) {
5284 throw new URISyntaxException(uri, e.getMessage());
5285 }
5286 }
5287 }
Tom Taylord4a47292009-12-21 13:59:18 -08005288
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005289 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005290
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005291 } catch (IndexOutOfBoundsException e) {
5292 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5293 }
5294 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005295
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005296 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005297 return getIntentOld(uri, 0);
5298 }
5299
5300 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005301 Intent intent;
5302
5303 int i = uri.lastIndexOf('#');
5304 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005305 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005306 final int intentFragmentStart = i;
5307 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005308
5309 i++;
5310
5311 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005312 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 i += 7;
5314 int j = uri.indexOf(')', i);
5315 action = uri.substring(i, j);
5316 i = j + 1;
5317 }
5318
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005319 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005320
5321 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005322 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005323 i += 11;
5324 int j = uri.indexOf(')', i);
5325 while (i < j) {
5326 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005327 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005328 if (i < sep) {
5329 intent.addCategory(uri.substring(i, sep));
5330 }
5331 i = sep + 1;
5332 }
5333 i = j + 1;
5334 }
5335
5336 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005337 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005338 i += 5;
5339 int j = uri.indexOf(')', i);
5340 intent.mType = uri.substring(i, j);
5341 i = j + 1;
5342 }
5343
5344 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005345 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005346 i += 12;
5347 int j = uri.indexOf(')', i);
5348 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005349 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5350 intent.mFlags &= ~IMMUTABLE_FLAGS;
5351 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005352 i = j + 1;
5353 }
5354
5355 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005356 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005357 i += 10;
5358 int j = uri.indexOf(')', i);
5359 int sep = uri.indexOf('!', i);
5360 if (sep >= 0 && sep < j) {
5361 String pkg = uri.substring(i, sep);
5362 String cls = uri.substring(sep + 1, j);
5363 intent.mComponent = new ComponentName(pkg, cls);
5364 }
5365 i = j + 1;
5366 }
5367
5368 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005369 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005370 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005371
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005372 final int closeParen = uri.indexOf(')', i);
5373 if (closeParen == -1) throw new URISyntaxException(uri,
5374 "EXTRA missing trailing ')'", i);
5375
5376 while (i < closeParen) {
5377 // fetch the key value
5378 int j = uri.indexOf('=', i);
5379 if (j <= i + 1 || i >= closeParen) {
5380 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5381 }
5382 char type = uri.charAt(i);
5383 i++;
5384 String key = uri.substring(i, j);
5385 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005386
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005387 // get type-value
5388 j = uri.indexOf('!', i);
5389 if (j == -1 || j >= closeParen) j = closeParen;
5390 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5391 String value = uri.substring(i, j);
5392 i = j;
5393
5394 // create Bundle if it doesn't already exist
5395 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005396
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005397 // add item to bundle
5398 try {
5399 switch (type) {
5400 case 'S':
5401 intent.mExtras.putString(key, Uri.decode(value));
5402 break;
5403 case 'B':
5404 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5405 break;
5406 case 'b':
5407 intent.mExtras.putByte(key, Byte.parseByte(value));
5408 break;
5409 case 'c':
5410 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5411 break;
5412 case 'd':
5413 intent.mExtras.putDouble(key, Double.parseDouble(value));
5414 break;
5415 case 'f':
5416 intent.mExtras.putFloat(key, Float.parseFloat(value));
5417 break;
5418 case 'i':
5419 intent.mExtras.putInt(key, Integer.parseInt(value));
5420 break;
5421 case 'l':
5422 intent.mExtras.putLong(key, Long.parseLong(value));
5423 break;
5424 case 's':
5425 intent.mExtras.putShort(key, Short.parseShort(value));
5426 break;
5427 default:
5428 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5429 }
5430 } catch (NumberFormatException e) {
5431 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5432 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005433
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005434 char ch = uri.charAt(i);
5435 if (ch == ')') break;
5436 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5437 i++;
5438 }
5439 }
5440
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005441 if (isIntentFragment) {
5442 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5443 } else {
5444 intent.mData = Uri.parse(uri);
5445 }
Tom Taylord4a47292009-12-21 13:59:18 -08005446
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005447 if (intent.mAction == null) {
5448 // By default, if no action is specified, then use VIEW.
5449 intent.mAction = ACTION_VIEW;
5450 }
5451
5452 } else {
5453 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5454 }
5455
5456 return intent;
5457 }
5458
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005459 /** @hide */
5460 public interface CommandOptionHandler {
5461 boolean handleOption(String opt, ShellCommand cmd);
5462 }
5463
5464 /** @hide */
5465 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5466 throws URISyntaxException {
5467 Intent intent = new Intent();
5468 Intent baseIntent = intent;
5469 boolean hasIntentInfo = false;
5470
5471 Uri data = null;
5472 String type = null;
5473
5474 String opt;
5475 while ((opt=cmd.getNextOption()) != null) {
5476 switch (opt) {
5477 case "-a":
5478 intent.setAction(cmd.getNextArgRequired());
5479 if (intent == baseIntent) {
5480 hasIntentInfo = true;
5481 }
5482 break;
5483 case "-d":
5484 data = Uri.parse(cmd.getNextArgRequired());
5485 if (intent == baseIntent) {
5486 hasIntentInfo = true;
5487 }
5488 break;
5489 case "-t":
5490 type = cmd.getNextArgRequired();
5491 if (intent == baseIntent) {
5492 hasIntentInfo = true;
5493 }
5494 break;
5495 case "-c":
5496 intent.addCategory(cmd.getNextArgRequired());
5497 if (intent == baseIntent) {
5498 hasIntentInfo = true;
5499 }
5500 break;
5501 case "-e":
5502 case "--es": {
5503 String key = cmd.getNextArgRequired();
5504 String value = cmd.getNextArgRequired();
5505 intent.putExtra(key, value);
5506 }
5507 break;
5508 case "--esn": {
5509 String key = cmd.getNextArgRequired();
5510 intent.putExtra(key, (String) null);
5511 }
5512 break;
5513 case "--ei": {
5514 String key = cmd.getNextArgRequired();
5515 String value = cmd.getNextArgRequired();
5516 intent.putExtra(key, Integer.decode(value));
5517 }
5518 break;
5519 case "--eu": {
5520 String key = cmd.getNextArgRequired();
5521 String value = cmd.getNextArgRequired();
5522 intent.putExtra(key, Uri.parse(value));
5523 }
5524 break;
5525 case "--ecn": {
5526 String key = cmd.getNextArgRequired();
5527 String value = cmd.getNextArgRequired();
5528 ComponentName cn = ComponentName.unflattenFromString(value);
5529 if (cn == null)
5530 throw new IllegalArgumentException("Bad component name: " + value);
5531 intent.putExtra(key, cn);
5532 }
5533 break;
5534 case "--eia": {
5535 String key = cmd.getNextArgRequired();
5536 String value = cmd.getNextArgRequired();
5537 String[] strings = value.split(",");
5538 int[] list = new int[strings.length];
5539 for (int i = 0; i < strings.length; i++) {
5540 list[i] = Integer.decode(strings[i]);
5541 }
5542 intent.putExtra(key, list);
5543 }
5544 break;
5545 case "--eial": {
5546 String key = cmd.getNextArgRequired();
5547 String value = cmd.getNextArgRequired();
5548 String[] strings = value.split(",");
5549 ArrayList<Integer> list = new ArrayList<>(strings.length);
5550 for (int i = 0; i < strings.length; i++) {
5551 list.add(Integer.decode(strings[i]));
5552 }
5553 intent.putExtra(key, list);
5554 }
5555 break;
5556 case "--el": {
5557 String key = cmd.getNextArgRequired();
5558 String value = cmd.getNextArgRequired();
5559 intent.putExtra(key, Long.valueOf(value));
5560 }
5561 break;
5562 case "--ela": {
5563 String key = cmd.getNextArgRequired();
5564 String value = cmd.getNextArgRequired();
5565 String[] strings = value.split(",");
5566 long[] list = new long[strings.length];
5567 for (int i = 0; i < strings.length; i++) {
5568 list[i] = Long.valueOf(strings[i]);
5569 }
5570 intent.putExtra(key, list);
5571 hasIntentInfo = true;
5572 }
5573 break;
5574 case "--elal": {
5575 String key = cmd.getNextArgRequired();
5576 String value = cmd.getNextArgRequired();
5577 String[] strings = value.split(",");
5578 ArrayList<Long> list = new ArrayList<>(strings.length);
5579 for (int i = 0; i < strings.length; i++) {
5580 list.add(Long.valueOf(strings[i]));
5581 }
5582 intent.putExtra(key, list);
5583 hasIntentInfo = true;
5584 }
5585 break;
5586 case "--ef": {
5587 String key = cmd.getNextArgRequired();
5588 String value = cmd.getNextArgRequired();
5589 intent.putExtra(key, Float.valueOf(value));
5590 hasIntentInfo = true;
5591 }
5592 break;
5593 case "--efa": {
5594 String key = cmd.getNextArgRequired();
5595 String value = cmd.getNextArgRequired();
5596 String[] strings = value.split(",");
5597 float[] list = new float[strings.length];
5598 for (int i = 0; i < strings.length; i++) {
5599 list[i] = Float.valueOf(strings[i]);
5600 }
5601 intent.putExtra(key, list);
5602 hasIntentInfo = true;
5603 }
5604 break;
5605 case "--efal": {
5606 String key = cmd.getNextArgRequired();
5607 String value = cmd.getNextArgRequired();
5608 String[] strings = value.split(",");
5609 ArrayList<Float> list = new ArrayList<>(strings.length);
5610 for (int i = 0; i < strings.length; i++) {
5611 list.add(Float.valueOf(strings[i]));
5612 }
5613 intent.putExtra(key, list);
5614 hasIntentInfo = true;
5615 }
5616 break;
5617 case "--esa": {
5618 String key = cmd.getNextArgRequired();
5619 String value = cmd.getNextArgRequired();
5620 // Split on commas unless they are preceeded by an escape.
5621 // The escape character must be escaped for the string and
5622 // again for the regex, thus four escape characters become one.
5623 String[] strings = value.split("(?<!\\\\),");
5624 intent.putExtra(key, strings);
5625 hasIntentInfo = true;
5626 }
5627 break;
5628 case "--esal": {
5629 String key = cmd.getNextArgRequired();
5630 String value = cmd.getNextArgRequired();
5631 // Split on commas unless they are preceeded by an escape.
5632 // The escape character must be escaped for the string and
5633 // again for the regex, thus four escape characters become one.
5634 String[] strings = value.split("(?<!\\\\),");
5635 ArrayList<String> list = new ArrayList<>(strings.length);
5636 for (int i = 0; i < strings.length; i++) {
5637 list.add(strings[i]);
5638 }
5639 intent.putExtra(key, list);
5640 hasIntentInfo = true;
5641 }
5642 break;
5643 case "--ez": {
5644 String key = cmd.getNextArgRequired();
5645 String value = cmd.getNextArgRequired().toLowerCase();
5646 // Boolean.valueOf() results in false for anything that is not "true", which is
5647 // error-prone in shell commands
5648 boolean arg;
5649 if ("true".equals(value) || "t".equals(value)) {
5650 arg = true;
5651 } else if ("false".equals(value) || "f".equals(value)) {
5652 arg = false;
5653 } else {
5654 try {
5655 arg = Integer.decode(value) != 0;
5656 } catch (NumberFormatException ex) {
5657 throw new IllegalArgumentException("Invalid boolean value: " + value);
5658 }
5659 }
5660
5661 intent.putExtra(key, arg);
5662 }
5663 break;
5664 case "-n": {
5665 String str = cmd.getNextArgRequired();
5666 ComponentName cn = ComponentName.unflattenFromString(str);
5667 if (cn == null)
5668 throw new IllegalArgumentException("Bad component name: " + str);
5669 intent.setComponent(cn);
5670 if (intent == baseIntent) {
5671 hasIntentInfo = true;
5672 }
5673 }
5674 break;
5675 case "-p": {
5676 String str = cmd.getNextArgRequired();
5677 intent.setPackage(str);
5678 if (intent == baseIntent) {
5679 hasIntentInfo = true;
5680 }
5681 }
5682 break;
5683 case "-f":
5684 String str = cmd.getNextArgRequired();
5685 intent.setFlags(Integer.decode(str).intValue());
5686 break;
5687 case "--grant-read-uri-permission":
5688 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5689 break;
5690 case "--grant-write-uri-permission":
5691 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5692 break;
5693 case "--grant-persistable-uri-permission":
5694 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5695 break;
5696 case "--grant-prefix-uri-permission":
5697 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5698 break;
5699 case "--exclude-stopped-packages":
5700 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5701 break;
5702 case "--include-stopped-packages":
5703 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5704 break;
5705 case "--debug-log-resolution":
5706 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5707 break;
5708 case "--activity-brought-to-front":
5709 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5710 break;
5711 case "--activity-clear-top":
5712 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5713 break;
5714 case "--activity-clear-when-task-reset":
5715 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5716 break;
5717 case "--activity-exclude-from-recents":
5718 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5719 break;
5720 case "--activity-launched-from-history":
5721 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5722 break;
5723 case "--activity-multiple-task":
5724 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5725 break;
5726 case "--activity-no-animation":
5727 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5728 break;
5729 case "--activity-no-history":
5730 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5731 break;
5732 case "--activity-no-user-action":
5733 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5734 break;
5735 case "--activity-previous-is-top":
5736 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5737 break;
5738 case "--activity-reorder-to-front":
5739 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5740 break;
5741 case "--activity-reset-task-if-needed":
5742 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5743 break;
5744 case "--activity-single-top":
5745 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5746 break;
5747 case "--activity-clear-task":
5748 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5749 break;
5750 case "--activity-task-on-home":
5751 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5752 break;
5753 case "--receiver-registered-only":
5754 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5755 break;
5756 case "--receiver-replace-pending":
5757 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5758 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005759 case "--receiver-foreground":
5760 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5761 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005762 case "--selector":
5763 intent.setDataAndType(data, type);
5764 intent = new Intent();
5765 break;
5766 default:
5767 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5768 // Okay, caller handled this option.
5769 } else {
5770 throw new IllegalArgumentException("Unknown option: " + opt);
5771 }
5772 break;
5773 }
5774 }
5775 intent.setDataAndType(data, type);
5776
5777 final boolean hasSelector = intent != baseIntent;
5778 if (hasSelector) {
5779 // A selector was specified; fix up.
5780 baseIntent.setSelector(intent);
5781 intent = baseIntent;
5782 }
5783
5784 String arg = cmd.getNextArg();
5785 baseIntent = null;
5786 if (arg == null) {
5787 if (hasSelector) {
5788 // If a selector has been specified, and no arguments
5789 // have been supplied for the main Intent, then we can
5790 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5791 // need to have a component name specified yet, the
5792 // selector will take care of that.
5793 baseIntent = new Intent(Intent.ACTION_MAIN);
5794 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5795 }
5796 } else if (arg.indexOf(':') >= 0) {
5797 // The argument is a URI. Fully parse it, and use that result
5798 // to fill in any data not specified so far.
5799 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5800 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5801 } else if (arg.indexOf('/') >= 0) {
5802 // The argument is a component name. Build an Intent to launch
5803 // it.
5804 baseIntent = new Intent(Intent.ACTION_MAIN);
5805 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5806 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5807 } else {
5808 // Assume the argument is a package name.
5809 baseIntent = new Intent(Intent.ACTION_MAIN);
5810 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5811 baseIntent.setPackage(arg);
5812 }
5813 if (baseIntent != null) {
5814 Bundle extras = intent.getExtras();
5815 intent.replaceExtras((Bundle)null);
5816 Bundle uriExtras = baseIntent.getExtras();
5817 baseIntent.replaceExtras((Bundle)null);
5818 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5819 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5820 for (String c : cats) {
5821 baseIntent.removeCategory(c);
5822 }
5823 }
5824 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5825 if (extras == null) {
5826 extras = uriExtras;
5827 } else if (uriExtras != null) {
5828 uriExtras.putAll(extras);
5829 extras = uriExtras;
5830 }
5831 intent.replaceExtras(extras);
5832 hasIntentInfo = true;
5833 }
5834
5835 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5836 return intent;
5837 }
5838
5839 /** @hide */
5840 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5841 final String[] lines = new String[] {
5842 "<INTENT> specifications include these flags and arguments:",
5843 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5844 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5845 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5846 " [--esn <EXTRA_KEY> ...]",
5847 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5848 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5849 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5850 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5851 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5852 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5853 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5854 " (mutiple extras passed as Integer[])",
5855 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5856 " (mutiple extras passed as List<Integer>)",
5857 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5858 " (mutiple extras passed as Long[])",
5859 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5860 " (mutiple extras passed as List<Long>)",
5861 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5862 " (mutiple extras passed as Float[])",
5863 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5864 " (mutiple extras passed as List<Float>)",
5865 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5866 " (mutiple extras passed as String[]; to embed a comma into a string,",
5867 " escape it using \"\\,\")",
5868 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5869 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5870 " escape it using \"\\,\")",
Felipe Leme545569d2016-01-11 16:27:58 -08005871 " [-f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005872 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5873 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5874 " [--debug-log-resolution] [--exclude-stopped-packages]",
5875 " [--include-stopped-packages]",
5876 " [--activity-brought-to-front] [--activity-clear-top]",
5877 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5878 " [--activity-launched-from-history] [--activity-multiple-task]",
5879 " [--activity-no-animation] [--activity-no-history]",
5880 " [--activity-no-user-action] [--activity-previous-is-top]",
5881 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5882 " [--activity-single-top] [--activity-clear-task]",
5883 " [--activity-task-on-home]",
5884 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005885 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005886 " [--selector]",
5887 " [<URI> | <PACKAGE> | <COMPONENT>]"
5888 };
5889 for (String line : lines) {
5890 pw.print(prefix);
5891 pw.println(line);
5892 }
5893 }
5894
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005895 /**
5896 * Retrieve the general action to be performed, such as
5897 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5898 * the information in the intent should be interpreted -- most importantly,
5899 * what to do with the data returned by {@link #getData}.
5900 *
5901 * @return The action of this intent or null if none is specified.
5902 *
5903 * @see #setAction
5904 */
5905 public String getAction() {
5906 return mAction;
5907 }
5908
5909 /**
5910 * Retrieve data this intent is operating on. This URI specifies the name
5911 * of the data; often it uses the content: scheme, specifying data in a
5912 * content provider. Other schemes may be handled by specific activities,
5913 * such as http: by the web browser.
5914 *
5915 * @return The URI of the data this intent is targeting or null.
5916 *
5917 * @see #getScheme
5918 * @see #setData
5919 */
5920 public Uri getData() {
5921 return mData;
5922 }
5923
5924 /**
5925 * The same as {@link #getData()}, but returns the URI as an encoded
5926 * String.
5927 */
5928 public String getDataString() {
5929 return mData != null ? mData.toString() : null;
5930 }
5931
5932 /**
5933 * Return the scheme portion of the intent's data. If the data is null or
5934 * does not include a scheme, null is returned. Otherwise, the scheme
5935 * prefix without the final ':' is returned, i.e. "http".
5936 *
5937 * <p>This is the same as calling getData().getScheme() (and checking for
5938 * null data).
5939 *
5940 * @return The scheme of this intent.
5941 *
5942 * @see #getData
5943 */
5944 public String getScheme() {
5945 return mData != null ? mData.getScheme() : null;
5946 }
5947
5948 /**
5949 * Retrieve any explicit MIME type included in the intent. This is usually
5950 * null, as the type is determined by the intent data.
5951 *
5952 * @return If a type was manually set, it is returned; else null is
5953 * returned.
5954 *
5955 * @see #resolveType(ContentResolver)
5956 * @see #setType
5957 */
5958 public String getType() {
5959 return mType;
5960 }
5961
5962 /**
5963 * Return the MIME data type of this intent. If the type field is
5964 * explicitly set, that is simply returned. Otherwise, if the data is set,
5965 * the type of that data is returned. If neither fields are set, a null is
5966 * returned.
5967 *
5968 * @return The MIME type of this intent.
5969 *
5970 * @see #getType
5971 * @see #resolveType(ContentResolver)
5972 */
5973 public String resolveType(Context context) {
5974 return resolveType(context.getContentResolver());
5975 }
5976
5977 /**
5978 * Return the MIME data type of this intent. If the type field is
5979 * explicitly set, that is simply returned. Otherwise, if the data is set,
5980 * the type of that data is returned. If neither fields are set, a null is
5981 * returned.
5982 *
5983 * @param resolver A ContentResolver that can be used to determine the MIME
5984 * type of the intent's data.
5985 *
5986 * @return The MIME type of this intent.
5987 *
5988 * @see #getType
5989 * @see #resolveType(Context)
5990 */
5991 public String resolveType(ContentResolver resolver) {
5992 if (mType != null) {
5993 return mType;
5994 }
5995 if (mData != null) {
5996 if ("content".equals(mData.getScheme())) {
5997 return resolver.getType(mData);
5998 }
5999 }
6000 return null;
6001 }
6002
6003 /**
6004 * Return the MIME data type of this intent, only if it will be needed for
6005 * intent resolution. This is not generally useful for application code;
6006 * it is used by the frameworks for communicating with back-end system
6007 * services.
6008 *
6009 * @param resolver A ContentResolver that can be used to determine the MIME
6010 * type of the intent's data.
6011 *
6012 * @return The MIME type of this intent, or null if it is unknown or not
6013 * needed.
6014 */
6015 public String resolveTypeIfNeeded(ContentResolver resolver) {
6016 if (mComponent != null) {
6017 return mType;
6018 }
6019 return resolveType(resolver);
6020 }
6021
6022 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006023 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006024 *
6025 * @param category The category to check.
6026 *
6027 * @return boolean True if the intent contains the category, else false.
6028 *
6029 * @see #getCategories
6030 * @see #addCategory
6031 */
6032 public boolean hasCategory(String category) {
6033 return mCategories != null && mCategories.contains(category);
6034 }
6035
6036 /**
6037 * Return the set of all categories in the intent. If there are no categories,
6038 * returns NULL.
6039 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006040 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006041 *
6042 * @see #hasCategory
6043 * @see #addCategory
6044 */
6045 public Set<String> getCategories() {
6046 return mCategories;
6047 }
6048
6049 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006050 * Return the specific selector associated with this Intent. If there is
6051 * none, returns null. See {@link #setSelector} for more information.
6052 *
6053 * @see #setSelector
6054 */
6055 public Intent getSelector() {
6056 return mSelector;
6057 }
6058
6059 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006060 * Return the {@link ClipData} associated with this Intent. If there is
6061 * none, returns null. See {@link #setClipData} for more information.
6062 *
John Spurlock125d1332013-11-25 11:58:37 -05006063 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006064 */
6065 public ClipData getClipData() {
6066 return mClipData;
6067 }
6068
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006069 /** @hide */
6070 public int getContentUserHint() {
6071 return mContentUserHint;
6072 }
6073
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006074 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006075 * Sets the ClassLoader that will be used when unmarshalling
6076 * any Parcelable values from the extras of this Intent.
6077 *
6078 * @param loader a ClassLoader, or null to use the default loader
6079 * at the time of unmarshalling.
6080 */
6081 public void setExtrasClassLoader(ClassLoader loader) {
6082 if (mExtras != null) {
6083 mExtras.setClassLoader(loader);
6084 }
6085 }
6086
6087 /**
6088 * Returns true if an extra value is associated with the given name.
6089 * @param name the extra's name
6090 * @return true if the given extra is present.
6091 */
6092 public boolean hasExtra(String name) {
6093 return mExtras != null && mExtras.containsKey(name);
6094 }
6095
6096 /**
6097 * Returns true if the Intent's extras contain a parcelled file descriptor.
6098 * @return true if the Intent contains a parcelled file descriptor.
6099 */
6100 public boolean hasFileDescriptors() {
6101 return mExtras != null && mExtras.hasFileDescriptors();
6102 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006103
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006104 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006105 public void setAllowFds(boolean allowFds) {
6106 if (mExtras != null) {
6107 mExtras.setAllowFds(allowFds);
6108 }
6109 }
6110
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006111 /** {@hide} */
6112 public void setDefusable(boolean defusable) {
6113 if (mExtras != null) {
6114 mExtras.setDefusable(defusable);
6115 }
6116 }
6117
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006118 /**
6119 * Retrieve extended data from the intent.
6120 *
6121 * @param name The name of the desired item.
6122 *
6123 * @return the value of an item that previously added with putExtra()
6124 * or null if none was found.
6125 *
6126 * @deprecated
6127 * @hide
6128 */
6129 @Deprecated
6130 public Object getExtra(String name) {
6131 return getExtra(name, null);
6132 }
6133
6134 /**
6135 * Retrieve extended data from the intent.
6136 *
6137 * @param name The name of the desired item.
6138 * @param defaultValue the value to be returned if no value of the desired
6139 * type is stored with the given name.
6140 *
6141 * @return the value of an item that previously added with putExtra()
6142 * or the default value if none was found.
6143 *
6144 * @see #putExtra(String, boolean)
6145 */
6146 public boolean getBooleanExtra(String name, boolean defaultValue) {
6147 return mExtras == null ? defaultValue :
6148 mExtras.getBoolean(name, defaultValue);
6149 }
6150
6151 /**
6152 * Retrieve extended data from the intent.
6153 *
6154 * @param name The name of the desired item.
6155 * @param defaultValue the value to be returned if no value of the desired
6156 * type is stored with the given name.
6157 *
6158 * @return the value of an item that previously added with putExtra()
6159 * or the default value if none was found.
6160 *
6161 * @see #putExtra(String, byte)
6162 */
6163 public byte getByteExtra(String name, byte defaultValue) {
6164 return mExtras == null ? defaultValue :
6165 mExtras.getByte(name, defaultValue);
6166 }
6167
6168 /**
6169 * Retrieve extended data from the intent.
6170 *
6171 * @param name The name of the desired item.
6172 * @param defaultValue the value to be returned if no value of the desired
6173 * type is stored with the given name.
6174 *
6175 * @return the value of an item that previously added with putExtra()
6176 * or the default value if none was found.
6177 *
6178 * @see #putExtra(String, short)
6179 */
6180 public short getShortExtra(String name, short defaultValue) {
6181 return mExtras == null ? defaultValue :
6182 mExtras.getShort(name, defaultValue);
6183 }
6184
6185 /**
6186 * Retrieve extended data from the intent.
6187 *
6188 * @param name The name of the desired item.
6189 * @param defaultValue the value to be returned if no value of the desired
6190 * type is stored with the given name.
6191 *
6192 * @return the value of an item that previously added with putExtra()
6193 * or the default value if none was found.
6194 *
6195 * @see #putExtra(String, char)
6196 */
6197 public char getCharExtra(String name, char defaultValue) {
6198 return mExtras == null ? defaultValue :
6199 mExtras.getChar(name, defaultValue);
6200 }
6201
6202 /**
6203 * Retrieve extended data from the intent.
6204 *
6205 * @param name The name of the desired item.
6206 * @param defaultValue the value to be returned if no value of the desired
6207 * type is stored with the given name.
6208 *
6209 * @return the value of an item that previously added with putExtra()
6210 * or the default value if none was found.
6211 *
6212 * @see #putExtra(String, int)
6213 */
6214 public int getIntExtra(String name, int defaultValue) {
6215 return mExtras == null ? defaultValue :
6216 mExtras.getInt(name, defaultValue);
6217 }
6218
6219 /**
6220 * Retrieve extended data from the intent.
6221 *
6222 * @param name The name of the desired item.
6223 * @param defaultValue the value to be returned if no value of the desired
6224 * type is stored with the given name.
6225 *
6226 * @return the value of an item that previously added with putExtra()
6227 * or the default value if none was found.
6228 *
6229 * @see #putExtra(String, long)
6230 */
6231 public long getLongExtra(String name, long defaultValue) {
6232 return mExtras == null ? defaultValue :
6233 mExtras.getLong(name, defaultValue);
6234 }
6235
6236 /**
6237 * Retrieve extended data from the intent.
6238 *
6239 * @param name The name of the desired item.
6240 * @param defaultValue the value to be returned if no value of the desired
6241 * type is stored with the given name.
6242 *
6243 * @return the value of an item that previously added with putExtra(),
6244 * or the default value if no such item is present
6245 *
6246 * @see #putExtra(String, float)
6247 */
6248 public float getFloatExtra(String name, float defaultValue) {
6249 return mExtras == null ? defaultValue :
6250 mExtras.getFloat(name, defaultValue);
6251 }
6252
6253 /**
6254 * Retrieve extended data from the intent.
6255 *
6256 * @param name The name of the desired item.
6257 * @param defaultValue the value to be returned if no value of the desired
6258 * type is stored with the given name.
6259 *
6260 * @return the value of an item that previously added with putExtra()
6261 * or the default value if none was found.
6262 *
6263 * @see #putExtra(String, double)
6264 */
6265 public double getDoubleExtra(String name, double defaultValue) {
6266 return mExtras == null ? defaultValue :
6267 mExtras.getDouble(name, defaultValue);
6268 }
6269
6270 /**
6271 * Retrieve extended data from the intent.
6272 *
6273 * @param name The name of the desired item.
6274 *
6275 * @return the value of an item that previously added with putExtra()
6276 * or null if no String value was found.
6277 *
6278 * @see #putExtra(String, String)
6279 */
6280 public String getStringExtra(String name) {
6281 return mExtras == null ? null : mExtras.getString(name);
6282 }
6283
6284 /**
6285 * Retrieve extended data from the intent.
6286 *
6287 * @param name The name of the desired item.
6288 *
6289 * @return the value of an item that previously added with putExtra()
6290 * or null if no CharSequence value was found.
6291 *
6292 * @see #putExtra(String, CharSequence)
6293 */
6294 public CharSequence getCharSequenceExtra(String name) {
6295 return mExtras == null ? null : mExtras.getCharSequence(name);
6296 }
6297
6298 /**
6299 * Retrieve extended data from the intent.
6300 *
6301 * @param name The name of the desired item.
6302 *
6303 * @return the value of an item that previously added with putExtra()
6304 * or null if no Parcelable value was found.
6305 *
6306 * @see #putExtra(String, Parcelable)
6307 */
6308 public <T extends Parcelable> T getParcelableExtra(String name) {
6309 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6310 }
6311
6312 /**
6313 * Retrieve extended data from the intent.
6314 *
6315 * @param name The name of the desired item.
6316 *
6317 * @return the value of an item that previously added with putExtra()
6318 * or null if no Parcelable[] value was found.
6319 *
6320 * @see #putExtra(String, Parcelable[])
6321 */
6322 public Parcelable[] getParcelableArrayExtra(String name) {
6323 return mExtras == null ? null : mExtras.getParcelableArray(name);
6324 }
6325
6326 /**
6327 * Retrieve extended data from the intent.
6328 *
6329 * @param name The name of the desired item.
6330 *
6331 * @return the value of an item that previously added with putExtra()
6332 * or null if no ArrayList<Parcelable> value was found.
6333 *
6334 * @see #putParcelableArrayListExtra(String, ArrayList)
6335 */
6336 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6337 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6338 }
6339
6340 /**
6341 * Retrieve extended data from the intent.
6342 *
6343 * @param name The name of the desired item.
6344 *
6345 * @return the value of an item that previously added with putExtra()
6346 * or null if no Serializable value was found.
6347 *
6348 * @see #putExtra(String, Serializable)
6349 */
6350 public Serializable getSerializableExtra(String name) {
6351 return mExtras == null ? null : mExtras.getSerializable(name);
6352 }
6353
6354 /**
6355 * Retrieve extended data from the intent.
6356 *
6357 * @param name The name of the desired item.
6358 *
6359 * @return the value of an item that previously added with putExtra()
6360 * or null if no ArrayList<Integer> value was found.
6361 *
6362 * @see #putIntegerArrayListExtra(String, ArrayList)
6363 */
6364 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6365 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6366 }
6367
6368 /**
6369 * Retrieve extended data from the intent.
6370 *
6371 * @param name The name of the desired item.
6372 *
6373 * @return the value of an item that previously added with putExtra()
6374 * or null if no ArrayList<String> value was found.
6375 *
6376 * @see #putStringArrayListExtra(String, ArrayList)
6377 */
6378 public ArrayList<String> getStringArrayListExtra(String name) {
6379 return mExtras == null ? null : mExtras.getStringArrayList(name);
6380 }
6381
6382 /**
6383 * Retrieve extended data from the intent.
6384 *
6385 * @param name The name of the desired item.
6386 *
6387 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006388 * or null if no ArrayList<CharSequence> value was found.
6389 *
6390 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6391 */
6392 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6393 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6394 }
6395
6396 /**
6397 * Retrieve extended data from the intent.
6398 *
6399 * @param name The name of the desired item.
6400 *
6401 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006402 * or null if no boolean array value was found.
6403 *
6404 * @see #putExtra(String, boolean[])
6405 */
6406 public boolean[] getBooleanArrayExtra(String name) {
6407 return mExtras == null ? null : mExtras.getBooleanArray(name);
6408 }
6409
6410 /**
6411 * Retrieve extended data from the intent.
6412 *
6413 * @param name The name of the desired item.
6414 *
6415 * @return the value of an item that previously added with putExtra()
6416 * or null if no byte array value was found.
6417 *
6418 * @see #putExtra(String, byte[])
6419 */
6420 public byte[] getByteArrayExtra(String name) {
6421 return mExtras == null ? null : mExtras.getByteArray(name);
6422 }
6423
6424 /**
6425 * Retrieve extended data from the intent.
6426 *
6427 * @param name The name of the desired item.
6428 *
6429 * @return the value of an item that previously added with putExtra()
6430 * or null if no short array value was found.
6431 *
6432 * @see #putExtra(String, short[])
6433 */
6434 public short[] getShortArrayExtra(String name) {
6435 return mExtras == null ? null : mExtras.getShortArray(name);
6436 }
6437
6438 /**
6439 * Retrieve extended data from the intent.
6440 *
6441 * @param name The name of the desired item.
6442 *
6443 * @return the value of an item that previously added with putExtra()
6444 * or null if no char array value was found.
6445 *
6446 * @see #putExtra(String, char[])
6447 */
6448 public char[] getCharArrayExtra(String name) {
6449 return mExtras == null ? null : mExtras.getCharArray(name);
6450 }
6451
6452 /**
6453 * Retrieve extended data from the intent.
6454 *
6455 * @param name The name of the desired item.
6456 *
6457 * @return the value of an item that previously added with putExtra()
6458 * or null if no int array value was found.
6459 *
6460 * @see #putExtra(String, int[])
6461 */
6462 public int[] getIntArrayExtra(String name) {
6463 return mExtras == null ? null : mExtras.getIntArray(name);
6464 }
6465
6466 /**
6467 * Retrieve extended data from the intent.
6468 *
6469 * @param name The name of the desired item.
6470 *
6471 * @return the value of an item that previously added with putExtra()
6472 * or null if no long array value was found.
6473 *
6474 * @see #putExtra(String, long[])
6475 */
6476 public long[] getLongArrayExtra(String name) {
6477 return mExtras == null ? null : mExtras.getLongArray(name);
6478 }
6479
6480 /**
6481 * Retrieve extended data from the intent.
6482 *
6483 * @param name The name of the desired item.
6484 *
6485 * @return the value of an item that previously added with putExtra()
6486 * or null if no float array value was found.
6487 *
6488 * @see #putExtra(String, float[])
6489 */
6490 public float[] getFloatArrayExtra(String name) {
6491 return mExtras == null ? null : mExtras.getFloatArray(name);
6492 }
6493
6494 /**
6495 * Retrieve extended data from the intent.
6496 *
6497 * @param name The name of the desired item.
6498 *
6499 * @return the value of an item that previously added with putExtra()
6500 * or null if no double array value was found.
6501 *
6502 * @see #putExtra(String, double[])
6503 */
6504 public double[] getDoubleArrayExtra(String name) {
6505 return mExtras == null ? null : mExtras.getDoubleArray(name);
6506 }
6507
6508 /**
6509 * Retrieve extended data from the intent.
6510 *
6511 * @param name The name of the desired item.
6512 *
6513 * @return the value of an item that previously added with putExtra()
6514 * or null if no String array value was found.
6515 *
6516 * @see #putExtra(String, String[])
6517 */
6518 public String[] getStringArrayExtra(String name) {
6519 return mExtras == null ? null : mExtras.getStringArray(name);
6520 }
6521
6522 /**
6523 * Retrieve extended data from the intent.
6524 *
6525 * @param name The name of the desired item.
6526 *
6527 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006528 * or null if no CharSequence array value was found.
6529 *
6530 * @see #putExtra(String, CharSequence[])
6531 */
6532 public CharSequence[] getCharSequenceArrayExtra(String name) {
6533 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6534 }
6535
6536 /**
6537 * Retrieve extended data from the intent.
6538 *
6539 * @param name The name of the desired item.
6540 *
6541 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006542 * or null if no Bundle value was found.
6543 *
6544 * @see #putExtra(String, Bundle)
6545 */
6546 public Bundle getBundleExtra(String name) {
6547 return mExtras == null ? null : mExtras.getBundle(name);
6548 }
6549
6550 /**
6551 * Retrieve extended data from the intent.
6552 *
6553 * @param name The name of the desired item.
6554 *
6555 * @return the value of an item that previously added with putExtra()
6556 * or null if no IBinder value was found.
6557 *
6558 * @see #putExtra(String, IBinder)
6559 *
6560 * @deprecated
6561 * @hide
6562 */
6563 @Deprecated
6564 public IBinder getIBinderExtra(String name) {
6565 return mExtras == null ? null : mExtras.getIBinder(name);
6566 }
6567
6568 /**
6569 * Retrieve extended data from the intent.
6570 *
6571 * @param name The name of the desired item.
6572 * @param defaultValue The default value to return in case no item is
6573 * associated with the key 'name'
6574 *
6575 * @return the value of an item that previously added with putExtra()
6576 * or defaultValue if none was found.
6577 *
6578 * @see #putExtra
6579 *
6580 * @deprecated
6581 * @hide
6582 */
6583 @Deprecated
6584 public Object getExtra(String name, Object defaultValue) {
6585 Object result = defaultValue;
6586 if (mExtras != null) {
6587 Object result2 = mExtras.get(name);
6588 if (result2 != null) {
6589 result = result2;
6590 }
6591 }
6592
6593 return result;
6594 }
6595
6596 /**
6597 * Retrieves a map of extended data from the intent.
6598 *
6599 * @return the map of all extras previously added with putExtra(),
6600 * or null if none have been added.
6601 */
6602 public Bundle getExtras() {
6603 return (mExtras != null)
6604 ? new Bundle(mExtras)
6605 : null;
6606 }
6607
6608 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006609 * Filter extras to only basic types.
6610 * @hide
6611 */
6612 public void removeUnsafeExtras() {
6613 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006614 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006615 }
6616 }
6617
6618 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006619 * Retrieve any special flags associated with this intent. You will
6620 * normally just set them with {@link #setFlags} and let the system
6621 * take the appropriate action with them.
6622 *
6623 * @return int The currently set flags.
6624 *
6625 * @see #setFlags
6626 */
6627 public int getFlags() {
6628 return mFlags;
6629 }
6630
Dianne Hackborne7f97212011-02-24 14:40:20 -08006631 /** @hide */
6632 public boolean isExcludingStopped() {
6633 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6634 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6635 }
6636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006637 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006638 * Retrieve the application package name this Intent is limited to. When
6639 * resolving an Intent, if non-null this limits the resolution to only
6640 * components in the given application package.
6641 *
6642 * @return The name of the application package for the Intent.
6643 *
6644 * @see #resolveActivity
6645 * @see #setPackage
6646 */
6647 public String getPackage() {
6648 return mPackage;
6649 }
6650
6651 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006652 * Retrieve the concrete component associated with the intent. When receiving
6653 * an intent, this is the component that was found to best handle it (that is,
6654 * yourself) and will always be non-null; in all other cases it will be
6655 * null unless explicitly set.
6656 *
6657 * @return The name of the application component to handle the intent.
6658 *
6659 * @see #resolveActivity
6660 * @see #setComponent
6661 */
6662 public ComponentName getComponent() {
6663 return mComponent;
6664 }
6665
6666 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006667 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6668 * used as a hint to the receiver for animations and the like. Null means that there
6669 * is no source bounds.
6670 */
6671 public Rect getSourceBounds() {
6672 return mSourceBounds;
6673 }
6674
6675 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006676 * Return the Activity component that should be used to handle this intent.
6677 * The appropriate component is determined based on the information in the
6678 * intent, evaluated as follows:
6679 *
6680 * <p>If {@link #getComponent} returns an explicit class, that is returned
6681 * without any further consideration.
6682 *
6683 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6684 * category to be considered.
6685 *
6686 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6687 * action.
6688 *
6689 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6690 * this type.
6691 *
6692 * <p>If {@link #addCategory} has added any categories, the activity must
6693 * handle ALL of the categories specified.
6694 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006695 * <p>If {@link #getPackage} is non-NULL, only activity components in
6696 * that application package will be considered.
6697 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006698 * <p>If there are no activities that satisfy all of these conditions, a
6699 * null string is returned.
6700 *
6701 * <p>If multiple activities are found to satisfy the intent, the one with
6702 * the highest priority will be used. If there are multiple activities
6703 * with the same priority, the system will either pick the best activity
6704 * based on user preference, or resolve to a system class that will allow
6705 * the user to pick an activity and forward from there.
6706 *
6707 * <p>This method is implemented simply by calling
6708 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6709 * true.</p>
6710 * <p> This API is called for you as part of starting an activity from an
6711 * intent. You do not normally need to call it yourself.</p>
6712 *
6713 * @param pm The package manager with which to resolve the Intent.
6714 *
6715 * @return Name of the component implementing an activity that can
6716 * display the intent.
6717 *
6718 * @see #setComponent
6719 * @see #getComponent
6720 * @see #resolveActivityInfo
6721 */
6722 public ComponentName resolveActivity(PackageManager pm) {
6723 if (mComponent != null) {
6724 return mComponent;
6725 }
6726
6727 ResolveInfo info = pm.resolveActivity(
6728 this, PackageManager.MATCH_DEFAULT_ONLY);
6729 if (info != null) {
6730 return new ComponentName(
6731 info.activityInfo.applicationInfo.packageName,
6732 info.activityInfo.name);
6733 }
6734
6735 return null;
6736 }
6737
6738 /**
6739 * Resolve the Intent into an {@link ActivityInfo}
6740 * describing the activity that should execute the intent. Resolution
6741 * follows the same rules as described for {@link #resolveActivity}, but
6742 * you get back the completely information about the resolved activity
6743 * instead of just its class name.
6744 *
6745 * @param pm The package manager with which to resolve the Intent.
6746 * @param flags Addition information to retrieve as per
6747 * {@link PackageManager#getActivityInfo(ComponentName, int)
6748 * PackageManager.getActivityInfo()}.
6749 *
6750 * @return PackageManager.ActivityInfo
6751 *
6752 * @see #resolveActivity
6753 */
6754 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6755 ActivityInfo ai = null;
6756 if (mComponent != null) {
6757 try {
6758 ai = pm.getActivityInfo(mComponent, flags);
6759 } catch (PackageManager.NameNotFoundException e) {
6760 // ignore
6761 }
6762 } else {
6763 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006764 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006765 if (info != null) {
6766 ai = info.activityInfo;
6767 }
6768 }
6769
6770 return ai;
6771 }
6772
6773 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006774 * Special function for use by the system to resolve service
6775 * intents to system apps. Throws an exception if there are
6776 * multiple potential matches to the Intent. Returns null if
6777 * there are no matches.
6778 * @hide
6779 */
6780 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6781 if (mComponent != null) {
6782 return mComponent;
6783 }
6784
6785 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6786 if (results == null) {
6787 return null;
6788 }
6789 ComponentName comp = null;
6790 for (int i=0; i<results.size(); i++) {
6791 ResolveInfo ri = results.get(i);
6792 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6793 continue;
6794 }
6795 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6796 ri.serviceInfo.name);
6797 if (comp != null) {
6798 throw new IllegalStateException("Multiple system services handle " + this
6799 + ": " + comp + ", " + foundComp);
6800 }
6801 comp = foundComp;
6802 }
6803 return comp;
6804 }
6805
6806 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006807 * Set the general action to be performed.
6808 *
6809 * @param action An action name, such as ACTION_VIEW. Application-specific
6810 * actions should be prefixed with the vendor's package name.
6811 *
6812 * @return Returns the same Intent object, for chaining multiple calls
6813 * into a single statement.
6814 *
6815 * @see #getAction
6816 */
6817 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006818 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006819 return this;
6820 }
6821
6822 /**
6823 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006824 * clears any type that was previously set by {@link #setType} or
6825 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006826 *
Nick Pellyccae4122012-01-09 14:12:58 -08006827 * <p><em>Note: scheme matching in the Android framework is
6828 * case-sensitive, unlike the formal RFC. As a result,
6829 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006830 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006831 * {@link #setDataAndNormalize}
6832 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006833 *
Nick Pellyccae4122012-01-09 14:12:58 -08006834 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006835 *
6836 * @return Returns the same Intent object, for chaining multiple calls
6837 * into a single statement.
6838 *
6839 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006840 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006841 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006842 */
6843 public Intent setData(Uri data) {
6844 mData = data;
6845 mType = null;
6846 return this;
6847 }
6848
6849 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006850 * Normalize and set the data this intent is operating on.
6851 *
6852 * <p>This method automatically clears any type that was
6853 * previously set (for example, by {@link #setType}).
6854 *
6855 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006856 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006857 * so really this is just a convenience method for
6858 * <pre>
6859 * setData(data.normalize())
6860 * </pre>
6861 *
6862 * @param data The Uri of the data this intent is now targeting.
6863 *
6864 * @return Returns the same Intent object, for chaining multiple calls
6865 * into a single statement.
6866 *
6867 * @see #getData
6868 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006869 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006870 */
6871 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006872 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006873 }
6874
6875 /**
6876 * Set an explicit MIME data type.
6877 *
6878 * <p>This is used to create intents that only specify a type and not data,
6879 * for example to indicate the type of data to return.
6880 *
6881 * <p>This method automatically clears any data that was
6882 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006883 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006884 * <p><em>Note: MIME type matching in the Android framework is
6885 * case-sensitive, unlike formal RFC MIME types. As a result,
6886 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006887 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6888 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889 *
6890 * @param type The MIME type of the data being handled by this intent.
6891 *
6892 * @return Returns the same Intent object, for chaining multiple calls
6893 * into a single statement.
6894 *
6895 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006896 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006897 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006898 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006899 */
6900 public Intent setType(String type) {
6901 mData = null;
6902 mType = type;
6903 return this;
6904 }
6905
6906 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006907 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006908 *
Nick Pellyccae4122012-01-09 14:12:58 -08006909 * <p>This is used to create intents that only specify a type and not data,
6910 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006911 *
Nick Pellyccae4122012-01-09 14:12:58 -08006912 * <p>This method automatically clears any data that was
6913 * previously set (for example by {@link #setData}).
6914 *
6915 * <p>The MIME type is normalized using
6916 * {@link #normalizeMimeType} before it is set,
6917 * so really this is just a convenience method for
6918 * <pre>
6919 * setType(Intent.normalizeMimeType(type))
6920 * </pre>
6921 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006922 * @param type The MIME type of the data being handled by this intent.
6923 *
6924 * @return Returns the same Intent object, for chaining multiple calls
6925 * into a single statement.
6926 *
Nick Pellyccae4122012-01-09 14:12:58 -08006927 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006928 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006929 * @see #normalizeMimeType
6930 */
6931 public Intent setTypeAndNormalize(String type) {
6932 return setType(normalizeMimeType(type));
6933 }
6934
6935 /**
6936 * (Usually optional) Set the data for the intent along with an explicit
6937 * MIME data type. This method should very rarely be used -- it allows you
6938 * to override the MIME type that would ordinarily be inferred from the
6939 * data with your own type given here.
6940 *
6941 * <p><em>Note: MIME type and Uri scheme matching in the
6942 * Android framework is case-sensitive, unlike the formal RFC definitions.
6943 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006944 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006945 * {@link #setDataAndTypeAndNormalize}
6946 * to ensure that they are converted to lower case.</em>
6947 *
6948 * @param data The Uri of the data this intent is now targeting.
6949 * @param type The MIME type of the data being handled by this intent.
6950 *
6951 * @return Returns the same Intent object, for chaining multiple calls
6952 * into a single statement.
6953 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006954 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006955 * @see #setData
6956 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006957 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006958 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006959 */
6960 public Intent setDataAndType(Uri data, String type) {
6961 mData = data;
6962 mType = type;
6963 return this;
6964 }
6965
6966 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006967 * (Usually optional) Normalize and set both the data Uri and an explicit
6968 * MIME data type. This method should very rarely be used -- it allows you
6969 * to override the MIME type that would ordinarily be inferred from the
6970 * data with your own type given here.
6971 *
6972 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006973 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006974 * before they are set, so really this is just a convenience method for
6975 * <pre>
6976 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6977 * </pre>
6978 *
6979 * @param data The Uri of the data this intent is now targeting.
6980 * @param type The MIME type of the data being handled by this intent.
6981 *
6982 * @return Returns the same Intent object, for chaining multiple calls
6983 * into a single statement.
6984 *
6985 * @see #setType
6986 * @see #setData
6987 * @see #setDataAndType
6988 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006989 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006990 */
6991 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006992 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006993 }
6994
6995 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006996 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006997 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006998 * activities that provide <em>all</em> of the requested categories will be
6999 * used.
7000 *
7001 * @param category The desired category. This can be either one of the
7002 * predefined Intent categories, or a custom category in your own
7003 * namespace.
7004 *
7005 * @return Returns the same Intent object, for chaining multiple calls
7006 * into a single statement.
7007 *
7008 * @see #hasCategory
7009 * @see #removeCategory
7010 */
7011 public Intent addCategory(String category) {
7012 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007013 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007014 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007015 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007016 return this;
7017 }
7018
7019 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007020 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007021 *
7022 * @param category The category to remove.
7023 *
7024 * @see #addCategory
7025 */
7026 public void removeCategory(String category) {
7027 if (mCategories != null) {
7028 mCategories.remove(category);
7029 if (mCategories.size() == 0) {
7030 mCategories = null;
7031 }
7032 }
7033 }
7034
7035 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007036 * Set a selector for this Intent. This is a modification to the kinds of
7037 * things the Intent will match. If the selector is set, it will be used
7038 * when trying to find entities that can handle the Intent, instead of the
7039 * main contents of the Intent. This allows you build an Intent containing
7040 * a generic protocol while targeting it more specifically.
7041 *
7042 * <p>An example of where this may be used is with things like
7043 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7044 * Intent that will launch the Browser application. However, the correct
7045 * main entry point of an application is actually {@link #ACTION_MAIN}
7046 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7047 * used to specify the actual Activity to launch. If you launch the browser
7048 * with something different, undesired behavior may happen if the user has
7049 * previously or later launches it the normal way, since they do not match.
7050 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7051 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7052 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7053 *
7054 * <p>Setting a selector does not impact the behavior of
7055 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7056 * desired behavior of a selector -- it does not impact the base meaning
7057 * of the Intent, just what kinds of things will be matched against it
7058 * when determining who can handle it.</p>
7059 *
7060 * <p>You can not use both a selector and {@link #setPackage(String)} on
7061 * the same base Intent.</p>
7062 *
7063 * @param selector The desired selector Intent; set to null to not use
7064 * a special selector.
7065 */
7066 public void setSelector(Intent selector) {
7067 if (selector == this) {
7068 throw new IllegalArgumentException(
7069 "Intent being set as a selector of itself");
7070 }
7071 if (selector != null && mPackage != null) {
7072 throw new IllegalArgumentException(
7073 "Can't set selector when package name is already set");
7074 }
7075 mSelector = selector;
7076 }
7077
7078 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007079 * Set a {@link ClipData} associated with this Intent. This replaces any
7080 * previously set ClipData.
7081 *
7082 * <p>The ClipData in an intent is not used for Intent matching or other
7083 * such operations. Semantically it is like extras, used to transmit
7084 * additional data with the Intent. The main feature of using this over
7085 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7086 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7087 * items included in the clip data. This is useful, in particular, if
7088 * you want to transmit an Intent containing multiple <code>content:</code>
7089 * URIs for which the recipient may not have global permission to access the
7090 * content provider.
7091 *
7092 * <p>If the ClipData contains items that are themselves Intents, any
7093 * grant flags in those Intents will be ignored. Only the top-level flags
7094 * of the main Intent are respected, and will be applied to all Uri or
7095 * Intent items in the clip (or sub-items of the clip).
7096 *
7097 * <p>The MIME type, label, and icon in the ClipData object are not
7098 * directly used by Intent. Applications should generally rely on the
7099 * MIME type of the Intent itself, not what it may find in the ClipData.
7100 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007101 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007102 *
7103 * @param clip The new clip to set. May be null to clear the current clip.
7104 */
7105 public void setClipData(ClipData clip) {
7106 mClipData = clip;
7107 }
7108
7109 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007110 * This is NOT a secure mechanism to identify the user who sent the intent.
7111 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7112 * who sent the intent.
7113 * @hide
7114 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007115 public void prepareToLeaveUser(int userId) {
7116 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7117 // We want mContentUserHint to refer to the original user, so don't do anything.
7118 if (mContentUserHint == UserHandle.USER_CURRENT) {
7119 mContentUserHint = userId;
7120 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007121 }
7122
7123 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007124 * Add extended data to the intent. The name must include a package
7125 * prefix, for example the app com.android.contacts would use names
7126 * like "com.android.contacts.ShowAll".
7127 *
7128 * @param name The name of the extra data, with package prefix.
7129 * @param value The boolean data value.
7130 *
7131 * @return Returns the same Intent object, for chaining multiple calls
7132 * into a single statement.
7133 *
7134 * @see #putExtras
7135 * @see #removeExtra
7136 * @see #getBooleanExtra(String, boolean)
7137 */
7138 public Intent putExtra(String name, boolean value) {
7139 if (mExtras == null) {
7140 mExtras = new Bundle();
7141 }
7142 mExtras.putBoolean(name, value);
7143 return this;
7144 }
7145
7146 /**
7147 * Add extended data to the intent. The name must include a package
7148 * prefix, for example the app com.android.contacts would use names
7149 * like "com.android.contacts.ShowAll".
7150 *
7151 * @param name The name of the extra data, with package prefix.
7152 * @param value The byte data value.
7153 *
7154 * @return Returns the same Intent object, for chaining multiple calls
7155 * into a single statement.
7156 *
7157 * @see #putExtras
7158 * @see #removeExtra
7159 * @see #getByteExtra(String, byte)
7160 */
7161 public Intent putExtra(String name, byte value) {
7162 if (mExtras == null) {
7163 mExtras = new Bundle();
7164 }
7165 mExtras.putByte(name, value);
7166 return this;
7167 }
7168
7169 /**
7170 * Add extended data to the intent. The name must include a package
7171 * prefix, for example the app com.android.contacts would use names
7172 * like "com.android.contacts.ShowAll".
7173 *
7174 * @param name The name of the extra data, with package prefix.
7175 * @param value The char data value.
7176 *
7177 * @return Returns the same Intent object, for chaining multiple calls
7178 * into a single statement.
7179 *
7180 * @see #putExtras
7181 * @see #removeExtra
7182 * @see #getCharExtra(String, char)
7183 */
7184 public Intent putExtra(String name, char value) {
7185 if (mExtras == null) {
7186 mExtras = new Bundle();
7187 }
7188 mExtras.putChar(name, value);
7189 return this;
7190 }
7191
7192 /**
7193 * Add extended data to the intent. The name must include a package
7194 * prefix, for example the app com.android.contacts would use names
7195 * like "com.android.contacts.ShowAll".
7196 *
7197 * @param name The name of the extra data, with package prefix.
7198 * @param value The short data value.
7199 *
7200 * @return Returns the same Intent object, for chaining multiple calls
7201 * into a single statement.
7202 *
7203 * @see #putExtras
7204 * @see #removeExtra
7205 * @see #getShortExtra(String, short)
7206 */
7207 public Intent putExtra(String name, short value) {
7208 if (mExtras == null) {
7209 mExtras = new Bundle();
7210 }
7211 mExtras.putShort(name, value);
7212 return this;
7213 }
7214
7215 /**
7216 * Add extended data to the intent. The name must include a package
7217 * prefix, for example the app com.android.contacts would use names
7218 * like "com.android.contacts.ShowAll".
7219 *
7220 * @param name The name of the extra data, with package prefix.
7221 * @param value The integer data value.
7222 *
7223 * @return Returns the same Intent object, for chaining multiple calls
7224 * into a single statement.
7225 *
7226 * @see #putExtras
7227 * @see #removeExtra
7228 * @see #getIntExtra(String, int)
7229 */
7230 public Intent putExtra(String name, int value) {
7231 if (mExtras == null) {
7232 mExtras = new Bundle();
7233 }
7234 mExtras.putInt(name, value);
7235 return this;
7236 }
7237
7238 /**
7239 * Add extended data to the intent. The name must include a package
7240 * prefix, for example the app com.android.contacts would use names
7241 * like "com.android.contacts.ShowAll".
7242 *
7243 * @param name The name of the extra data, with package prefix.
7244 * @param value The long data value.
7245 *
7246 * @return Returns the same Intent object, for chaining multiple calls
7247 * into a single statement.
7248 *
7249 * @see #putExtras
7250 * @see #removeExtra
7251 * @see #getLongExtra(String, long)
7252 */
7253 public Intent putExtra(String name, long value) {
7254 if (mExtras == null) {
7255 mExtras = new Bundle();
7256 }
7257 mExtras.putLong(name, value);
7258 return this;
7259 }
7260
7261 /**
7262 * Add extended data to the intent. The name must include a package
7263 * prefix, for example the app com.android.contacts would use names
7264 * like "com.android.contacts.ShowAll".
7265 *
7266 * @param name The name of the extra data, with package prefix.
7267 * @param value The float data value.
7268 *
7269 * @return Returns the same Intent object, for chaining multiple calls
7270 * into a single statement.
7271 *
7272 * @see #putExtras
7273 * @see #removeExtra
7274 * @see #getFloatExtra(String, float)
7275 */
7276 public Intent putExtra(String name, float value) {
7277 if (mExtras == null) {
7278 mExtras = new Bundle();
7279 }
7280 mExtras.putFloat(name, value);
7281 return this;
7282 }
7283
7284 /**
7285 * Add extended data to the intent. The name must include a package
7286 * prefix, for example the app com.android.contacts would use names
7287 * like "com.android.contacts.ShowAll".
7288 *
7289 * @param name The name of the extra data, with package prefix.
7290 * @param value The double data value.
7291 *
7292 * @return Returns the same Intent object, for chaining multiple calls
7293 * into a single statement.
7294 *
7295 * @see #putExtras
7296 * @see #removeExtra
7297 * @see #getDoubleExtra(String, double)
7298 */
7299 public Intent putExtra(String name, double value) {
7300 if (mExtras == null) {
7301 mExtras = new Bundle();
7302 }
7303 mExtras.putDouble(name, value);
7304 return this;
7305 }
7306
7307 /**
7308 * Add extended data to the intent. The name must include a package
7309 * prefix, for example the app com.android.contacts would use names
7310 * like "com.android.contacts.ShowAll".
7311 *
7312 * @param name The name of the extra data, with package prefix.
7313 * @param value The String data value.
7314 *
7315 * @return Returns the same Intent object, for chaining multiple calls
7316 * into a single statement.
7317 *
7318 * @see #putExtras
7319 * @see #removeExtra
7320 * @see #getStringExtra(String)
7321 */
7322 public Intent putExtra(String name, String value) {
7323 if (mExtras == null) {
7324 mExtras = new Bundle();
7325 }
7326 mExtras.putString(name, value);
7327 return this;
7328 }
7329
7330 /**
7331 * Add extended data to the intent. The name must include a package
7332 * prefix, for example the app com.android.contacts would use names
7333 * like "com.android.contacts.ShowAll".
7334 *
7335 * @param name The name of the extra data, with package prefix.
7336 * @param value The CharSequence data value.
7337 *
7338 * @return Returns the same Intent object, for chaining multiple calls
7339 * into a single statement.
7340 *
7341 * @see #putExtras
7342 * @see #removeExtra
7343 * @see #getCharSequenceExtra(String)
7344 */
7345 public Intent putExtra(String name, CharSequence value) {
7346 if (mExtras == null) {
7347 mExtras = new Bundle();
7348 }
7349 mExtras.putCharSequence(name, value);
7350 return this;
7351 }
7352
7353 /**
7354 * Add extended data to the intent. The name must include a package
7355 * prefix, for example the app com.android.contacts would use names
7356 * like "com.android.contacts.ShowAll".
7357 *
7358 * @param name The name of the extra data, with package prefix.
7359 * @param value The Parcelable data value.
7360 *
7361 * @return Returns the same Intent object, for chaining multiple calls
7362 * into a single statement.
7363 *
7364 * @see #putExtras
7365 * @see #removeExtra
7366 * @see #getParcelableExtra(String)
7367 */
7368 public Intent putExtra(String name, Parcelable value) {
7369 if (mExtras == null) {
7370 mExtras = new Bundle();
7371 }
7372 mExtras.putParcelable(name, value);
7373 return this;
7374 }
7375
7376 /**
7377 * Add extended data to the intent. The name must include a package
7378 * prefix, for example the app com.android.contacts would use names
7379 * like "com.android.contacts.ShowAll".
7380 *
7381 * @param name The name of the extra data, with package prefix.
7382 * @param value The Parcelable[] data value.
7383 *
7384 * @return Returns the same Intent object, for chaining multiple calls
7385 * into a single statement.
7386 *
7387 * @see #putExtras
7388 * @see #removeExtra
7389 * @see #getParcelableArrayExtra(String)
7390 */
7391 public Intent putExtra(String name, Parcelable[] value) {
7392 if (mExtras == null) {
7393 mExtras = new Bundle();
7394 }
7395 mExtras.putParcelableArray(name, value);
7396 return this;
7397 }
7398
7399 /**
7400 * Add extended data to the intent. The name must include a package
7401 * prefix, for example the app com.android.contacts would use names
7402 * like "com.android.contacts.ShowAll".
7403 *
7404 * @param name The name of the extra data, with package prefix.
7405 * @param value The ArrayList<Parcelable> data value.
7406 *
7407 * @return Returns the same Intent object, for chaining multiple calls
7408 * into a single statement.
7409 *
7410 * @see #putExtras
7411 * @see #removeExtra
7412 * @see #getParcelableArrayListExtra(String)
7413 */
7414 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7415 if (mExtras == null) {
7416 mExtras = new Bundle();
7417 }
7418 mExtras.putParcelableArrayList(name, value);
7419 return this;
7420 }
7421
7422 /**
7423 * Add extended data to the intent. The name must include a package
7424 * prefix, for example the app com.android.contacts would use names
7425 * like "com.android.contacts.ShowAll".
7426 *
7427 * @param name The name of the extra data, with package prefix.
7428 * @param value The ArrayList<Integer> data value.
7429 *
7430 * @return Returns the same Intent object, for chaining multiple calls
7431 * into a single statement.
7432 *
7433 * @see #putExtras
7434 * @see #removeExtra
7435 * @see #getIntegerArrayListExtra(String)
7436 */
7437 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7438 if (mExtras == null) {
7439 mExtras = new Bundle();
7440 }
7441 mExtras.putIntegerArrayList(name, value);
7442 return this;
7443 }
7444
7445 /**
7446 * Add extended data to the intent. The name must include a package
7447 * prefix, for example the app com.android.contacts would use names
7448 * like "com.android.contacts.ShowAll".
7449 *
7450 * @param name The name of the extra data, with package prefix.
7451 * @param value The ArrayList<String> data value.
7452 *
7453 * @return Returns the same Intent object, for chaining multiple calls
7454 * into a single statement.
7455 *
7456 * @see #putExtras
7457 * @see #removeExtra
7458 * @see #getStringArrayListExtra(String)
7459 */
7460 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7461 if (mExtras == null) {
7462 mExtras = new Bundle();
7463 }
7464 mExtras.putStringArrayList(name, value);
7465 return this;
7466 }
7467
7468 /**
7469 * Add extended data to the intent. The name must include a package
7470 * prefix, for example the app com.android.contacts would use names
7471 * like "com.android.contacts.ShowAll".
7472 *
7473 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007474 * @param value The ArrayList<CharSequence> data value.
7475 *
7476 * @return Returns the same Intent object, for chaining multiple calls
7477 * into a single statement.
7478 *
7479 * @see #putExtras
7480 * @see #removeExtra
7481 * @see #getCharSequenceArrayListExtra(String)
7482 */
7483 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7484 if (mExtras == null) {
7485 mExtras = new Bundle();
7486 }
7487 mExtras.putCharSequenceArrayList(name, value);
7488 return this;
7489 }
7490
7491 /**
7492 * Add extended data to the intent. The name must include a package
7493 * prefix, for example the app com.android.contacts would use names
7494 * like "com.android.contacts.ShowAll".
7495 *
7496 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007497 * @param value The Serializable data value.
7498 *
7499 * @return Returns the same Intent object, for chaining multiple calls
7500 * into a single statement.
7501 *
7502 * @see #putExtras
7503 * @see #removeExtra
7504 * @see #getSerializableExtra(String)
7505 */
7506 public Intent putExtra(String name, Serializable value) {
7507 if (mExtras == null) {
7508 mExtras = new Bundle();
7509 }
7510 mExtras.putSerializable(name, value);
7511 return this;
7512 }
7513
7514 /**
7515 * Add extended data to the intent. The name must include a package
7516 * prefix, for example the app com.android.contacts would use names
7517 * like "com.android.contacts.ShowAll".
7518 *
7519 * @param name The name of the extra data, with package prefix.
7520 * @param value The boolean array data value.
7521 *
7522 * @return Returns the same Intent object, for chaining multiple calls
7523 * into a single statement.
7524 *
7525 * @see #putExtras
7526 * @see #removeExtra
7527 * @see #getBooleanArrayExtra(String)
7528 */
7529 public Intent putExtra(String name, boolean[] value) {
7530 if (mExtras == null) {
7531 mExtras = new Bundle();
7532 }
7533 mExtras.putBooleanArray(name, value);
7534 return this;
7535 }
7536
7537 /**
7538 * Add extended data to the intent. The name must include a package
7539 * prefix, for example the app com.android.contacts would use names
7540 * like "com.android.contacts.ShowAll".
7541 *
7542 * @param name The name of the extra data, with package prefix.
7543 * @param value The byte array data value.
7544 *
7545 * @return Returns the same Intent object, for chaining multiple calls
7546 * into a single statement.
7547 *
7548 * @see #putExtras
7549 * @see #removeExtra
7550 * @see #getByteArrayExtra(String)
7551 */
7552 public Intent putExtra(String name, byte[] value) {
7553 if (mExtras == null) {
7554 mExtras = new Bundle();
7555 }
7556 mExtras.putByteArray(name, value);
7557 return this;
7558 }
7559
7560 /**
7561 * Add extended data to the intent. The name must include a package
7562 * prefix, for example the app com.android.contacts would use names
7563 * like "com.android.contacts.ShowAll".
7564 *
7565 * @param name The name of the extra data, with package prefix.
7566 * @param value The short array data value.
7567 *
7568 * @return Returns the same Intent object, for chaining multiple calls
7569 * into a single statement.
7570 *
7571 * @see #putExtras
7572 * @see #removeExtra
7573 * @see #getShortArrayExtra(String)
7574 */
7575 public Intent putExtra(String name, short[] value) {
7576 if (mExtras == null) {
7577 mExtras = new Bundle();
7578 }
7579 mExtras.putShortArray(name, value);
7580 return this;
7581 }
7582
7583 /**
7584 * Add extended data to the intent. The name must include a package
7585 * prefix, for example the app com.android.contacts would use names
7586 * like "com.android.contacts.ShowAll".
7587 *
7588 * @param name The name of the extra data, with package prefix.
7589 * @param value The char array data value.
7590 *
7591 * @return Returns the same Intent object, for chaining multiple calls
7592 * into a single statement.
7593 *
7594 * @see #putExtras
7595 * @see #removeExtra
7596 * @see #getCharArrayExtra(String)
7597 */
7598 public Intent putExtra(String name, char[] value) {
7599 if (mExtras == null) {
7600 mExtras = new Bundle();
7601 }
7602 mExtras.putCharArray(name, value);
7603 return this;
7604 }
7605
7606 /**
7607 * Add extended data to the intent. The name must include a package
7608 * prefix, for example the app com.android.contacts would use names
7609 * like "com.android.contacts.ShowAll".
7610 *
7611 * @param name The name of the extra data, with package prefix.
7612 * @param value The int array data value.
7613 *
7614 * @return Returns the same Intent object, for chaining multiple calls
7615 * into a single statement.
7616 *
7617 * @see #putExtras
7618 * @see #removeExtra
7619 * @see #getIntArrayExtra(String)
7620 */
7621 public Intent putExtra(String name, int[] value) {
7622 if (mExtras == null) {
7623 mExtras = new Bundle();
7624 }
7625 mExtras.putIntArray(name, value);
7626 return this;
7627 }
7628
7629 /**
7630 * Add extended data to the intent. The name must include a package
7631 * prefix, for example the app com.android.contacts would use names
7632 * like "com.android.contacts.ShowAll".
7633 *
7634 * @param name The name of the extra data, with package prefix.
7635 * @param value The byte array data value.
7636 *
7637 * @return Returns the same Intent object, for chaining multiple calls
7638 * into a single statement.
7639 *
7640 * @see #putExtras
7641 * @see #removeExtra
7642 * @see #getLongArrayExtra(String)
7643 */
7644 public Intent putExtra(String name, long[] value) {
7645 if (mExtras == null) {
7646 mExtras = new Bundle();
7647 }
7648 mExtras.putLongArray(name, value);
7649 return this;
7650 }
7651
7652 /**
7653 * Add extended data to the intent. The name must include a package
7654 * prefix, for example the app com.android.contacts would use names
7655 * like "com.android.contacts.ShowAll".
7656 *
7657 * @param name The name of the extra data, with package prefix.
7658 * @param value The float array data value.
7659 *
7660 * @return Returns the same Intent object, for chaining multiple calls
7661 * into a single statement.
7662 *
7663 * @see #putExtras
7664 * @see #removeExtra
7665 * @see #getFloatArrayExtra(String)
7666 */
7667 public Intent putExtra(String name, float[] value) {
7668 if (mExtras == null) {
7669 mExtras = new Bundle();
7670 }
7671 mExtras.putFloatArray(name, value);
7672 return this;
7673 }
7674
7675 /**
7676 * Add extended data to the intent. The name must include a package
7677 * prefix, for example the app com.android.contacts would use names
7678 * like "com.android.contacts.ShowAll".
7679 *
7680 * @param name The name of the extra data, with package prefix.
7681 * @param value The double array data value.
7682 *
7683 * @return Returns the same Intent object, for chaining multiple calls
7684 * into a single statement.
7685 *
7686 * @see #putExtras
7687 * @see #removeExtra
7688 * @see #getDoubleArrayExtra(String)
7689 */
7690 public Intent putExtra(String name, double[] value) {
7691 if (mExtras == null) {
7692 mExtras = new Bundle();
7693 }
7694 mExtras.putDoubleArray(name, value);
7695 return this;
7696 }
7697
7698 /**
7699 * Add extended data to the intent. The name must include a package
7700 * prefix, for example the app com.android.contacts would use names
7701 * like "com.android.contacts.ShowAll".
7702 *
7703 * @param name The name of the extra data, with package prefix.
7704 * @param value The String array data value.
7705 *
7706 * @return Returns the same Intent object, for chaining multiple calls
7707 * into a single statement.
7708 *
7709 * @see #putExtras
7710 * @see #removeExtra
7711 * @see #getStringArrayExtra(String)
7712 */
7713 public Intent putExtra(String name, String[] value) {
7714 if (mExtras == null) {
7715 mExtras = new Bundle();
7716 }
7717 mExtras.putStringArray(name, value);
7718 return this;
7719 }
7720
7721 /**
7722 * Add extended data to the intent. The name must include a package
7723 * prefix, for example the app com.android.contacts would use names
7724 * like "com.android.contacts.ShowAll".
7725 *
7726 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007727 * @param value The CharSequence array data value.
7728 *
7729 * @return Returns the same Intent object, for chaining multiple calls
7730 * into a single statement.
7731 *
7732 * @see #putExtras
7733 * @see #removeExtra
7734 * @see #getCharSequenceArrayExtra(String)
7735 */
7736 public Intent putExtra(String name, CharSequence[] value) {
7737 if (mExtras == null) {
7738 mExtras = new Bundle();
7739 }
7740 mExtras.putCharSequenceArray(name, value);
7741 return this;
7742 }
7743
7744 /**
7745 * Add extended data to the intent. The name must include a package
7746 * prefix, for example the app com.android.contacts would use names
7747 * like "com.android.contacts.ShowAll".
7748 *
7749 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007750 * @param value The Bundle data value.
7751 *
7752 * @return Returns the same Intent object, for chaining multiple calls
7753 * into a single statement.
7754 *
7755 * @see #putExtras
7756 * @see #removeExtra
7757 * @see #getBundleExtra(String)
7758 */
7759 public Intent putExtra(String name, Bundle value) {
7760 if (mExtras == null) {
7761 mExtras = new Bundle();
7762 }
7763 mExtras.putBundle(name, value);
7764 return this;
7765 }
7766
7767 /**
7768 * Add extended data to the intent. The name must include a package
7769 * prefix, for example the app com.android.contacts would use names
7770 * like "com.android.contacts.ShowAll".
7771 *
7772 * @param name The name of the extra data, with package prefix.
7773 * @param value The IBinder data value.
7774 *
7775 * @return Returns the same Intent object, for chaining multiple calls
7776 * into a single statement.
7777 *
7778 * @see #putExtras
7779 * @see #removeExtra
7780 * @see #getIBinderExtra(String)
7781 *
7782 * @deprecated
7783 * @hide
7784 */
7785 @Deprecated
7786 public Intent putExtra(String name, IBinder value) {
7787 if (mExtras == null) {
7788 mExtras = new Bundle();
7789 }
7790 mExtras.putIBinder(name, value);
7791 return this;
7792 }
7793
7794 /**
7795 * Copy all extras in 'src' in to this intent.
7796 *
7797 * @param src Contains the extras to copy.
7798 *
7799 * @see #putExtra
7800 */
7801 public Intent putExtras(Intent src) {
7802 if (src.mExtras != null) {
7803 if (mExtras == null) {
7804 mExtras = new Bundle(src.mExtras);
7805 } else {
7806 mExtras.putAll(src.mExtras);
7807 }
7808 }
7809 return this;
7810 }
7811
7812 /**
7813 * Add a set of extended data to the intent. The keys must include a package
7814 * prefix, for example the app com.android.contacts would use names
7815 * like "com.android.contacts.ShowAll".
7816 *
7817 * @param extras The Bundle of extras to add to this intent.
7818 *
7819 * @see #putExtra
7820 * @see #removeExtra
7821 */
7822 public Intent putExtras(Bundle extras) {
7823 if (mExtras == null) {
7824 mExtras = new Bundle();
7825 }
7826 mExtras.putAll(extras);
7827 return this;
7828 }
7829
7830 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007831 * Completely replace the extras in the Intent with the extras in the
7832 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007833 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007834 * @param src The exact extras contained in this Intent are copied
7835 * into the target intent, replacing any that were previously there.
7836 */
7837 public Intent replaceExtras(Intent src) {
7838 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7839 return this;
7840 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007841
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007842 /**
7843 * Completely replace the extras in the Intent with the given Bundle of
7844 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007845 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007846 * @param extras The new set of extras in the Intent, or null to erase
7847 * all extras.
7848 */
7849 public Intent replaceExtras(Bundle extras) {
7850 mExtras = extras != null ? new Bundle(extras) : null;
7851 return this;
7852 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007853
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007854 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007855 * Remove extended data from the intent.
7856 *
7857 * @see #putExtra
7858 */
7859 public void removeExtra(String name) {
7860 if (mExtras != null) {
7861 mExtras.remove(name);
7862 if (mExtras.size() == 0) {
7863 mExtras = null;
7864 }
7865 }
7866 }
7867
7868 /**
7869 * Set special flags controlling how this intent is handled. Most values
7870 * here depend on the type of component being executed by the Intent,
7871 * specifically the FLAG_ACTIVITY_* flags are all for use with
7872 * {@link Context#startActivity Context.startActivity()} and the
7873 * FLAG_RECEIVER_* flags are all for use with
7874 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7875 *
Scott Main7aee61f2011-02-08 11:25:01 -08007876 * <p>See the
7877 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7878 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007879 * the behavior of your application.
7880 *
7881 * @param flags The desired flags.
7882 *
7883 * @return Returns the same Intent object, for chaining multiple calls
7884 * into a single statement.
7885 *
7886 * @see #getFlags
7887 * @see #addFlags
7888 *
7889 * @see #FLAG_GRANT_READ_URI_PERMISSION
7890 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007891 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7892 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007893 * @see #FLAG_DEBUG_LOG_RESOLUTION
7894 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007895 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007896 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007897 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007898 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007899 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7900 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007901 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007902 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007903 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007904 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007905 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007906 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007907 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007908 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7909 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007910 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007911 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007912 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007913 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7914 */
7915 public Intent setFlags(int flags) {
7916 mFlags = flags;
7917 return this;
7918 }
7919
7920 /**
7921 * Add additional flags to the intent (or with existing flags
7922 * value).
7923 *
7924 * @param flags The new flags to set.
7925 *
7926 * @return Returns the same Intent object, for chaining multiple calls
7927 * into a single statement.
7928 *
7929 * @see #setFlags
7930 */
7931 public Intent addFlags(int flags) {
7932 mFlags |= flags;
7933 return this;
7934 }
7935
7936 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007937 * (Usually optional) Set an explicit application package name that limits
7938 * the components this Intent will resolve to. If left to the default
7939 * value of null, all components in all applications will considered.
7940 * If non-null, the Intent can only match the components in the given
7941 * application package.
7942 *
7943 * @param packageName The name of the application package to handle the
7944 * intent, or null to allow any application package.
7945 *
7946 * @return Returns the same Intent object, for chaining multiple calls
7947 * into a single statement.
7948 *
7949 * @see #getPackage
7950 * @see #resolveActivity
7951 */
7952 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007953 if (packageName != null && mSelector != null) {
7954 throw new IllegalArgumentException(
7955 "Can't set package name when selector is already set");
7956 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007957 mPackage = packageName;
7958 return this;
7959 }
7960
7961 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007962 * (Usually optional) Explicitly set the component to handle the intent.
7963 * If left with the default value of null, the system will determine the
7964 * appropriate class to use based on the other fields (action, data,
7965 * type, categories) in the Intent. If this class is defined, the
7966 * specified class will always be used regardless of the other fields. You
7967 * should only set this value when you know you absolutely want a specific
7968 * class to be used; otherwise it is better to let the system find the
7969 * appropriate class so that you will respect the installed applications
7970 * and user preferences.
7971 *
7972 * @param component The name of the application component to handle the
7973 * intent, or null to let the system find one for you.
7974 *
7975 * @return Returns the same Intent object, for chaining multiple calls
7976 * into a single statement.
7977 *
7978 * @see #setClass
7979 * @see #setClassName(Context, String)
7980 * @see #setClassName(String, String)
7981 * @see #getComponent
7982 * @see #resolveActivity
7983 */
7984 public Intent setComponent(ComponentName component) {
7985 mComponent = component;
7986 return this;
7987 }
7988
7989 /**
7990 * Convenience for calling {@link #setComponent} with an
7991 * explicit class name.
7992 *
7993 * @param packageContext A Context of the application package implementing
7994 * this class.
7995 * @param className The name of a class inside of the application package
7996 * that will be used as the component for this Intent.
7997 *
7998 * @return Returns the same Intent object, for chaining multiple calls
7999 * into a single statement.
8000 *
8001 * @see #setComponent
8002 * @see #setClass
8003 */
8004 public Intent setClassName(Context packageContext, String className) {
8005 mComponent = new ComponentName(packageContext, className);
8006 return this;
8007 }
8008
8009 /**
8010 * Convenience for calling {@link #setComponent} with an
8011 * explicit application package name and class name.
8012 *
8013 * @param packageName The name of the package implementing the desired
8014 * component.
8015 * @param className The name of a class inside of the application package
8016 * that will be used as the component for this Intent.
8017 *
8018 * @return Returns the same Intent object, for chaining multiple calls
8019 * into a single statement.
8020 *
8021 * @see #setComponent
8022 * @see #setClass
8023 */
8024 public Intent setClassName(String packageName, String className) {
8025 mComponent = new ComponentName(packageName, className);
8026 return this;
8027 }
8028
8029 /**
8030 * Convenience for calling {@link #setComponent(ComponentName)} with the
8031 * name returned by a {@link Class} object.
8032 *
8033 * @param packageContext A Context of the application package implementing
8034 * this class.
8035 * @param cls The class name to set, equivalent to
8036 * <code>setClassName(context, cls.getName())</code>.
8037 *
8038 * @return Returns the same Intent object, for chaining multiple calls
8039 * into a single statement.
8040 *
8041 * @see #setComponent
8042 */
8043 public Intent setClass(Context packageContext, Class<?> cls) {
8044 mComponent = new ComponentName(packageContext, cls);
8045 return this;
8046 }
8047
8048 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008049 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8050 * used as a hint to the receiver for animations and the like. Null means that there
8051 * is no source bounds.
8052 */
8053 public void setSourceBounds(Rect r) {
8054 if (r != null) {
8055 mSourceBounds = new Rect(r);
8056 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008057 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008058 }
8059 }
8060
Tor Norbyed9273d62013-05-30 15:59:53 -07008061 /** @hide */
8062 @IntDef(flag = true,
8063 value = {
8064 FILL_IN_ACTION,
8065 FILL_IN_DATA,
8066 FILL_IN_CATEGORIES,
8067 FILL_IN_COMPONENT,
8068 FILL_IN_PACKAGE,
8069 FILL_IN_SOURCE_BOUNDS,
8070 FILL_IN_SELECTOR,
8071 FILL_IN_CLIP_DATA
8072 })
8073 @Retention(RetentionPolicy.SOURCE)
8074 public @interface FillInFlags {}
8075
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008076 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008077 * Use with {@link #fillIn} to allow the current action value to be
8078 * overwritten, even if it is already set.
8079 */
8080 public static final int FILL_IN_ACTION = 1<<0;
8081
8082 /**
8083 * Use with {@link #fillIn} to allow the current data or type value
8084 * overwritten, even if it is already set.
8085 */
8086 public static final int FILL_IN_DATA = 1<<1;
8087
8088 /**
8089 * Use with {@link #fillIn} to allow the current categories to be
8090 * overwritten, even if they are already set.
8091 */
8092 public static final int FILL_IN_CATEGORIES = 1<<2;
8093
8094 /**
8095 * Use with {@link #fillIn} to allow the current component value to be
8096 * overwritten, even if it is already set.
8097 */
8098 public static final int FILL_IN_COMPONENT = 1<<3;
8099
8100 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008101 * Use with {@link #fillIn} to allow the current package value to be
8102 * overwritten, even if it is already set.
8103 */
8104 public static final int FILL_IN_PACKAGE = 1<<4;
8105
8106 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008107 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008108 * overwritten, even if it is already set.
8109 */
8110 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8111
8112 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008113 * Use with {@link #fillIn} to allow the current selector to be
8114 * overwritten, even if it is already set.
8115 */
8116 public static final int FILL_IN_SELECTOR = 1<<6;
8117
8118 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008119 * Use with {@link #fillIn} to allow the current ClipData to be
8120 * overwritten, even if it is already set.
8121 */
8122 public static final int FILL_IN_CLIP_DATA = 1<<7;
8123
8124 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008125 * Copy the contents of <var>other</var> in to this object, but only
8126 * where fields are not defined by this object. For purposes of a field
8127 * being defined, the following pieces of data in the Intent are
8128 * considered to be separate fields:
8129 *
8130 * <ul>
8131 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008132 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008133 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8134 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008135 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008136 * <li> component, as set by {@link #setComponent(ComponentName)} or
8137 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008138 * <li> source bounds, as set by {@link #setSourceBounds}.
8139 * <li> selector, as set by {@link #setSelector(Intent)}.
8140 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008141 * <li> each top-level name in the associated extras.
8142 * </ul>
8143 *
8144 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008145 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008146 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8147 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8148 * the restriction where the corresponding field will not be replaced if
8149 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008150 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008151 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8152 * is explicitly specified. The selector will only be copied if
8153 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008154 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008155 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8156 * and Intent B with {action="gotit", data-type="some/thing",
8157 * categories="one","two"}.
8158 *
8159 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8160 * containing: {action="gotit", data-type="some/thing",
8161 * categories="bar"}.
8162 *
8163 * @param other Another Intent whose values are to be used to fill in
8164 * the current one.
8165 * @param flags Options to control which fields can be filled in.
8166 *
8167 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008168 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008169 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8170 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8171 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008172 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008173 @FillInFlags
8174 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008175 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008176 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008177 if (other.mAction != null
8178 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008179 mAction = other.mAction;
8180 changes |= FILL_IN_ACTION;
8181 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008182 if ((other.mData != null || other.mType != null)
8183 && ((mData == null && mType == null)
8184 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008185 mData = other.mData;
8186 mType = other.mType;
8187 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008188 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008189 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008190 if (other.mCategories != null
8191 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008192 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008193 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008194 }
8195 changes |= FILL_IN_CATEGORIES;
8196 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008197 if (other.mPackage != null
8198 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008199 // Only do this if mSelector is not set.
8200 if (mSelector == null) {
8201 mPackage = other.mPackage;
8202 changes |= FILL_IN_PACKAGE;
8203 }
8204 }
8205 // Selector is special: it can only be set if explicitly allowed,
8206 // for the same reason as the component name.
8207 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8208 if (mPackage == null) {
8209 mSelector = new Intent(other.mSelector);
8210 mPackage = null;
8211 changes |= FILL_IN_SELECTOR;
8212 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008213 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008214 if (other.mClipData != null
8215 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8216 mClipData = other.mClipData;
8217 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008218 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008219 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008220 // Component is special: it can -only- be set if explicitly allowed,
8221 // since otherwise the sender could force the intent somewhere the
8222 // originator didn't intend.
8223 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008224 mComponent = other.mComponent;
8225 changes |= FILL_IN_COMPONENT;
8226 }
8227 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008228 if (other.mSourceBounds != null
8229 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8230 mSourceBounds = new Rect(other.mSourceBounds);
8231 changes |= FILL_IN_SOURCE_BOUNDS;
8232 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008233 if (mExtras == null) {
8234 if (other.mExtras != null) {
8235 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008236 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008237 }
8238 } else if (other.mExtras != null) {
8239 try {
8240 Bundle newb = new Bundle(other.mExtras);
8241 newb.putAll(mExtras);
8242 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008243 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008244 } catch (RuntimeException e) {
8245 // Modifying the extras can cause us to unparcel the contents
8246 // of the bundle, and if we do this in the system process that
8247 // may fail. We really should handle this (i.e., the Bundle
8248 // impl shouldn't be on top of a plain map), but for now just
8249 // ignore it and keep the original contents. :(
8250 Log.w("Intent", "Failure filling in extras", e);
8251 }
8252 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008253 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8254 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8255 mContentUserHint = other.mContentUserHint;
8256 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008257 return changes;
8258 }
8259
8260 /**
8261 * Wrapper class holding an Intent and implementing comparisons on it for
8262 * the purpose of filtering. The class implements its
8263 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8264 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8265 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8266 * on the wrapped Intent.
8267 */
8268 public static final class FilterComparison {
8269 private final Intent mIntent;
8270 private final int mHashCode;
8271
8272 public FilterComparison(Intent intent) {
8273 mIntent = intent;
8274 mHashCode = intent.filterHashCode();
8275 }
8276
8277 /**
8278 * Return the Intent that this FilterComparison represents.
8279 * @return Returns the Intent held by the FilterComparison. Do
8280 * not modify!
8281 */
8282 public Intent getIntent() {
8283 return mIntent;
8284 }
8285
8286 @Override
8287 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008288 if (obj instanceof FilterComparison) {
8289 Intent other = ((FilterComparison)obj).mIntent;
8290 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008291 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008292 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008293 }
8294
8295 @Override
8296 public int hashCode() {
8297 return mHashCode;
8298 }
8299 }
8300
8301 /**
8302 * Determine if two intents are the same for the purposes of intent
8303 * resolution (filtering). That is, if their action, data, type,
8304 * class, and categories are the same. This does <em>not</em> compare
8305 * any extra data included in the intents.
8306 *
8307 * @param other The other Intent to compare against.
8308 *
8309 * @return Returns true if action, data, type, class, and categories
8310 * are the same.
8311 */
8312 public boolean filterEquals(Intent other) {
8313 if (other == null) {
8314 return false;
8315 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008316 if (!Objects.equals(this.mAction, other.mAction)) return false;
8317 if (!Objects.equals(this.mData, other.mData)) return false;
8318 if (!Objects.equals(this.mType, other.mType)) return false;
8319 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8320 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8321 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008322
8323 return true;
8324 }
8325
8326 /**
8327 * Generate hash code that matches semantics of filterEquals().
8328 *
8329 * @return Returns the hash value of the action, data, type, class, and
8330 * categories.
8331 *
8332 * @see #filterEquals
8333 */
8334 public int filterHashCode() {
8335 int code = 0;
8336 if (mAction != null) {
8337 code += mAction.hashCode();
8338 }
8339 if (mData != null) {
8340 code += mData.hashCode();
8341 }
8342 if (mType != null) {
8343 code += mType.hashCode();
8344 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008345 if (mPackage != null) {
8346 code += mPackage.hashCode();
8347 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008348 if (mComponent != null) {
8349 code += mComponent.hashCode();
8350 }
8351 if (mCategories != null) {
8352 code += mCategories.hashCode();
8353 }
8354 return code;
8355 }
8356
8357 @Override
8358 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008359 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008360
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008361 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008362 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008363 b.append(" }");
8364
8365 return b.toString();
8366 }
8367
8368 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008369 public String toInsecureString() {
8370 StringBuilder b = new StringBuilder(128);
8371
8372 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008373 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008374 b.append(" }");
8375
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008376 return b.toString();
8377 }
Romain Guy4969af72009-06-17 10:53:19 -07008378
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008379 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008380 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008381 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008382
8383 b.append("Intent { ");
8384 toShortString(b, false, true, true, true);
8385 b.append(" }");
8386
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008387 return b.toString();
8388 }
8389
8390 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008391 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8392 StringBuilder b = new StringBuilder(128);
8393 toShortString(b, secure, comp, extras, clip);
8394 return b.toString();
8395 }
8396
8397 /** @hide */
8398 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8399 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008400 boolean first = true;
8401 if (mAction != null) {
8402 b.append("act=").append(mAction);
8403 first = false;
8404 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008405 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008406 if (!first) {
8407 b.append(' ');
8408 }
8409 first = false;
8410 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008411 for (int i=0; i<mCategories.size(); i++) {
8412 if (i > 0) b.append(',');
8413 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008414 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008415 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008416 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008417 if (mData != null) {
8418 if (!first) {
8419 b.append(' ');
8420 }
8421 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008422 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008423 if (secure) {
8424 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008425 } else {
8426 b.append(mData);
8427 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008428 }
8429 if (mType != null) {
8430 if (!first) {
8431 b.append(' ');
8432 }
8433 first = false;
8434 b.append("typ=").append(mType);
8435 }
8436 if (mFlags != 0) {
8437 if (!first) {
8438 b.append(' ');
8439 }
8440 first = false;
8441 b.append("flg=0x").append(Integer.toHexString(mFlags));
8442 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008443 if (mPackage != null) {
8444 if (!first) {
8445 b.append(' ');
8446 }
8447 first = false;
8448 b.append("pkg=").append(mPackage);
8449 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008450 if (comp && mComponent != null) {
8451 if (!first) {
8452 b.append(' ');
8453 }
8454 first = false;
8455 b.append("cmp=").append(mComponent.flattenToShortString());
8456 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008457 if (mSourceBounds != null) {
8458 if (!first) {
8459 b.append(' ');
8460 }
8461 first = false;
8462 b.append("bnds=").append(mSourceBounds.toShortString());
8463 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008464 if (mClipData != null) {
8465 if (!first) {
8466 b.append(' ');
8467 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008468 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008469 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008470 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008471 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008472 if (mClipData.getDescription() != null) {
8473 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8474 } else {
8475 first = true;
8476 }
8477 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008478 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008479 first = false;
8480 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008481 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008482 if (extras && mExtras != null) {
8483 if (!first) {
8484 b.append(' ');
8485 }
8486 first = false;
8487 b.append("(has extras)");
8488 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008489 if (mContentUserHint != UserHandle.USER_CURRENT) {
8490 if (!first) {
8491 b.append(' ');
8492 }
8493 first = false;
8494 b.append("u=").append(mContentUserHint);
8495 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008496 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008497 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008498 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008499 b.append("}");
8500 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008501 }
8502
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008503 /**
8504 * Call {@link #toUri} with 0 flags.
8505 * @deprecated Use {@link #toUri} instead.
8506 */
8507 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008508 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008509 return toUri(0);
8510 }
8511
8512 /**
8513 * Convert this Intent into a String holding a URI representation of it.
8514 * The returned URI string has been properly URI encoded, so it can be
8515 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8516 * Intent's data as the base URI, with an additional fragment describing
8517 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008518 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008519 * <p>You can convert the returned string back to an Intent with
8520 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008521 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008522 * @param flags Additional operating flags. Either 0,
8523 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008524 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008525 * @return Returns a URI encoding URI string describing the entire contents
8526 * of the Intent.
8527 */
8528 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008529 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008530 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8531 if (mPackage == null) {
8532 throw new IllegalArgumentException(
8533 "Intent must include an explicit package name to build an android-app: "
8534 + this);
8535 }
8536 uri.append("android-app://");
8537 uri.append(mPackage);
8538 String scheme = null;
8539 if (mData != null) {
8540 scheme = mData.getScheme();
8541 if (scheme != null) {
8542 uri.append('/');
8543 uri.append(scheme);
8544 String authority = mData.getEncodedAuthority();
8545 if (authority != null) {
8546 uri.append('/');
8547 uri.append(authority);
8548 String path = mData.getEncodedPath();
8549 if (path != null) {
8550 uri.append(path);
8551 }
8552 String queryParams = mData.getEncodedQuery();
8553 if (queryParams != null) {
8554 uri.append('?');
8555 uri.append(queryParams);
8556 }
8557 String fragment = mData.getEncodedFragment();
8558 if (fragment != null) {
8559 uri.append('#');
8560 uri.append(fragment);
8561 }
8562 }
8563 }
8564 }
8565 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8566 mPackage, flags);
8567 return uri.toString();
8568 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008569 String scheme = null;
8570 if (mData != null) {
8571 String data = mData.toString();
8572 if ((flags&URI_INTENT_SCHEME) != 0) {
8573 final int N = data.length();
8574 for (int i=0; i<N; i++) {
8575 char c = data.charAt(i);
8576 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8577 || c == '.' || c == '-') {
8578 continue;
8579 }
8580 if (c == ':' && i > 0) {
8581 // Valid scheme.
8582 scheme = data.substring(0, i);
8583 uri.append("intent:");
8584 data = data.substring(i+1);
8585 break;
8586 }
Tom Taylord4a47292009-12-21 13:59:18 -08008587
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008588 // No scheme.
8589 break;
8590 }
8591 }
8592 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008593
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008594 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8595 uri.append("intent:");
8596 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008597
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008598 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008599
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008600 return uri.toString();
8601 }
8602
8603 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8604 String defPackage, int flags) {
8605 StringBuilder frag = new StringBuilder(128);
8606
8607 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008608 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008609 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008610 // Note that for now we are not going to try to handle the
8611 // data part; not clear how to represent this as a URI, and
8612 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008613 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8614 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008615 }
8616
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008617 if (frag.length() > 0) {
8618 uri.append("#Intent;");
8619 uri.append(frag);
8620 uri.append("end");
8621 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008622 }
8623
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008624 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8625 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008626 if (scheme != null) {
8627 uri.append("scheme=").append(scheme).append(';');
8628 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008629 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008630 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008631 }
8632 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008633 for (int i=0; i<mCategories.size(); i++) {
8634 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008635 }
8636 }
8637 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008638 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008639 }
8640 if (mFlags != 0) {
8641 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8642 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008643 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008644 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8645 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008646 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008647 uri.append("component=").append(Uri.encode(
8648 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008649 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008650 if (mSourceBounds != null) {
8651 uri.append("sourceBounds=")
8652 .append(Uri.encode(mSourceBounds.flattenToString()))
8653 .append(';');
8654 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008655 if (mExtras != null) {
8656 for (String key : mExtras.keySet()) {
8657 final Object value = mExtras.get(key);
8658 char entryType =
8659 value instanceof String ? 'S' :
8660 value instanceof Boolean ? 'B' :
8661 value instanceof Byte ? 'b' :
8662 value instanceof Character ? 'c' :
8663 value instanceof Double ? 'd' :
8664 value instanceof Float ? 'f' :
8665 value instanceof Integer ? 'i' :
8666 value instanceof Long ? 'l' :
8667 value instanceof Short ? 's' :
8668 '\0';
8669
8670 if (entryType != '\0') {
8671 uri.append(entryType);
8672 uri.append('.');
8673 uri.append(Uri.encode(key));
8674 uri.append('=');
8675 uri.append(Uri.encode(value.toString()));
8676 uri.append(';');
8677 }
8678 }
8679 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008680 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008681
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008682 public int describeContents() {
8683 return (mExtras != null) ? mExtras.describeContents() : 0;
8684 }
8685
8686 public void writeToParcel(Parcel out, int flags) {
8687 out.writeString(mAction);
8688 Uri.writeToParcel(out, mData);
8689 out.writeString(mType);
8690 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008691 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008692 ComponentName.writeToParcel(mComponent, out);
8693
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008694 if (mSourceBounds != null) {
8695 out.writeInt(1);
8696 mSourceBounds.writeToParcel(out, flags);
8697 } else {
8698 out.writeInt(0);
8699 }
8700
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008701 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008702 final int N = mCategories.size();
8703 out.writeInt(N);
8704 for (int i=0; i<N; i++) {
8705 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008706 }
8707 } else {
8708 out.writeInt(0);
8709 }
8710
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008711 if (mSelector != null) {
8712 out.writeInt(1);
8713 mSelector.writeToParcel(out, flags);
8714 } else {
8715 out.writeInt(0);
8716 }
8717
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008718 if (mClipData != null) {
8719 out.writeInt(1);
8720 mClipData.writeToParcel(out, flags);
8721 } else {
8722 out.writeInt(0);
8723 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008724 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008725 out.writeBundle(mExtras);
8726 }
8727
8728 public static final Parcelable.Creator<Intent> CREATOR
8729 = new Parcelable.Creator<Intent>() {
8730 public Intent createFromParcel(Parcel in) {
8731 return new Intent(in);
8732 }
8733 public Intent[] newArray(int size) {
8734 return new Intent[size];
8735 }
8736 };
8737
Dianne Hackborneb034652009-09-07 00:49:58 -07008738 /** @hide */
8739 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008740 readFromParcel(in);
8741 }
8742
8743 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008744 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008745 mData = Uri.CREATOR.createFromParcel(in);
8746 mType = in.readString();
8747 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008748 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008749 mComponent = ComponentName.readFromParcel(in);
8750
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008751 if (in.readInt() != 0) {
8752 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8753 }
8754
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008755 int N = in.readInt();
8756 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008757 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008758 int i;
8759 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008760 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008761 }
8762 } else {
8763 mCategories = null;
8764 }
8765
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008766 if (in.readInt() != 0) {
8767 mSelector = new Intent(in);
8768 }
8769
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008770 if (in.readInt() != 0) {
8771 mClipData = new ClipData(in);
8772 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008773 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008774 mExtras = in.readBundle();
8775 }
8776
8777 /**
8778 * Parses the "intent" element (and its children) from XML and instantiates
8779 * an Intent object. The given XML parser should be located at the tag
8780 * where parsing should start (often named "intent"), from which the
8781 * basic action, data, type, and package and class name will be
8782 * retrieved. The function will then parse in to any child elements,
8783 * looking for <category android:name="xxx"> tags to add categories and
8784 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8785 * to the intent.
8786 *
8787 * @param resources The Resources to use when inflating resources.
8788 * @param parser The XML parser pointing at an "intent" tag.
8789 * @param attrs The AttributeSet interface for retrieving extended
8790 * attribute data at the current <var>parser</var> location.
8791 * @return An Intent object matching the XML data.
8792 * @throws XmlPullParserException If there was an XML parsing error.
8793 * @throws IOException If there was an I/O error.
8794 */
8795 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8796 throws XmlPullParserException, IOException {
8797 Intent intent = new Intent();
8798
8799 TypedArray sa = resources.obtainAttributes(attrs,
8800 com.android.internal.R.styleable.Intent);
8801
8802 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8803
8804 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8805 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8806 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8807
8808 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8809 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8810 if (packageName != null && className != null) {
8811 intent.setComponent(new ComponentName(packageName, className));
8812 }
8813
8814 sa.recycle();
8815
8816 int outerDepth = parser.getDepth();
8817 int type;
8818 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8819 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8820 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8821 continue;
8822 }
8823
8824 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008825 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008826 sa = resources.obtainAttributes(attrs,
8827 com.android.internal.R.styleable.IntentCategory);
8828 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8829 sa.recycle();
8830
8831 if (cat != null) {
8832 intent.addCategory(cat);
8833 }
8834 XmlUtils.skipCurrentTag(parser);
8835
Craig Mautner21d24a22014-04-23 11:45:37 -07008836 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008837 if (intent.mExtras == null) {
8838 intent.mExtras = new Bundle();
8839 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008840 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008841 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008842
8843 } else {
8844 XmlUtils.skipCurrentTag(parser);
8845 }
8846 }
8847
8848 return intent;
8849 }
Nick Pellyccae4122012-01-09 14:12:58 -08008850
Craig Mautner21d24a22014-04-23 11:45:37 -07008851 /** @hide */
8852 public void saveToXml(XmlSerializer out) throws IOException {
8853 if (mAction != null) {
8854 out.attribute(null, ATTR_ACTION, mAction);
8855 }
8856 if (mData != null) {
8857 out.attribute(null, ATTR_DATA, mData.toString());
8858 }
8859 if (mType != null) {
8860 out.attribute(null, ATTR_TYPE, mType);
8861 }
8862 if (mComponent != null) {
8863 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8864 }
8865 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8866
8867 if (mCategories != null) {
8868 out.startTag(null, TAG_CATEGORIES);
8869 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8870 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8871 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008872 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008873 }
8874 }
8875
8876 /** @hide */
8877 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8878 XmlPullParserException {
8879 Intent intent = new Intent();
8880 final int outerDepth = in.getDepth();
8881
8882 int attrCount = in.getAttributeCount();
8883 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8884 final String attrName = in.getAttributeName(attrNdx);
8885 final String attrValue = in.getAttributeValue(attrNdx);
8886 if (ATTR_ACTION.equals(attrName)) {
8887 intent.setAction(attrValue);
8888 } else if (ATTR_DATA.equals(attrName)) {
8889 intent.setData(Uri.parse(attrValue));
8890 } else if (ATTR_TYPE.equals(attrName)) {
8891 intent.setType(attrValue);
8892 } else if (ATTR_COMPONENT.equals(attrName)) {
8893 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8894 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008895 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008896 } else {
8897 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8898 }
8899 }
8900
8901 int event;
8902 String name;
8903 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8904 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8905 if (event == XmlPullParser.START_TAG) {
8906 name = in.getName();
8907 if (TAG_CATEGORIES.equals(name)) {
8908 attrCount = in.getAttributeCount();
8909 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8910 intent.addCategory(in.getAttributeValue(attrNdx));
8911 }
8912 } else {
8913 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8914 XmlUtils.skipCurrentTag(in);
8915 }
8916 }
8917 }
8918
8919 return intent;
8920 }
8921
Nick Pellyccae4122012-01-09 14:12:58 -08008922 /**
8923 * Normalize a MIME data type.
8924 *
8925 * <p>A normalized MIME type has white-space trimmed,
8926 * content-type parameters removed, and is lower-case.
8927 * This aligns the type with Android best practices for
8928 * intent filtering.
8929 *
8930 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8931 * "text/x-vCard" becomes "text/x-vcard".
8932 *
8933 * <p>All MIME types received from outside Android (such as user input,
8934 * or external sources like Bluetooth, NFC, or the Internet) should
8935 * be normalized before they are used to create an Intent.
8936 *
8937 * @param type MIME data type to normalize
8938 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008939 * @see #setType
8940 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008941 */
8942 public static String normalizeMimeType(String type) {
8943 if (type == null) {
8944 return null;
8945 }
8946
Elliott Hughescb64d432013-08-02 10:00:44 -07008947 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008948
8949 final int semicolonIndex = type.indexOf(';');
8950 if (semicolonIndex != -1) {
8951 type = type.substring(0, semicolonIndex);
8952 }
8953 return type;
8954 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008955
8956 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008957 * Prepare this {@link Intent} to leave an app process.
8958 *
8959 * @hide
8960 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008961 public void prepareToLeaveProcess(Context context) {
8962 final boolean leavingPackage = (mComponent == null)
8963 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8964 prepareToLeaveProcess(leavingPackage);
8965 }
8966
8967 /**
8968 * Prepare this {@link Intent} to leave an app process.
8969 *
8970 * @hide
8971 */
8972 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008973 setAllowFds(false);
8974
8975 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008976 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008977 }
8978 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008979 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008980 }
8981
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008982 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8983 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008984 switch (mAction) {
8985 case ACTION_MEDIA_REMOVED:
8986 case ACTION_MEDIA_UNMOUNTED:
8987 case ACTION_MEDIA_CHECKING:
8988 case ACTION_MEDIA_NOFS:
8989 case ACTION_MEDIA_MOUNTED:
8990 case ACTION_MEDIA_SHARED:
8991 case ACTION_MEDIA_UNSHARED:
8992 case ACTION_MEDIA_BAD_REMOVAL:
8993 case ACTION_MEDIA_UNMOUNTABLE:
8994 case ACTION_MEDIA_EJECT:
8995 case ACTION_MEDIA_SCANNER_STARTED:
8996 case ACTION_MEDIA_SCANNER_FINISHED:
8997 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008998 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8999 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009000 // Ignore legacy actions
9001 break;
9002 default:
9003 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009004 }
9005 }
9006 }
9007
9008 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009009 * @hide
9010 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009011 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009012 // We just entered destination process, so we should be able to read all
9013 // parcelables inside.
9014 setDefusable(true);
9015
9016 if (mSelector != null) {
9017 mSelector.prepareToEnterProcess();
9018 }
9019 if (mClipData != null) {
9020 mClipData.prepareToEnterProcess();
9021 }
9022
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009023 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009024 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9025 fixUris(mContentUserHint);
9026 mContentUserHint = UserHandle.USER_CURRENT;
9027 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009028 }
9029 }
9030
9031 /**
9032 * @hide
9033 */
9034 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009035 Uri data = getData();
9036 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009037 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009038 }
9039 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009040 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009041 }
9042 String action = getAction();
9043 if (ACTION_SEND.equals(action)) {
9044 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9045 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009046 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009047 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009048 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009049 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9050 if (streams != null) {
9051 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9052 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009053 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009054 }
9055 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9056 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009057 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9058 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9059 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9060 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9061 if (output != null) {
9062 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9063 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009064 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009065 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009066
9067 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009068 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009069 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9070 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009071 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009072 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009073 * @hide
9074 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009075 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009076 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009077 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009078
9079 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009080 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009081
9082 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009083 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009084 // Inspect contained intents to see if we need to migrate extras. We
9085 // don't promote ClipData to the parent, since ChooserActivity will
9086 // already start the picked item as the caller, and we can't combine
9087 // the flags in a safe way.
9088
9089 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009090 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009091 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9092 if (intent != null) {
9093 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009094 }
9095 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009096 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009097 try {
9098 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9099 if (intents != null) {
9100 for (int i = 0; i < intents.length; i++) {
9101 final Intent intent = (Intent) intents[i];
9102 if (intent != null) {
9103 migrated |= intent.migrateExtraStreamToClipData();
9104 }
9105 }
9106 }
9107 } catch (ClassCastException e) {
9108 }
9109 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009110
9111 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009112 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009113 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9114 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9115 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9116 if (stream != null || text != null || htmlText != null) {
9117 final ClipData clipData = new ClipData(
9118 null, new String[] { getType() },
9119 new ClipData.Item(text, htmlText, null, stream));
9120 setClipData(clipData);
9121 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009122 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009123 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009124 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009125 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009126
9127 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009128 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009129 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9130 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9131 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9132 int num = -1;
9133 if (streams != null) {
9134 num = streams.size();
9135 }
9136 if (texts != null) {
9137 if (num >= 0 && num != texts.size()) {
9138 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009139 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009140 }
9141 num = texts.size();
9142 }
9143 if (htmlTexts != null) {
9144 if (num >= 0 && num != htmlTexts.size()) {
9145 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009146 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009147 }
9148 num = htmlTexts.size();
9149 }
9150 if (num > 0) {
9151 final ClipData clipData = new ClipData(
9152 null, new String[] { getType() },
9153 makeClipItem(streams, texts, htmlTexts, 0));
9154
9155 for (int i = 1; i < num; i++) {
9156 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9157 }
9158
9159 setClipData(clipData);
9160 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009161 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009162 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009163 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009164 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009165 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9166 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9167 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9168 final Uri output;
9169 try {
9170 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9171 } catch (ClassCastException e) {
9172 return false;
9173 }
9174 if (output != null) {
9175 setClipData(ClipData.newRawUri("", output));
9176 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9177 return true;
9178 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009179 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009180
9181 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009182 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009183
9184 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9185 ArrayList<String> htmlTexts, int which) {
9186 Uri uri = streams != null ? streams.get(which) : null;
9187 CharSequence text = texts != null ? texts.get(which) : null;
9188 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9189 return new ClipData.Item(text, htmlText, null, uri);
9190 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009191
9192 /** @hide */
9193 public boolean isDocument() {
9194 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9195 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009196}