blob: 2ce22b432aa3c35ba5916a51d97967242f8c9dae [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";
fionaxu77a744c2017-03-17 14:35:39 -07001086
Santos Cordon15a13782015-03-31 18:32:31 -07001087 /**
fionaxu6a5ac3b2017-02-17 17:20:46 -08001088 * Activity Action: Main entry point for carrier setup apps.
1089 * <p>Carrier apps that provide an implementation for this action may be invoked to configure
1090 * carrier service and typically require
1091 * {@link android.telephony.TelephonyManager#hasCarrierPrivileges() carrier privileges} to
1092 * fulfill their duties.
1093 */
1094 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1095 public static final String ACTION_CARRIER_SETUP = "android.intent.action.CARRIER_SETUP";
1096 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001097 * Activity Action: Send a message to someone specified by the data.
1098 * <p>Input: {@link #getData} is URI describing the target.
1099 * <p>Output: nothing.
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1103 /**
1104 * Activity Action: Deliver some data to someone else. Who the data is
1105 * being delivered to is not specified; it is up to the receiver of this
1106 * action to ask the user where the data should be sent.
1107 * <p>
1108 * When launching a SEND intent, you should usually wrap it in a chooser
1109 * (through {@link #createChooser}), which will give the proper interface
1110 * for the user to pick how to send your data and allow you to specify
1111 * a prompt indicating what they are doing.
1112 * <p>
1113 * Input: {@link #getType} is the MIME type of the data being sent.
1114 * get*Extra can have either a {@link #EXTRA_TEXT}
1115 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1116 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1117 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1118 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001119 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1120 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1121 * your text with HTML formatting.
1122 * <p>
1123 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1124 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1125 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1126 * content: URIs and other advanced features of {@link ClipData}. If
1127 * using this approach, you still must supply the same data through the
1128 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1129 * for compatibility with old applications. If you don't set a ClipData,
1130 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001131 * <p>
1132 * Optional standard extras, which may be interpreted by some recipients as
1133 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1134 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1135 * <p>
1136 * Output: nothing.
1137 */
1138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139 public static final String ACTION_SEND = "android.intent.action.SEND";
1140 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001141 * Activity Action: Deliver multiple data to someone else.
1142 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001143 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001144 * <p>
1145 * Input: {@link #getType} is the MIME type of the data being sent.
1146 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001147 * #EXTRA_STREAM} field, containing the data to be sent. If using
1148 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1149 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001150 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001151 * Multiple types are supported, and receivers should handle mixed types
1152 * whenever possible. The right way for the receiver to check them is to
1153 * use the content resolver on each URI. The intent sender should try to
1154 * put the most concrete mime type in the intent type, but it can fall
1155 * back to {@literal <type>/*} or {@literal *}/* as needed.
1156 * <p>
1157 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1158 * be image/jpg, but if you are sending image/jpg and image/png, then the
1159 * intent's type should be image/*.
1160 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001161 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1162 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1163 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1164 * content: URIs and other advanced features of {@link ClipData}. If
1165 * using this approach, you still must supply the same data through the
1166 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1167 * for compatibility with old applications. If you don't set a ClipData,
1168 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1169 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001170 * Optional standard extras, which may be interpreted by some recipients as
1171 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1172 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1173 * <p>
1174 * Output: nothing.
1175 */
1176 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1177 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1178 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001179 * Activity Action: Handle an incoming phone call.
1180 * <p>Input: nothing.
1181 * <p>Output: nothing.
1182 */
1183 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1184 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1185 /**
1186 * Activity Action: Insert an empty item into the given container.
1187 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1188 * in which to place the data.
1189 * <p>Output: URI of the new data that was created.
1190 */
1191 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1192 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1193 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001194 * Activity Action: Create a new item in the given container, initializing it
1195 * from the current contents of the clipboard.
1196 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1197 * in which to place the data.
1198 * <p>Output: URI of the new data that was created.
1199 */
1200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1201 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1202 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001203 * Activity Action: Delete the given data from its container.
1204 * <p>Input: {@link #getData} is URI of data to be deleted.
1205 * <p>Output: nothing.
1206 */
1207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1208 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1209 /**
1210 * Activity Action: Run the data, whatever that means.
1211 * <p>Input: ? (Note: this is currently specific to the test harness.)
1212 * <p>Output: nothing.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_RUN = "android.intent.action.RUN";
1216 /**
1217 * Activity Action: Perform a data synchronization.
1218 * <p>Input: ?
1219 * <p>Output: ?
1220 */
1221 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1222 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1223 /**
1224 * Activity Action: Pick an activity given an intent, returning the class
1225 * selected.
1226 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1227 * used with {@link PackageManager#queryIntentActivities} to determine the
1228 * set of activities from which to pick.
1229 * <p>Output: Class name of the activity that was selected.
1230 */
1231 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1232 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1233 /**
1234 * Activity Action: Perform a search.
1235 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1236 * is the text to search for. If empty, simply
1237 * enter your search results Activity with the search UI activated.
1238 * <p>Output: nothing.
1239 */
1240 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1241 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1242 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001243 * Activity Action: Start the platform-defined tutorial
1244 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1245 * is the text to search for. If empty, simply
1246 * enter your search results Activity with the search UI activated.
1247 * <p>Output: nothing.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1251 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001252 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001253 * <p>
1254 * Input: {@link android.app.SearchManager#QUERY
1255 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1256 * a url starts with http or https, the site will be opened. If it is plain
1257 * text, Google search will be applied.
1258 * <p>
1259 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001260 */
1261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1262 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001263
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001264 /**
Jim Miller07994402012-05-02 14:22:27 -07001265 * Activity Action: Perform assist action.
1266 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001267 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1268 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001269 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1270 * information.
Jim Miller07994402012-05-02 14:22:27 -07001271 * Output: nothing.
1272 */
1273 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1274 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001275
1276 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001277 * Activity Action: Perform voice assist action.
1278 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001279 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1280 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001281 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001282 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001283 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001284 */
1285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1286 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1287
1288 /**
Adam Skory7140a252013-09-11 12:04:58 +01001289 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1290 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001291 */
1292 public static final String EXTRA_ASSIST_PACKAGE
1293 = "android.intent.extra.ASSIST_PACKAGE";
1294
1295 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001296 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1297 * application package at the time the assist was invoked.
1298 */
1299 public static final String EXTRA_ASSIST_UID
1300 = "android.intent.extra.ASSIST_UID";
1301
1302 /**
Adam Skory7140a252013-09-11 12:04:58 +01001303 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1304 * information supplied by the current foreground app at the time of the assist request.
1305 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001306 */
1307 public static final String EXTRA_ASSIST_CONTEXT
1308 = "android.intent.extra.ASSIST_CONTEXT";
1309
Jim Miller07994402012-05-02 14:22:27 -07001310 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001311 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1312 * keyboard as the primary input device for assistance.
1313 */
1314 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1315 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1316
1317 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001318 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1319 * that was used to invoke the assist.
1320 */
1321 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1322 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1323
1324 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001325 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001326 * <p>Input: Nothing.
1327 * <p>Output: nothing.
1328 */
1329 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1330 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1331 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001332 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001333 * <p>Input: Nothing.
1334 * <p>Output: Nothing.
1335 */
1336 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1337 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1338
1339 /**
1340 * Activity Action: Show activity for reporting a bug.
1341 * <p>Input: Nothing.
1342 * <p>Output: Nothing.
1343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1346
1347 /**
1348 * Activity Action: Main entry point for factory tests. Only used when
1349 * the device is booting in factory test node. The implementing package
1350 * must be installed in the system image.
1351 * <p>Input: nothing
1352 * <p>Output: nothing
1353 */
1354 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1355
1356 /**
1357 * Activity Action: The user pressed the "call" button to go to the dialer
1358 * or other appropriate UI for placing a call.
1359 * <p>Input: Nothing.
1360 * <p>Output: Nothing.
1361 */
1362 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1363 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1364
1365 /**
1366 * Activity Action: Start Voice Command.
1367 * <p>Input: Nothing.
1368 * <p>Output: Nothing.
1369 */
1370 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1371 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001372
1373 /**
1374 * Activity Action: Start action associated with long pressing on the
1375 * search key.
1376 * <p>Input: Nothing.
1377 * <p>Output: Nothing.
1378 */
1379 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1380 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001381
Jacek Surazski86b6c532009-05-13 14:38:28 +02001382 /**
1383 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1384 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001385 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001386 * <p>Input: No data is specified. The bug report is passed in using
1387 * an {@link #EXTRA_BUG_REPORT} field.
1388 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001389 *
1390 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001391 */
1392 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1393 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001394
1395 /**
1396 * Activity Action: Show power usage information to the user.
1397 * <p>Input: Nothing.
1398 * <p>Output: Nothing.
1399 */
1400 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1401 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001402
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001403 /**
1404 * Activity Action: Setup wizard to launch after a platform update. This
1405 * activity should have a string meta-data field associated with it,
1406 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1407 * the platform for setup. The activity will be launched only if
1408 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1409 * same value.
1410 * <p>Input: Nothing.
1411 * <p>Output: Nothing.
1412 * @hide
1413 */
1414 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1415 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001416
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001417 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001418 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1419 * <p>Input: Nothing.
1420 * <p>Output: Nothing.
1421 * @hide
1422 */
1423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1424 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1425 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1426
1427 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001428 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1429 * <p>Input: Nothing.
1430 * <p>Output: Nothing.
1431 * @hide
1432 */
1433 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1434 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1435 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1436
1437 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001438 * Activity Action: Show settings for managing network data usage of a
1439 * specific application. Applications should define an activity that offers
1440 * options to control data usage.
1441 */
1442 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1443 public static final String ACTION_MANAGE_NETWORK_USAGE =
1444 "android.intent.action.MANAGE_NETWORK_USAGE";
1445
1446 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001447 * Activity Action: Launch application installer.
1448 * <p>
1449 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001450 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1451 * you can also use "package:<package-name>" to install an application for the
1452 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001453 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1454 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1455 * <p>
1456 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1457 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001458 * <p>
1459 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1460 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1461 * in order to launch the application installer.
1462 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001463 *
1464 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1465 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1466 * @see #EXTRA_RETURN_RESULT
1467 */
1468 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1469 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1470
1471 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001472 * Activity Action: Launch ephemeral installer.
1473 * <p>
1474 * Input: The data must be a http: URI that the ephemeral application is registered
1475 * to handle.
1476 * <p class="note">
1477 * This is a protected intent that can only be sent by the system.
1478 * </p>
1479 *
1480 * @hide
1481 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001482 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1483 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1484 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1485
1486 /**
1487 * Service Action: Resolve ephemeral application.
1488 * <p>
1489 * The system will have a persistent connection to this service.
1490 * This is a protected intent that can only be sent by the system.
1491 * </p>
1492 *
1493 * @hide
1494 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001495 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1496 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1497 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1498
1499 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001500 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1501 * package. Specifies the installer package name; this package will receive the
1502 * {@link #ACTION_APP_ERROR} intent.
1503 */
1504 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1505 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1506
1507 /**
1508 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1509 * package. Specifies that the application being installed should not be
1510 * treated as coming from an unknown source, but as coming from the app
1511 * invoking the Intent. For this to work you must start the installer with
1512 * startActivityForResult().
1513 */
1514 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1515 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1516
1517 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001518 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1519 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001520 * data field originated from.
1521 */
rich cannings706e8ba2012-08-20 13:20:14 -07001522 public static final String EXTRA_ORIGINATING_URI
1523 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001524
1525 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001526 * This extra can be used with any Intent used to launch an activity, supplying information
1527 * about who is launching that activity. This field contains a {@link android.net.Uri}
1528 * object, typically an http: or https: URI of the web site that the referral came from;
1529 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1530 * a native application that it came from.
1531 *
1532 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1533 * instead of directly retrieving the extra. It is also valid for applications to
1534 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1535 * a string, not a Uri; the field here, if supplied, will always take precedence,
1536 * however.</p>
1537 *
1538 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001539 */
1540 public static final String EXTRA_REFERRER
1541 = "android.intent.extra.REFERRER";
1542
1543 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001544 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1545 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1546 * not be created, in particular when Intent extras are supplied through the
1547 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1548 * schemes.
1549 *
1550 * @see #EXTRA_REFERRER
1551 */
1552 public static final String EXTRA_REFERRER_NAME
1553 = "android.intent.extra.REFERRER_NAME";
1554
1555 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001556 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001557 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001558 * @hide
1559 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001560 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001561 public static final String EXTRA_ORIGINATING_UID
1562 = "android.intent.extra.ORIGINATING_UID";
1563
1564 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001565 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1566 * package. Tells the installer UI to skip the confirmation with the user
1567 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001568 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1569 * will no longer show an interstitial message about updating existing
1570 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001571 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001572 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001573 public static final String EXTRA_ALLOW_REPLACE
1574 = "android.intent.extra.ALLOW_REPLACE";
1575
1576 /**
1577 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1578 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1579 * return to the application the result code of the install/uninstall. The returned result
1580 * code will be {@link android.app.Activity#RESULT_OK} on success or
1581 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1582 */
1583 public static final String EXTRA_RETURN_RESULT
1584 = "android.intent.extra.RETURN_RESULT";
1585
1586 /**
1587 * Package manager install result code. @hide because result codes are not
1588 * yet ready to be exposed.
1589 */
1590 public static final String EXTRA_INSTALL_RESULT
1591 = "android.intent.extra.INSTALL_RESULT";
1592
1593 /**
1594 * Activity Action: Launch application uninstaller.
1595 * <p>
1596 * Input: The data must be a package: URI whose scheme specific part is
1597 * the package name of the current installed package to be uninstalled.
1598 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1599 * <p>
1600 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1601 * succeeded.
1602 */
1603 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1604 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1605
1606 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001607 * Specify whether the package should be uninstalled for all users.
1608 * @hide because these should not be part of normal application flow.
1609 */
1610 public static final String EXTRA_UNINSTALL_ALL_USERS
1611 = "android.intent.extra.UNINSTALL_ALL_USERS";
1612
1613 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001614 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1615 * describing the last run version of the platform that was setup.
1616 * @hide
1617 */
1618 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1619
Svet Ganov3695b8a2015-03-24 16:30:25 -07001620 /**
1621 * Activity action: Launch UI to manage the permissions of an app.
1622 * <p>
1623 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1624 * will be managed by the launched UI.
1625 * </p>
1626 * <p>
1627 * Output: Nothing.
1628 * </p>
1629 *
1630 * @see #EXTRA_PACKAGE_NAME
1631 *
1632 * @hide
1633 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001634 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001635 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1636 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1637 "android.intent.action.MANAGE_APP_PERMISSIONS";
1638
1639 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001640 * Activity action: Launch UI to manage permissions.
1641 * <p>
1642 * Input: Nothing.
1643 * </p>
1644 * <p>
1645 * Output: Nothing.
1646 * </p>
1647 *
1648 * @hide
1649 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001650 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001651 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1652 public static final String ACTION_MANAGE_PERMISSIONS =
1653 "android.intent.action.MANAGE_PERMISSIONS";
1654
1655 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001656 * Activity action: Launch UI to review permissions for an app.
1657 * The system uses this intent if permission review for apps not
1658 * supporting the new runtime permissions model is enabled. In
1659 * this mode a permission review is required before any of the
1660 * app components can run.
1661 * <p>
1662 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1663 * permissions will be reviewed (mandatory).
1664 * </p>
1665 * <p>
1666 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1667 * be fired after the permission review (optional).
1668 * </p>
1669 * <p>
1670 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1671 * be invoked after the permission review (optional).
1672 * </p>
1673 * <p>
1674 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1675 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1676 * </p>
1677 * <p>
1678 * Output: Nothing.
1679 * </p>
1680 *
1681 * @see #EXTRA_PACKAGE_NAME
1682 * @see #EXTRA_INTENT
1683 * @see #EXTRA_REMOTE_CALLBACK
1684 * @see #EXTRA_RESULT_NEEDED
1685 *
1686 * @hide
1687 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001688 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001689 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1690 public static final String ACTION_REVIEW_PERMISSIONS =
1691 "android.intent.action.REVIEW_PERMISSIONS";
1692
1693 /**
1694 * Intent extra: A callback for reporting remote result as a bundle.
1695 * <p>
1696 * Type: IRemoteCallback
1697 * </p>
1698 *
1699 * @hide
1700 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001701 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001702 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1703
1704 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001705 * Intent extra: An app package name.
1706 * <p>
1707 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001708 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001709 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001710 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001711 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1712
1713 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001714 * Intent extra: An extra for specifying whether a result is needed.
1715 * <p>
1716 * Type: boolean
1717 * </p>
1718 *
1719 * @hide
1720 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001721 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001722 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1723
1724 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001725 * Activity action: Launch UI to manage which apps have a given permission.
1726 * <p>
1727 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1728 * to which will be managed by the launched UI.
1729 * </p>
1730 * <p>
1731 * Output: Nothing.
1732 * </p>
1733 *
1734 * @see #EXTRA_PERMISSION_NAME
1735 *
1736 * @hide
1737 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001738 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001739 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1740 public static final String ACTION_MANAGE_PERMISSION_APPS =
1741 "android.intent.action.MANAGE_PERMISSION_APPS";
1742
1743 /**
1744 * Intent extra: The name of a permission.
1745 * <p>
1746 * Type: String
1747 * </p>
1748 *
1749 * @hide
1750 */
1751 @SystemApi
1752 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1753
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001754 // ---------------------------------------------------------------------
1755 // ---------------------------------------------------------------------
1756 // Standard intent broadcast actions (see action variable).
1757
1758 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001759 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1760 * <p>
1761 * For historical reasons, the name of this broadcast action refers to the power
1762 * state of the screen but it is actually sent in response to changes in the
1763 * overall interactive state of the device.
1764 * </p><p>
1765 * This broadcast is sent when the device becomes non-interactive which may have
1766 * nothing to do with the screen turning off. To determine the
1767 * actual state of the screen, use {@link android.view.Display#getState}.
1768 * </p><p>
1769 * See {@link android.os.PowerManager#isInteractive} for details.
1770 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001771 * You <em>cannot</em> receive this through components declared in
1772 * manifests, only by explicitly registering for it with
1773 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1774 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001775 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001776 * <p class="note">This is a protected intent that can only be sent
1777 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001778 */
1779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1780 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001781
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001782 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001783 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1784 * <p>
1785 * For historical reasons, the name of this broadcast action refers to the power
1786 * state of the screen but it is actually sent in response to changes in the
1787 * overall interactive state of the device.
1788 * </p><p>
1789 * This broadcast is sent when the device becomes interactive which may have
1790 * nothing to do with the screen turning on. To determine the
1791 * actual state of the screen, use {@link android.view.Display#getState}.
1792 * </p><p>
1793 * See {@link android.os.PowerManager#isInteractive} for details.
1794 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001795 * You <em>cannot</em> receive this through components declared in
1796 * manifests, only by explicitly registering for it with
1797 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1798 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001799 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001800 * <p class="note">This is a protected intent that can only be sent
1801 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001802 */
1803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1804 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001805
1806 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001807 * Broadcast Action: Sent after the system stops dreaming.
1808 *
1809 * <p class="note">This is a protected intent that can only be sent by the system.
1810 * It is only sent to registered receivers.</p>
1811 */
1812 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1813 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1814
1815 /**
1816 * Broadcast Action: Sent after the system starts dreaming.
1817 *
1818 * <p class="note">This is a protected intent that can only be sent by the system.
1819 * It is only sent to registered receivers.</p>
1820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1822 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1823
1824 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001825 * 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 -07001826 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001827 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001828 * <p class="note">This is a protected intent that can only be sent
1829 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001830 */
1831 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001832 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001833
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001834 /**
1835 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001836 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001837 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001838 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1839 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001840 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 */
1844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1845 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1846 /**
1847 * Broadcast Action: The time was set.
1848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1850 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1851 /**
1852 * Broadcast Action: The date has changed.
1853 */
1854 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1855 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1856 /**
1857 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1858 * <ul>
1859 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1860 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001861 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1866 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1867 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001868 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1869 * DNS entries should be tossed.
1870 * @hide
1871 */
1872 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1873 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1874 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001875 * Alarm Changed Action: This is broadcast when the AlarmClock
1876 * application's alarm is set or unset. It is used by the
1877 * AlarmClock application and the StatusBar service.
1878 * @hide
1879 */
1880 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1881 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001882
1883 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001884 * Broadcast Action: This is broadcast once, after the user has finished
1885 * booting, but while still in the "locked" state. It can be used to perform
1886 * application-specific initialization, such as installing alarms. You must
1887 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1888 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001889 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001890 * This broadcast is sent immediately at boot by all devices (regardless of
1891 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1892 * higher. Upon receipt of this broadcast, the user is still locked and only
1893 * device-protected storage can be accessed safely. If you want to access
1894 * credential-protected storage, you need to wait for the user to be
1895 * unlocked (typically by entering their lock pattern or PIN for the first
1896 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1897 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1898 * <p>
1899 * To receive this broadcast, your receiver component must be marked as
1900 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001901 * <p class="note">
1902 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001903 *
1904 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1908
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001909 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001910 * Broadcast Action: This is broadcast once, after the user has finished
1911 * booting. It can be used to perform application-specific initialization,
1912 * such as installing alarms. You must hold the
1913 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1914 * order to receive this broadcast.
1915 * <p>
1916 * This broadcast is sent at boot by all devices (both with and without
1917 * direct boot support). Upon receipt of this broadcast, the user is
1918 * unlocked and both device-protected and credential-protected storage can
1919 * accessed safely.
1920 * <p>
1921 * If you need to run while the user is still locked (before they've entered
1922 * their lock pattern or PIN for the first time), you can listen for the
1923 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1924 * <p class="note">
1925 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001929
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 /**
1931 * Broadcast Action: This is broadcast when a user action should request a
1932 * temporary system dialog to dismiss. Some examples of temporary system
1933 * dialogs are the notification window-shade and the recent tasks dialog.
1934 */
1935 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1936 /**
1937 * Broadcast Action: Trigger the download and eventual installation
1938 * of a package.
1939 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001940 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001941 * <p class="note">This is a protected intent that can only be sent
1942 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001943 *
1944 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001945 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001946 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1948 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1949 /**
1950 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001951 * device. The data contains the name of the package. Note that the
1952 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001953 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001954 * <ul>
1955 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1956 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1957 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1958 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001959 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001960 * <p class="note">This is a protected intent that can only be sent
1961 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1965 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001966 * Broadcast Action: A new version of an application package has been
1967 * installed, replacing an existing version that was previously installed.
1968 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001969 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001970 * <ul>
1971 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1972 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001973 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001974 * <p class="note">This is a protected intent that can only be sent
1975 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001976 */
1977 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1978 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1979 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001980 * Broadcast Action: A new version of your application has been installed
1981 * over an existing one. This is only sent to the application that was
1982 * replaced. It does not contain any additional data; to receive it, just
1983 * use an intent filter for this action.
1984 *
1985 * <p class="note">This is a protected intent that can only be sent
1986 * by the system.
1987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1990 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991 * Broadcast Action: An existing application package has been removed from
1992 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07001993 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001994 * <ul>
1995 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1996 * to the package.
1997 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1998 * application -- data and code -- is being removed.
1999 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2000 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2001 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002002 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002003 * <p class="note">This is a protected intent that can only be sent
2004 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002005 */
2006 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2007 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2008 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002009 * Broadcast Action: An existing application package has been completely
2010 * removed from the device. The data contains the name of the package.
2011 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2012 * {@link #EXTRA_DATA_REMOVED} is true and
2013 * {@link #EXTRA_REPLACING} is false of that broadcast.
2014 *
2015 * <ul>
2016 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2017 * to the package.
2018 * </ul>
2019 *
2020 * <p class="note">This is a protected intent that can only be sent
2021 * by the system.
2022 */
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_PACKAGE_FULLY_REMOVED
2025 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2026 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002027 * Broadcast Action: An existing application package has been changed (for
2028 * example, a component has been enabled or disabled). The data contains
2029 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002030 * <ul>
2031 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002032 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002033 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002034 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2035 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002036 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002037 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002038 * <p class="note">This is a protected intent that can only be sent
2039 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002040 */
2041 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2042 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2043 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002044 * @hide
2045 * Broadcast Action: Ask system services if there is any reason to
2046 * restart the given package. The data contains the name of the
2047 * package.
2048 * <ul>
2049 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2050 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2051 * </ul>
2052 *
2053 * <p class="note">This is a protected intent that can only be sent
2054 * by the system.
2055 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002056 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002057 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2058 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2059 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002060 * Broadcast Action: The user has restarted a package, and all of its
2061 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002062 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002063 * be removed. Note that the restarted package does <em>not</em>
2064 * receive this broadcast.
2065 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002066 * <ul>
2067 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2068 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002069 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002070 * <p class="note">This is a protected intent that can only be sent
2071 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 */
2073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2074 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2075 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002076 * Broadcast Action: The user has cleared the data of a package. This should
2077 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002078 * its persistent data is erased and this broadcast sent.
2079 * Note that the cleared package does <em>not</em>
2080 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002081 * <ul>
2082 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2083 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002084 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002085 * <p class="note">This is a protected intent that can only be sent
2086 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002087 */
2088 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2089 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2090 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002091 * Broadcast Action: Packages have been suspended.
2092 * <p>Includes the following extras:
2093 * <ul>
2094 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2095 * </ul>
2096 *
2097 * <p class="note">This is a protected intent that can only be sent
2098 * by the system. It is only sent to registered receivers.
2099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2102 /**
2103 * Broadcast Action: Packages have been unsuspended.
2104 * <p>Includes the following extras:
2105 * <ul>
2106 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2107 * </ul>
2108 *
2109 * <p class="note">This is a protected intent that can only be sent
2110 * by the system. It is only sent to registered receivers.
2111 */
2112 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2113 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2114 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002115 * Broadcast Action: A user ID has been removed from the system. The user
2116 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002117 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002118 * <p class="note">This is a protected intent that can only be sent
2119 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002123
2124 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002125 * Broadcast Action: Sent to the installer package of an application when
2126 * that application is first launched (that is the first time it is moved
2127 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002128 *
2129 * <p class="note">This is a protected intent that can only be sent
2130 * by the system.
2131 */
2132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2133 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2134
2135 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002136 * Broadcast Action: Sent to the system package verifier when a package
2137 * needs to be verified. The data contains the package URI.
2138 * <p class="note">
2139 * This is a protected intent that can only be sent by the system.
2140 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002141 */
2142 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2143 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2144
2145 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002146 * Broadcast Action: Sent to the system package verifier when a package is
2147 * verified. The data contains the package URI.
2148 * <p class="note">
2149 * This is a protected intent that can only be sent by the system.
2150 */
2151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2152 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2153
2154 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002155 * Broadcast Action: Sent to the system intent filter verifier when an
2156 * intent filter needs to be verified. The data contains the filter data
2157 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002158 * <p class="note">
2159 * This is a protected intent that can only be sent by the system.
2160 * </p>
2161 *
2162 * @hide
2163 */
2164 @SystemApi
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2166 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2167
2168 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002169 * Broadcast Action: Resources for a set of packages (which were
2170 * previously unavailable) are currently
2171 * available since the media on which they exist is available.
2172 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2173 * list of packages whose availability changed.
2174 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2175 * list of uids of packages whose availability changed.
2176 * Note that the
2177 * packages in this list do <em>not</em> receive this broadcast.
2178 * The specified set of packages are now available on the system.
2179 * <p>Includes the following extras:
2180 * <ul>
2181 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2182 * whose resources(were previously unavailable) are currently available.
2183 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2184 * packages whose resources(were previously unavailable)
2185 * are currently available.
2186 * </ul>
2187 *
2188 * <p class="note">This is a protected intent that can only be sent
2189 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002190 */
2191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002192 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2193 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002194
2195 /**
2196 * Broadcast Action: Resources for a set of packages are currently
2197 * unavailable since the media on which they exist is unavailable.
2198 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2199 * list of packages whose availability changed.
2200 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2201 * list of uids of packages whose availability changed.
2202 * The specified set of packages can no longer be
2203 * launched and are practically unavailable on the system.
2204 * <p>Inclues the following extras:
2205 * <ul>
2206 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2207 * whose resources are no longer available.
2208 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2209 * whose resources are no longer available.
2210 * </ul>
2211 *
2212 * <p class="note">This is a protected intent that can only be sent
2213 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002214 */
2215 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002216 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002217 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002218
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002219 /**
Makoto Onuki10305202016-07-14 18:14:08 -07002220 * Broadcast Action: preferred activities have changed *explicitly*.
2221 *
2222 * <p>Note there are cases where a preferred activity is invalidated *implicitly*, e.g.
2223 * when an app is installed or uninstalled, but in such cases this broadcast will *not*
2224 * be sent.
2225 *
2226 * {@link #EXTRA_USER_HANDLE} contains the user ID in question.
2227 *
2228 * @hide
2229 */
2230 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2231 public static final String ACTION_PREFERRED_ACTIVITY_CHANGED =
2232 "android.intent.action.ACTION_PREFERRED_ACTIVITY_CHANGED";
2233
2234
2235 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002236 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002237 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002238 * This should <em>only</em> be used to determine when the wallpaper
2239 * has changed to show the new wallpaper to the user. You should certainly
2240 * never, in response to this, change the wallpaper or other attributes of
2241 * it such as the suggested size. That would be crazy, right? You'd cause
2242 * all kinds of loops, especially if other apps are doing similar things,
2243 * right? Of course. So please don't do this.
2244 *
2245 * @deprecated Modern applications should use
2246 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2247 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2248 * shown behind their UI, rather than watching for this broadcast and
2249 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002250 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002251 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002252 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2253 /**
2254 * Broadcast Action: The current device {@link android.content.res.Configuration}
2255 * (orientation, locale, etc) has changed. When such a change happens, the
2256 * UIs (view hierarchy) will need to be rebuilt based on this new
2257 * information; for the most part, applications don't need to worry about
2258 * this, because the system will take care of stopping and restarting the
2259 * application to make sure it sees the new changes. Some system code that
2260 * can not be restarted will need to watch for this action and handle it
2261 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002262 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002263 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002264 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002265 * in manifests, only by explicitly registering for it with
2266 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2267 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002268 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002269 * <p class="note">This is a protected intent that can only be sent
2270 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 *
2272 * @see android.content.res.Configuration
2273 */
2274 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2275 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2276 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002277 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002278 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002279 * <p class="note">This is a protected intent that can only be sent
2280 * by the system.
2281 */
2282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2283 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2284 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002285 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2286 * charging state, level, and other information about the battery.
2287 * See {@link android.os.BatteryManager} for documentation on the
2288 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002289 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002291 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002292 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002293 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002294 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2295 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2296 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2297 * broadcasts that are sent and can be received through manifest
2298 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002299 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002300 * <p class="note">This is a protected intent that can only be sent
2301 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 */
2303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2305 /**
2306 * Broadcast Action: Indicates low battery condition on the device.
2307 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002308 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002309 * <p class="note">This is a protected intent that can only be sent
2310 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002311 */
2312 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2313 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2314 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002315 * Broadcast Action: Indicates the battery is now okay after being low.
2316 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2317 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002318 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002319 * <p class="note">This is a protected intent that can only be sent
2320 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002321 */
2322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2323 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2324 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002325 * Broadcast Action: External power has been connected to the device.
2326 * This is intended for applications that wish to register specifically to this notification.
2327 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2328 * stay active to receive this notification. This action can be used to implement actions
2329 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002330 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002331 * <p class="note">This is a protected intent that can only be sent
2332 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002333 */
2334 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002335 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002336 /**
2337 * Broadcast Action: External power has been removed from the device.
2338 * This is intended for applications that wish to register specifically to this notification.
2339 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2340 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002341 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002342 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002343 * <p class="note">This is a protected intent that can only be sent
2344 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002345 */
2346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002347 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002348 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002349 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002350 * Broadcast Action: Device is shutting down.
2351 * This is broadcast when the device is being shut down (completely turned
2352 * off, not sleeping). Once the broadcast is complete, the final shutdown
2353 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002354 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002355 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002356 * <p class="note">This is a protected intent that can only be sent
2357 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002358 * <p>May include the following extras:
2359 * <ul>
2360 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2361 * shutdown is only for userspace processes. If not set, assumed to be false.
2362 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002363 */
2364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002365 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002366 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002367 * Activity Action: Start this activity to request system shutdown.
2368 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002369 * to request confirmation from the user before shutting down. The optional boolean
2370 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2371 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002372 *
2373 * <p class="note">This is a protected intent that can only be sent
2374 * by the system.
2375 *
2376 * {@hide}
2377 */
2378 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2379 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002380 * Broadcast Action: A sticky broadcast that indicates low memory
2381 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002382 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002383 * <p class="note">This is a protected intent that can only be sent
2384 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002385 */
2386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2387 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2388 /**
2389 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002390 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002391 * <p class="note">This is a protected intent that can only be sent
2392 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002393 */
2394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2395 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2396 /**
Jake Hambybb371632010-08-23 18:16:48 -07002397 * Broadcast Action: A sticky broadcast that indicates a memory full
2398 * condition on the device. This is intended for activities that want
2399 * to be able to fill the data partition completely, leaving only
2400 * enough free space to prevent system-wide SQLite failures.
2401 *
2402 * <p class="note">This is a protected intent that can only be sent
2403 * by the system.
2404 *
2405 * {@hide}
2406 */
2407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2408 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2409 /**
2410 * Broadcast Action: Indicates memory full condition on the device
2411 * no longer exists.
2412 *
2413 * <p class="note">This is a protected intent that can only be sent
2414 * by the system.
2415 *
2416 * {@hide}
2417 */
2418 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2419 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2420 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002421 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2422 * and package management should be started.
2423 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2424 * notification.
2425 */
2426 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2427 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2428 /**
2429 * Broadcast Action: The device has entered USB Mass Storage mode.
2430 * This is used mainly for the USB Settings panel.
2431 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2432 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002433 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002434 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002435 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002436 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2437
2438 /**
2439 * Broadcast Action: The device has exited USB Mass Storage mode.
2440 * This is used mainly for the USB Settings panel.
2441 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2442 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002443 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002444 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002445 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002446 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2447
2448 /**
2449 * Broadcast Action: External media has been removed.
2450 * The path to the mount point for the removed media is contained in the Intent.mData field.
2451 */
2452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2453 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2454
2455 /**
2456 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002457 * 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 -07002458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2461
2462 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002463 * Broadcast Action: External media is present, and being disk-checked
2464 * 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 -08002465 */
2466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2467 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2468
2469 /**
2470 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2471 * 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 -08002472 */
2473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2474 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2475
2476 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002477 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002478 * 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 -07002479 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2480 * media was mounted read only.
2481 */
2482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2483 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2484
2485 /**
2486 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002487 * 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 -07002488 */
2489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2490 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2491
2492 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002493 * Broadcast Action: External media is no longer being shared via USB mass storage.
2494 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2495 *
2496 * @hide
2497 */
2498 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2499
2500 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002501 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2502 * The path to the mount point for the removed media is contained in the Intent.mData field.
2503 */
2504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2505 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2506
2507 /**
2508 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002509 * 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 -07002510 */
2511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2512 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2513
2514 /**
2515 * Broadcast Action: User has expressed the desire to remove the external storage media.
2516 * Applications should close all files they have open within the mount point when they receive this intent.
2517 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2518 */
2519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2520 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2521
2522 /**
2523 * Broadcast Action: The media scanner has started scanning a directory.
2524 * The path to the directory being scanned is contained in the Intent.mData field.
2525 */
2526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2527 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2528
2529 /**
2530 * Broadcast Action: The media scanner has finished scanning a directory.
2531 * The path to the scanned directory is contained in the Intent.mData field.
2532 */
2533 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2534 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2535
2536 /**
2537 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2538 * The path to the file is contained in the Intent.mData field.
2539 */
2540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2541 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2542
2543 /**
2544 * Broadcast Action: The "Media Button" was pressed. Includes a single
2545 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2546 * caused the broadcast.
2547 */
2548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2549 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2550
2551 /**
2552 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2553 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2554 * caused the broadcast.
2555 */
2556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2557 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2558
2559 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2560 // location; they are not general-purpose actions.
2561
2562 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002563 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 */
2565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2566 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2567 "android.intent.action.GTALK_CONNECTED";
2568
2569 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002570 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002571 */
2572 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2573 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2574 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002575
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002576 /**
2577 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002578 */
2579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2580 public static final String ACTION_INPUT_METHOD_CHANGED =
2581 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002582
2583 /**
2584 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2585 * more radios have been turned off or on. The intent will have the following extra value:</p>
2586 * <ul>
2587 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2588 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2589 * turned off</li>
2590 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002591 *
Peng Xua35b5532016-01-20 00:05:45 -08002592 * <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 -07002593 */
2594 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2595 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2596
2597 /**
2598 * Broadcast Action: Some content providers have parts of their namespace
2599 * where they publish new events or items that the user may be especially
2600 * interested in. For these things, they may broadcast this action when the
2601 * set of interesting items change.
2602 *
2603 * For example, GmailProvider sends this notification when the set of unread
2604 * mail in the inbox changes.
2605 *
2606 * <p>The data of the intent identifies which part of which provider
2607 * changed. When queried through the content resolver, the data URI will
2608 * return the data set in question.
2609 *
2610 * <p>The intent will have the following extra values:
2611 * <ul>
2612 * <li><em>count</em> - The number of items in the data set. This is the
2613 * same as the number of items in the cursor returned by querying the
2614 * data URI. </li>
2615 * </ul>
2616 *
2617 * This intent will be sent at boot (if the count is non-zero) and when the
2618 * data set changes. It is possible for the data set to change without the
2619 * count changing (for example, if a new unread message arrives in the same
2620 * sync operation in which a message is archived). The phone should still
2621 * ring/vibrate/etc as normal in this case.
2622 */
2623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2624 public static final String ACTION_PROVIDER_CHANGED =
2625 "android.intent.action.PROVIDER_CHANGED";
2626
2627 /**
2628 * Broadcast Action: Wired Headset plugged in or unplugged.
2629 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002630 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2631 * and documentation.
2632 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002633 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002634 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002635 */
2636 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002637 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002638
2639 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002640 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2641 * <ul>
2642 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2643 * </ul>
2644 *
2645 * <p class="note">This is a protected intent that can only be sent
2646 * by the system.
2647 *
2648 * @hide
2649 */
2650 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2651 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2652 = "android.intent.action.ADVANCED_SETTINGS";
2653
2654 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002655 * Broadcast Action: Sent after application restrictions are changed.
2656 *
2657 * <p class="note">This is a protected intent that can only be sent
2658 * by the system.</p>
2659 */
2660 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2661 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2662 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2663
2664 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 * Broadcast Action: An outgoing call is about to be placed.
2666 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002667 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002668 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002669 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002670 * the phone number originally intended to be dialed.</li>
2671 * </ul>
2672 * <p>Once the broadcast is finished, the resultData is used as the actual
2673 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002674 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002675 * outgoing call in turn: for example, a parental control application
2676 * might verify that the user is authorized to place the call at that
2677 * time, then a number-rewriting application might add an area code if
2678 * one was not specified.</p>
2679 * <p>For consistency, any receiver whose purpose is to prohibit phone
2680 * calls should have a priority of 0, to ensure it will see the final
2681 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002682 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002683 * should have a positive priority.
2684 * Negative priorities are reserved for the system for this broadcast;
2685 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002686 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2687 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002688 * <p>Emergency calls cannot be intercepted using this mechanism, and
2689 * other calls cannot be modified to call emergency numbers using this
2690 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002691 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2692 * call to use their own service instead. Those apps should first prevent
2693 * the call from being placed by setting resultData to <code>null</code>
2694 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002695 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002696 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2697 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002698 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002699 * <p class="note">This is a protected intent that can only be sent
2700 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002701 */
2702 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2703 public static final String ACTION_NEW_OUTGOING_CALL =
2704 "android.intent.action.NEW_OUTGOING_CALL";
2705
2706 /**
2707 * Broadcast Action: Have the device reboot. This is only for use by
2708 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002709 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002710 * <p class="note">This is a protected intent that can only be sent
2711 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002712 */
2713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2714 public static final String ACTION_REBOOT =
2715 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002716
Wei Huang97ecc9c2009-05-11 17:44:20 -07002717 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002718 * Broadcast Action: A sticky broadcast for changes in the physical
2719 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002720 *
2721 * <p>The intent will have the following extra values:
2722 * <ul>
2723 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002724 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002725 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002726 * <p>This is intended for monitoring the current physical dock state.
2727 * See {@link android.app.UiModeManager} for the normal API dealing with
2728 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002729 */
2730 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2731 public static final String ACTION_DOCK_EVENT =
2732 "android.intent.action.DOCK_EVENT";
2733
2734 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002735 * Broadcast Action: A broadcast when idle maintenance can be started.
2736 * This means that the user is not interacting with the device and is
2737 * not expected to do so soon. Typical use of the idle maintenance is
2738 * to perform somehow expensive tasks that can be postponed at a moment
2739 * when they will not degrade user experience.
2740 * <p>
2741 * <p class="note">In order to keep the device responsive in case of an
2742 * unexpected user interaction, implementations of a maintenance task
2743 * should be interruptible. In such a scenario a broadcast with action
2744 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2745 * should not do the maintenance work in
2746 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2747 * maintenance service by {@link Context#startService(Intent)}. Also
2748 * you should hold a wake lock while your maintenance service is running
2749 * to prevent the device going to sleep.
2750 * </p>
2751 * <p>
2752 * <p class="note">This is a protected intent that can only be sent by
2753 * the system.
2754 * </p>
2755 *
2756 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002757 *
2758 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002759 */
2760 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2761 public static final String ACTION_IDLE_MAINTENANCE_START =
2762 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2763
2764 /**
2765 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2766 * This means that the user was not interacting with the device as a result
2767 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2768 * was sent and now the user started interacting with the device. Typical
2769 * use of the idle maintenance is to perform somehow expensive tasks that
2770 * can be postponed at a moment when they will not degrade user experience.
2771 * <p>
2772 * <p class="note">In order to keep the device responsive in case of an
2773 * unexpected user interaction, implementations of a maintenance task
2774 * should be interruptible. Hence, on receiving a broadcast with this
2775 * action, the maintenance task should be interrupted as soon as possible.
2776 * In other words, you should not do the maintenance work in
2777 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2778 * maintenance service that was started on receiving of
2779 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2780 * lock you acquired when your maintenance service started.
2781 * </p>
2782 * <p class="note">This is a protected intent that can only be sent
2783 * by the system.
2784 *
2785 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002786 *
2787 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002788 */
2789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2790 public static final String ACTION_IDLE_MAINTENANCE_END =
2791 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2792
2793 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002794 * Broadcast Action: a remote intent is to be broadcasted.
2795 *
2796 * A remote intent is used for remote RPC between devices. The remote intent
2797 * is serialized and sent from one device to another device. The receiving
2798 * device parses the remote intent and broadcasts it. Note that anyone can
2799 * broadcast a remote intent. However, if the intent receiver of the remote intent
2800 * does not trust intent broadcasts from arbitrary intent senders, it should require
2801 * the sender to hold certain permissions so only trusted sender's broadcast will be
2802 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002803 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002804 */
2805 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002806 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002807
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002808 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002809 * Broadcast Action: This is broadcast once when the user is booting after a
2810 * system update. It can be used to perform cleanup or upgrades after a
2811 * system update.
2812 * <p>
2813 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2814 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2815 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2816 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002817 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002818 * @hide
2819 */
2820 public static final String ACTION_PRE_BOOT_COMPLETED =
2821 "android.intent.action.PRE_BOOT_COMPLETED";
2822
Amith Yamasani13593602012-03-22 16:16:17 -07002823 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002824 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002825 * on restricted users. The broadcast intent contains an extra
2826 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2827 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2828 * String[] depending on the restriction type.<p/>
2829 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002830 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2831 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2832 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002833 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2834 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002835 * @see RestrictionEntry
2836 */
2837 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2838 "android.intent.action.GET_RESTRICTION_ENTRIES";
2839
2840 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002841 * Sent the first time a user is starting, to allow system apps to
2842 * perform one time initialization. (This will not be seen by third
2843 * party applications because a newly initialized user does not have any
2844 * third party applications installed for it.) This is sent early in
2845 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002846 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2847 * broadcast, since it is part of a visible user interaction; be as quick
2848 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002849 */
2850 public static final String ACTION_USER_INITIALIZE =
2851 "android.intent.action.USER_INITIALIZE";
2852
2853 /**
2854 * Sent when a user switch is happening, causing the process's user to be
2855 * brought to the foreground. This is only sent to receivers registered
2856 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2857 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002858 * foreground. This is sent as a foreground
2859 * broadcast, since it is part of a visible user interaction; be as quick
2860 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002861 */
2862 public static final String ACTION_USER_FOREGROUND =
2863 "android.intent.action.USER_FOREGROUND";
2864
2865 /**
2866 * Sent when a user switch is happening, causing the process's user to be
2867 * sent to the background. This is only sent to receivers registered
2868 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2869 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002870 * background. This is sent as a foreground
2871 * broadcast, since it is part of a visible user interaction; be as quick
2872 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002873 */
2874 public static final String ACTION_USER_BACKGROUND =
2875 "android.intent.action.USER_BACKGROUND";
2876
2877 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002878 * Broadcast sent to the system when a user is added. Carries an extra
2879 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2880 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002881 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002882 * @hide
2883 */
2884 public static final String ACTION_USER_ADDED =
2885 "android.intent.action.USER_ADDED";
2886
2887 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002888 * Broadcast sent by the system when a user is started. Carries an extra
2889 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002890 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002891 * that has been started. This is sent as a foreground
2892 * broadcast, since it is part of a visible user interaction; be as quick
2893 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002894 * @hide
2895 */
2896 public static final String ACTION_USER_STARTED =
2897 "android.intent.action.USER_STARTED";
2898
2899 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002900 * Broadcast sent when a user is in the process of starting. Carries an extra
2901 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2902 * sent to registered receivers, not manifest receivers. It is sent to all
2903 * users (including the one that is being started). You must hold
2904 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2905 * this broadcast. This is sent as a background broadcast, since
2906 * its result is not part of the primary UX flow; to safely keep track of
2907 * started/stopped state of a user you can use this in conjunction with
2908 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2909 * other user state broadcasts since those are foreground broadcasts so can
2910 * execute in a different order.
2911 * @hide
2912 */
2913 public static final String ACTION_USER_STARTING =
2914 "android.intent.action.USER_STARTING";
2915
2916 /**
2917 * Broadcast sent when a user is going to be stopped. Carries an extra
2918 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2919 * sent to registered receivers, not manifest receivers. It is sent to all
2920 * users (including the one that is being stopped). You must hold
2921 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2922 * this broadcast. The user will not stop until all receivers have
2923 * handled the broadcast. This is sent as a background broadcast, since
2924 * its result is not part of the primary UX flow; to safely keep track of
2925 * started/stopped state of a user you can use this in conjunction with
2926 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2927 * other user state broadcasts since those are foreground broadcasts so can
2928 * execute in a different order.
2929 * @hide
2930 */
2931 public static final String ACTION_USER_STOPPING =
2932 "android.intent.action.USER_STOPPING";
2933
2934 /**
2935 * Broadcast sent to the system when a user is stopped. Carries an extra
2936 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2937 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2938 * specific package. This is only sent to registered receivers, not manifest
2939 * receivers. It is sent to all running users <em>except</em> the one that
2940 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002941 * @hide
2942 */
2943 public static final String ACTION_USER_STOPPED =
2944 "android.intent.action.USER_STOPPED";
2945
2946 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002947 * 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 -07002948 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002949 * one that has been removed. The user will not be completely removed until all receivers have
2950 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002951 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002952 * @hide
2953 */
2954 public static final String ACTION_USER_REMOVED =
2955 "android.intent.action.USER_REMOVED";
2956
2957 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002958 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002959 * the userHandle of the user to become the current one. This is only sent to
2960 * registered receivers, not manifest receivers. It is sent to all running users.
2961 * You must hold
2962 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002963 * @hide
2964 */
2965 public static final String ACTION_USER_SWITCHED =
2966 "android.intent.action.USER_SWITCHED";
2967
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002968 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002969 * Broadcast Action: Sent when the credential-encrypted private storage has
2970 * become unlocked for the target user. This is only sent to registered
2971 * receivers, not manifest receivers.
2972 */
2973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2974 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2975
2976 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002977 * Broadcast sent to the system when a user's information changes. Carries an extra
2978 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002979 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002980 * @hide
2981 */
2982 public static final String ACTION_USER_INFO_CHANGED =
2983 "android.intent.action.USER_INFO_CHANGED";
2984
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002985 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002986 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2987 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002988 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2989 * that need to display merged content across both primary and managed profiles need to
2990 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002991 * not manifest receivers.
2992 */
2993 public static final String ACTION_MANAGED_PROFILE_ADDED =
2994 "android.intent.action.MANAGED_PROFILE_ADDED";
2995
2996 /**
2997 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002998 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2999 * Only applications (for example Launchers) that need to display merged content across both
3000 * primary and managed profiles need to worry about this broadcast. This is only sent to
3001 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003002 */
3003 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3004 "android.intent.action.MANAGED_PROFILE_REMOVED";
3005
3006 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003007 * Broadcast sent to the primary user when the credential-encrypted private storage for
3008 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3009 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3010 * Launchers) that need to display merged content across both primary and managed profiles
3011 * need to worry about this broadcast. This is only sent to registered receivers,
3012 * not manifest receivers.
3013 */
3014 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3015 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3016
3017 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003018 * Broadcast sent to the primary user when an associated managed profile has become available.
3019 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003020 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3021 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3022 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003023 */
Rubin Xue95057a2016-04-01 16:49:25 +01003024 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3025 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3026
3027 /**
3028 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3029 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3030 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3031 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3032 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3033 */
3034 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3035 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003036
3037 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003038 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3039 */
3040 public static final String ACTION_QUICK_CLOCK =
3041 "android.intent.action.QUICK_CLOCK";
3042
Michael Wright0087a142013-02-05 16:29:39 -08003043 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003044 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003045 * @hide
3046 */
3047 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3048 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3049
Justin Kohd378ad72013-04-01 12:18:26 -07003050 /**
3051 * Broadcast Action: A global button was pressed. Includes a single
3052 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3053 * caused the broadcast.
3054 * @hide
3055 */
3056 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3057
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003058 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003059 * Broadcast Action: Sent when media resource is granted.
3060 * <p>
3061 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3062 * granted.
3063 * </p>
3064 * <p class="note">
3065 * This is a protected intent that can only be sent by the system.
3066 * </p>
3067 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003068 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003069 * </p>
3070 *
3071 * @hide
3072 */
3073 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3074 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3075
3076 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003077 * Activity Action: Allow the user to select and return one or more existing
3078 * documents. When invoked, the system will display the various
3079 * {@link DocumentsProvider} instances installed on the device, letting the
3080 * user interactively navigate through them. These documents include local
3081 * media, such as photos and video, and documents provided by installed
3082 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003083 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003084 * Each document is represented as a {@code content://} URI backed by a
3085 * {@link DocumentsProvider}, which can be opened as a stream with
3086 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3087 * {@link android.provider.DocumentsContract.Document} metadata.
3088 * <p>
3089 * All selected documents are returned to the calling application with
3090 * persistable read and write permission grants. If you want to maintain
3091 * access to the documents across device reboots, you need to explicitly
3092 * take the persistable permissions using
3093 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3094 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003095 * Callers must indicate the acceptable document MIME types through
3096 * {@link #setType(String)}. For example, to select photos, use
3097 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3098 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3099 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003100 * <p>
3101 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003102 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3103 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003104 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003105 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3106 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003107 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003108 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003109 * Output: The URI of the item that was picked, returned in
3110 * {@link #getData()}. This must be a {@code content://} URI so that any
3111 * receiver can access it. If multiple documents were selected, they are
3112 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003113 *
3114 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003115 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003116 * @see #ACTION_CREATE_DOCUMENT
3117 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003118 */
3119 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3120 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3121
3122 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003123 * Activity Action: Allow the user to create a new document. When invoked,
3124 * the system will display the various {@link DocumentsProvider} instances
3125 * installed on the device, letting the user navigate through them. The
3126 * returned document may be a newly created document with no content, or it
3127 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003128 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003129 * Each document is represented as a {@code content://} URI backed by a
3130 * {@link DocumentsProvider}, which can be opened as a stream with
3131 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3132 * {@link android.provider.DocumentsContract.Document} metadata.
3133 * <p>
3134 * Callers must indicate the concrete MIME type of the document being
3135 * created by setting {@link #setType(String)}. This MIME type cannot be
3136 * changed after the document is created.
3137 * <p>
3138 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3139 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003140 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003141 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3142 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003143 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003144 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003145 * Output: The URI of the item that was created. This must be a
3146 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003147 *
3148 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003149 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003150 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003151 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003152 */
3153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3154 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3155
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003156 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003157 * Activity Action: Allow the user to pick a directory subtree. When
3158 * invoked, the system will display the various {@link DocumentsProvider}
3159 * instances installed on the device, letting the user navigate through
3160 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003161 * <p>
3162 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003163 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3164 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3165 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003166 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003167 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003168 *
3169 * @see DocumentsContract
3170 */
3171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003172 public static final String
3173 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003174
Felipe Lemec7b1f892016-01-15 15:02:31 -08003175 /**
Peng Xua35b5532016-01-20 00:05:45 -08003176 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3177 * exisiting sensor being disconnected.
3178 *
3179 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3180 *
3181 * {@hide}
3182 */
3183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3184 public static final String
3185 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3186
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003187 /** {@hide} */
3188 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3189
Christopher Tate6597e342015-02-17 12:15:25 -08003190 /**
Benjamin Franzf9d5e6a2016-05-26 14:24:29 +01003191 * Boolean intent extra to be used with {@link ACTION_MASTER_CLEAR} in order to force a factory
3192 * reset even if {@link android.os.UserManager.DISALLOW_FACTORY_RESET} is set.
3193 * @hide
3194 */
3195 public static final String EXTRA_FORCE_MASTER_CLEAR =
3196 "android.intent.extra.FORCE_MASTER_CLEAR";
3197
3198 /**
Christopher Tate6597e342015-02-17 12:15:25 -08003199 * Broadcast action: report that a settings element is being restored from backup. The intent
3200 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3201 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3202 * is the value of that settings entry prior to the restore operation. All of these values are
3203 * represented as strings.
3204 *
3205 * <p>This broadcast is sent only for settings provider entries known to require special handling
3206 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3207 * the provider's backup agent implementation.
3208 *
3209 * @see #EXTRA_SETTING_NAME
3210 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3211 * @see #EXTRA_SETTING_NEW_VALUE
3212 * {@hide}
3213 */
3214 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3215
3216 /** {@hide} */
3217 public static final String EXTRA_SETTING_NAME = "setting_name";
3218 /** {@hide} */
3219 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3220 /** {@hide} */
3221 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3222
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003223 /**
3224 * Activity Action: Process a piece of text.
3225 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3226 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3227 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3228 */
3229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3230 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3231 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003232 * The name of the extra used to define the text to be processed, as a
3233 * CharSequence. Note that this may be a styled CharSequence, so you must use
3234 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003235 */
3236 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3237 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003238 * 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 +00003239 */
3240 public static final String EXTRA_PROCESS_TEXT_READONLY =
3241 "android.intent.extra.PROCESS_TEXT_READONLY";
3242
Bryce Leebc58f592015-09-25 16:43:01 -07003243 /**
3244 * Broadcast action: reports when a new thermal event has been reached. When the device
3245 * is reaching its maximum temperatue, the thermal level reported
3246 * {@hide}
3247 */
3248 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3249 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3250
3251 /** {@hide} */
3252 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3253
3254 /**
3255 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003256 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003257 * {@hide}
3258 */
3259 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3260
3261 /**
3262 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003263 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003264 * {@hide}
3265 */
3266 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3267
3268 /**
3269 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003270 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003271 * {@hide}
3272 */
3273 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3274
3275
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003276 // ---------------------------------------------------------------------
3277 // ---------------------------------------------------------------------
3278 // Standard intent categories (see addCategory()).
3279
3280 /**
3281 * Set if the activity should be an option for the default action
3282 * (center press) to perform on a piece of data. Setting this will
3283 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003284 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003285 * Intent when initiating an action -- it is for use in intent filters
3286 * specified in packages.
3287 */
3288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3289 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3290 /**
3291 * Activities that can be safely invoked from a browser must support this
3292 * category. For example, if the user is viewing a web page or an e-mail
3293 * and clicks on a link in the text, the Intent generated execute that
3294 * link will require the BROWSABLE category, so that only activities
3295 * supporting this category will be considered as possible actions. By
3296 * supporting this category, you are promising that there is nothing
3297 * damaging (without user intervention) that can happen by invoking any
3298 * matching Intent.
3299 */
3300 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3301 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3302 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003303 * Categories for activities that can participate in voice interaction.
3304 * An activity that supports this category must be prepared to run with
3305 * no UI shown at all (though in some case it may have a UI shown), and
3306 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3307 */
3308 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3309 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3310 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003311 * Set if the activity should be considered as an alternative action to
3312 * the data the user is currently viewing. See also
3313 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3314 * applies to the selection in a list of items.
3315 *
3316 * <p>Supporting this category means that you would like your activity to be
3317 * displayed in the set of alternative things the user can do, usually as
3318 * part of the current activity's options menu. You will usually want to
3319 * include a specific label in the &lt;intent-filter&gt; of this action
3320 * describing to the user what it does.
3321 *
3322 * <p>The action of IntentFilter with this category is important in that it
3323 * describes the specific action the target will perform. This generally
3324 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3325 * a specific name such as "com.android.camera.action.CROP. Only one
3326 * alternative of any particular action will be shown to the user, so using
3327 * a specific action like this makes sure that your alternative will be
3328 * displayed while also allowing other applications to provide their own
3329 * overrides of that particular action.
3330 */
3331 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3332 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3333 /**
3334 * Set if the activity should be considered as an alternative selection
3335 * action to the data the user has currently selected. This is like
3336 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3337 * of items from which the user can select, giving them alternatives to the
3338 * default action that will be performed on it.
3339 */
3340 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3341 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3342 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003343 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003344 */
3345 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3346 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3347 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003348 * Should be displayed in the top-level launcher.
3349 */
3350 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3351 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3352 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003353 * Indicates an activity optimized for Leanback mode, and that should
3354 * be displayed in the Leanback launcher.
3355 */
3356 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3357 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3358 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003359 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3360 * @hide
3361 */
3362 @SystemApi
3363 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3364 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003365 * Provides information about the package it is in; typically used if
3366 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3367 * a front-door to the user without having to be shown in the all apps list.
3368 */
3369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3370 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3371 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003372 * This is the home activity, that is the first activity that is displayed
3373 * when the device boots.
3374 */
3375 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3376 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3377 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003378 * This is the home activity that is displayed when the device is finished setting up and ready
3379 * for use.
3380 * @hide
3381 */
3382 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3383 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3384 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003385 * This is the setup wizard activity, that is the first activity that is displayed
3386 * when the user sets up the device for the first time.
3387 * @hide
3388 */
3389 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3390 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3391 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003392 * This activity is a preference panel.
3393 */
3394 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3395 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3396 /**
3397 * This activity is a development preference panel.
3398 */
3399 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3400 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3401 /**
3402 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003403 */
3404 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3405 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3406 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003407 * This activity allows the user to browse and download new applications.
3408 */
3409 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3410 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3411 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003412 * This activity may be exercised by the monkey or other automated test tools.
3413 */
3414 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3415 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3416 /**
3417 * To be used as a test (not part of the normal user experience).
3418 */
3419 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3420 /**
3421 * To be used as a unit test (run through the Test Harness).
3422 */
3423 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3424 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003425 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003426 * experience).
3427 */
3428 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003429
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003430 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003431 * Used to indicate that an intent only wants URIs that can be opened with
3432 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3433 * must support at least the columns defined in {@link OpenableColumns} when
3434 * queried.
3435 *
3436 * @see #ACTION_GET_CONTENT
3437 * @see #ACTION_OPEN_DOCUMENT
3438 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003439 */
3440 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3441 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3442
3443 /**
3444 * To be used as code under test for framework instrumentation tests.
3445 */
3446 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3447 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003448 /**
3449 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003450 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3451 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003452 */
3453 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3454 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3455 /**
3456 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003457 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3458 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003459 */
3460 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3461 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003462 /**
3463 * An activity to run when device is inserted into a analog (low end) dock.
3464 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3465 * information, see {@link android.app.UiModeManager}.
3466 */
3467 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3468 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3469
3470 /**
3471 * An activity to run when device is inserted into a digital (high end) dock.
3472 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3473 * information, see {@link android.app.UiModeManager}.
3474 */
3475 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3476 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003477
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003478 /**
3479 * Used to indicate that the activity can be used in a car environment.
3480 */
3481 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3482 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3483
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003484 // ---------------------------------------------------------------------
3485 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003486 // Application launch intent categories (see addCategory()).
3487
3488 /**
3489 * Used with {@link #ACTION_MAIN} to launch the browser application.
3490 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003491 * <p>NOTE: This should not be used as the primary key of an Intent,
3492 * since it will not result in the app launching with the correct
3493 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003494 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003495 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003496 */
3497 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3498 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3499
3500 /**
3501 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3502 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003503 * <p>NOTE: This should not be used as the primary key of an Intent,
3504 * since it will not result in the app launching with the correct
3505 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003506 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003507 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003508 */
3509 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3510 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3511
3512 /**
3513 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3514 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003515 * <p>NOTE: This should not be used as the primary key of an Intent,
3516 * since it will not result in the app launching with the correct
3517 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003518 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003519 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003520 */
3521 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3522 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3523
3524 /**
3525 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3526 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003527 * <p>NOTE: This should not be used as the primary key of an Intent,
3528 * since it will not result in the app launching with the correct
3529 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003530 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003531 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003532 */
3533 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3534 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3535
3536 /**
3537 * Used with {@link #ACTION_MAIN} to launch the email application.
3538 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003539 * <p>NOTE: This should not be used as the primary key of an Intent,
3540 * since it will not result in the app launching with the correct
3541 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003542 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003543 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003544 */
3545 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3546 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3547
3548 /**
3549 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3550 * The activity should be able to view and manipulate image and video files
3551 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003552 * <p>NOTE: This should not be used as the primary key of an Intent,
3553 * since it will not result in the app launching with the correct
3554 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003555 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003556 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003557 */
3558 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3559 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3560
3561 /**
3562 * Used with {@link #ACTION_MAIN} to launch the maps application.
3563 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003564 * <p>NOTE: This should not be used as the primary key of an Intent,
3565 * since it will not result in the app launching with the correct
3566 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003567 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003568 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003569 */
3570 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3571 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3572
3573 /**
3574 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3575 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003576 * <p>NOTE: This should not be used as the primary key of an Intent,
3577 * since it will not result in the app launching with the correct
3578 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003579 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003580 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003581 */
3582 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3583 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3584
3585 /**
3586 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003587 * The activity should be able to play, browse, or manipulate music files
3588 * stored on the device.
3589 * <p>NOTE: This should not be used as the primary key of an Intent,
3590 * since it will not result in the app launching with the correct
3591 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003592 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003593 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003594 */
3595 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3596 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3597
3598 // ---------------------------------------------------------------------
3599 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003600 // Standard extra data keys.
3601
3602 /**
3603 * The initial data to place in a newly created record. Use with
3604 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3605 * fields as would be given to the underlying ContentProvider.insert()
3606 * call.
3607 */
3608 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3609
3610 /**
3611 * A constant CharSequence that is associated with the Intent, used with
3612 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3613 * this may be a styled CharSequence, so you must use
3614 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3615 * retrieve it.
3616 */
3617 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3618
3619 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003620 * A constant String that is associated with the Intent, used with
3621 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3622 * as HTML formatted text. Note that you <em>must</em> also supply
3623 * {@link #EXTRA_TEXT}.
3624 */
3625 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3626
3627 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628 * A content: URI holding a stream of data associated with the Intent,
3629 * used with {@link #ACTION_SEND} to supply the data being sent.
3630 */
3631 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3632
3633 /**
3634 * A String[] holding e-mail addresses that should be delivered to.
3635 */
3636 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3637
3638 /**
3639 * A String[] holding e-mail addresses that should be carbon copied.
3640 */
3641 public static final String EXTRA_CC = "android.intent.extra.CC";
3642
3643 /**
3644 * A String[] holding e-mail addresses that should be blind carbon copied.
3645 */
3646 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3647
3648 /**
3649 * A constant string holding the desired subject line of a message.
3650 */
3651 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3652
3653 /**
3654 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003655 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003656 */
3657 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3658
3659 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003660 * An int representing the user id to be used.
3661 *
3662 * @hide
3663 */
3664 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3665
3666 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003667 * An int representing the task id to be retrieved. This is used when a launch from recents is
3668 * intercepted by another action such as credentials confirmation to remember which task should
3669 * be resumed when complete.
3670 *
3671 * @hide
3672 */
3673 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3674
3675 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003676 * An Intent[] describing additional, alternate choices you would like shown with
3677 * {@link #ACTION_CHOOSER}.
3678 *
3679 * <p>An app may be capable of providing several different payload types to complete a
3680 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3681 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3682 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3683 * photo data or a hosted link where the photos can be viewed.</p>
3684 *
3685 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3686 * first/primary/preferred intent in the set. Additional intents specified in
3687 * this extra are ordered; by default intents that appear earlier in the array will be
3688 * preferred over intents that appear later in the array as matches for the same
3689 * target component. To alter this preference, a calling app may also supply
3690 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3691 */
3692 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3693
3694 /**
Adam Powell52c39212016-04-07 15:14:18 -07003695 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3696 * and omitted from a list of components presented to the user.
3697 *
3698 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3699 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3700 * from your own package or other apps from your organization if the idea of sending to those
3701 * targets would be redundant with other app functionality. Filtered components will not
3702 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3703 */
3704 public static final String EXTRA_EXCLUDE_COMPONENTS
3705 = "android.intent.extra.EXCLUDE_COMPONENTS";
3706
3707 /**
3708 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3709 * describing additional high-priority deep-link targets for the chooser to present to the user.
3710 *
3711 * <p>Targets provided in this way will be presented inline with all other targets provided
3712 * by services from other apps. They will be prioritized before other service targets, but
3713 * after those targets provided by sources that the user has manually pinned to the front.</p>
3714 *
3715 * @see #ACTION_CHOOSER
3716 */
3717 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3718
3719 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003720 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3721 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3722 *
3723 * <p>An app preparing an action for another app to complete may wish to allow the user to
3724 * disambiguate between several options for completing the action based on the chosen target
3725 * or otherwise refine the action before it is invoked.
3726 * </p>
3727 *
3728 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3729 * <ul>
3730 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3731 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3732 * chosen target beyond the first</li>
3733 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3734 * should fill in and send once the disambiguation is complete</li>
3735 * </ul>
3736 */
3737 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3738 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3739
3740 /**
3741 * A {@link ResultReceiver} used to return data back to the sender.
3742 *
3743 * <p>Used to complete an app-specific
3744 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3745 *
3746 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3747 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3748 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3749 * when the user selects a target component from the chooser. It is up to the recipient
3750 * to send a result to this ResultReceiver to signal that disambiguation is complete
3751 * and that the chooser should invoke the user's choice.</p>
3752 *
3753 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3754 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3755 * to match and fill in the final Intent or ChooserTarget before starting it.
3756 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3757 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3758 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3759 *
3760 * <p>The result code passed to the ResultReceiver should be
3761 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3762 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3763 * the chooser should finish without starting a target.</p>
3764 */
3765 public static final String EXTRA_RESULT_RECEIVER
3766 = "android.intent.extra.RESULT_RECEIVER";
3767
3768 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003769 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003770 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003771 */
3772 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3773
3774 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003775 * A Parcelable[] of {@link Intent} or
3776 * {@link android.content.pm.LabeledIntent} objects as set with
3777 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3778 * a the front of the list of choices, when shown to the user with a
3779 * {@link #ACTION_CHOOSER}.
3780 */
3781 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3782
3783 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003784 * A {@link IntentSender} to start after ephemeral installation success.
3785 * @hide
3786 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003787 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3788
3789 /**
3790 * A {@link IntentSender} to start after ephemeral installation failure.
3791 * @hide
3792 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003793 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3794
3795 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003796 * A Bundle forming a mapping of potential target package names to different extras Bundles
3797 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3798 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3799 * be currently installed on the device.
3800 *
3801 * <p>An application may choose to provide alternate extras for the case where a user
3802 * selects an activity from a predetermined set of target packages. If the activity
3803 * the user selects from the chooser belongs to a package with its package name as
3804 * a key in this bundle, the corresponding extras for that package will be merged with
3805 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3806 * extra has the same key as an extra already present in the intent it will overwrite
3807 * the extra from the intent.</p>
3808 *
3809 * <p><em>Examples:</em>
3810 * <ul>
3811 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3812 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3813 * parameters for that target.</li>
3814 * <li>An application may offer additional metadata for known targets of a given intent
3815 * to pass along information only relevant to that target such as account or content
3816 * identifiers already known to that application.</li>
3817 * </ul></p>
3818 */
3819 public static final String EXTRA_REPLACEMENT_EXTRAS =
3820 "android.intent.extra.REPLACEMENT_EXTRAS";
3821
3822 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003823 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3824 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3825 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3826 * {@link ComponentName} of the chosen component.
3827 *
3828 * <p>In some situations this callback may never come, for example if the user abandons
3829 * the chooser, switches to another task or any number of other reasons. Apps should not
3830 * be written assuming that this callback will always occur.</p>
3831 */
3832 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3833 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3834
3835 /**
3836 * The {@link ComponentName} chosen by the user to complete an action.
3837 *
3838 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3839 */
3840 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3841
3842 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003843 * A {@link android.view.KeyEvent} object containing the event that
3844 * triggered the creation of the Intent it is in.
3845 */
3846 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3847
3848 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003849 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3850 * before shutting down.
3851 *
3852 * {@hide}
3853 */
3854 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3855
3856 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003857 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3858 * requested by the user.
3859 *
3860 * {@hide}
3861 */
3862 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3863 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3864
3865 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003866 * 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 -07003867 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3868 * of restarting the application.
3869 */
3870 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3871
3872 /**
3873 * A String holding the phone number originally entered in
3874 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3875 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3876 */
3877 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003879 /**
3880 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3881 * intents to supply the uid the package had been assigned. Also an optional
3882 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3883 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3884 * purpose.
3885 */
3886 public static final String EXTRA_UID = "android.intent.extra.UID";
3887
3888 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003889 * @hide String array of package names.
3890 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003891 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003892 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3893
3894 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003895 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3896 * intents to indicate whether this represents a full uninstall (removing
3897 * both the code and its data) or a partial uninstall (leaving its data,
3898 * implying that this is an update).
3899 */
3900 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003901
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003902 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003903 * @hide
3904 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3905 * intents to indicate that at this point the package has been removed for
3906 * all users on the device.
3907 */
3908 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3909 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3910
3911 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003912 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3913 * intents to indicate that this is a replacement of the package, so this
3914 * broadcast will immediately be followed by an add broadcast for a
3915 * different version of the same package.
3916 */
3917 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003918
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003919 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003920 * Used as an int extra field in {@link android.app.AlarmManager} intents
3921 * to tell the application being invoked how many pending alarms are being
3922 * delievered with the intent. For one-shot alarms this will always be 1.
3923 * For recurring alarms, this might be greater than 1 if the device was
3924 * asleep or powered off at the time an earlier alarm would have been
3925 * delivered.
3926 */
3927 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003928
Jacek Surazski86b6c532009-05-13 14:38:28 +02003929 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003930 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3931 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003932 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3933 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003934 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3935 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3936 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003937 */
3938 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3939
3940 /**
3941 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3942 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003943 */
3944 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3945
3946 /**
3947 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3948 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003949 */
3950 public static final int EXTRA_DOCK_STATE_DESK = 1;
3951
3952 /**
3953 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3954 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003955 */
3956 public static final int EXTRA_DOCK_STATE_CAR = 2;
3957
3958 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003959 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3960 * to represent that the phone is in a analog (low end) dock.
3961 */
3962 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3963
3964 /**
3965 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3966 * to represent that the phone is in a digital (high end) dock.
3967 */
3968 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3969
3970 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003971 * Boolean that can be supplied as meta-data with a dock activity, to
3972 * indicate that the dock should take over the home key when it is active.
3973 */
3974 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003975
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003976 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003977 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3978 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003979 */
3980 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3981
3982 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003983 * Used in the extra field in the remote intent. It's astring token passed with the
3984 * remote intent.
3985 */
3986 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3987 "android.intent.extra.remote_intent_token";
3988
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003989 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003990 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003991 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003992 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003993 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003994 "android.intent.extra.changed_component_name";
3995
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003996 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003997 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003998 * and contains a string array of all of the components that have changed. If
3999 * the state of the overall package has changed, then it will contain an entry
4000 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004001 */
4002 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4003 "android.intent.extra.changed_component_name_list";
4004
4005 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004006 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004007 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004008 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4009 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4010 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004011 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004012 */
4013 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4014 "android.intent.extra.changed_package_list";
4015
4016 /**
4017 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004018 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4019 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004020 * and contains an integer array of uids of all of the components
4021 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004022 */
4023 public static final String EXTRA_CHANGED_UID_LIST =
4024 "android.intent.extra.changed_uid_list";
4025
4026 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004027 * @hide
4028 * Magic extra system code can use when binding, to give a label for
4029 * who it is that has bound to a service. This is an integer giving
4030 * a framework string resource that can be displayed to the user.
4031 */
4032 public static final String EXTRA_CLIENT_LABEL =
4033 "android.intent.extra.client_label";
4034
4035 /**
4036 * @hide
4037 * Magic extra system code can use when binding, to give a PendingIntent object
4038 * that can be launched for the user to disable the system's use of this
4039 * service.
4040 */
4041 public static final String EXTRA_CLIENT_INTENT =
4042 "android.intent.extra.client_intent";
4043
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004044 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004045 * Extra used to indicate that an intent should only return data that is on
4046 * the local device. This is a boolean extra; the default is false. If true,
4047 * an implementation should only allow the user to select data that is
4048 * already on the device, not requiring it be downloaded from a remote
4049 * service when opened.
4050 *
4051 * @see #ACTION_GET_CONTENT
4052 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004053 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004054 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004055 */
4056 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004057 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004058
Amith Yamasani13593602012-03-22 16:16:17 -07004059 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004060 * Extra used to indicate that an intent can allow the user to select and
4061 * return multiple items. This is a boolean extra; the default is false. If
4062 * true, an implementation is allowed to present the user with a UI where
4063 * they can pick multiple items that are all returned to the caller. When
4064 * this happens, they should be returned as the {@link #getClipData()} part
4065 * of the result Intent.
4066 *
4067 * @see #ACTION_GET_CONTENT
4068 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004069 */
4070 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004071 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004072
4073 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004074 * The integer userHandle carried with broadcast intents related to addition, removal and
4075 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4076 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4077 *
Amith Yamasani13593602012-03-22 16:16:17 -07004078 * @hide
4079 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004080 public static final String EXTRA_USER_HANDLE =
4081 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004082
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004083 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004084 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4085 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4086 */
4087 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004088 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004089
4090 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004091 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004092 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4093 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004094 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004095 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4096
4097 /**
4098 * Extra sent in the intent to the BroadcastReceiver that handles
4099 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4100 * the restrictions as key/value pairs.
4101 */
4102 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4103 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004104
Amith Yamasani86118ba2013-03-28 14:33:16 -07004105 /**
4106 * Extra used in the response from a BroadcastReceiver that handles
4107 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4108 */
4109 public static final String EXTRA_RESTRICTIONS_INTENT =
4110 "android.intent.extra.restrictions_intent";
4111
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004112 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004113 * Extra used to communicate a set of acceptable MIME types. The type of the
4114 * extra is {@code String[]}. Values may be a combination of concrete MIME
4115 * types (such as "image/png") and/or partial MIME types (such as
4116 * "audio/*").
4117 *
4118 * @see #ACTION_GET_CONTENT
4119 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004120 */
4121 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4122
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004123 /**
4124 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4125 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004126 * When this is true, hardware devices can use this information to determine that
4127 * they shouldn't do a complete shutdown of their device since this is not a
4128 * complete shutdown down to the kernel, but only user space restarting.
4129 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004130 */
4131 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4132 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4133
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004134 /**
4135 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4136 * user has set their time format preferences to the 24 hour format.
4137 *
4138 * @hide for internal use only.
4139 */
4140 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4141 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4142
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004143 /** {@hide} */
4144 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4145
Rubin Xue8490f12015-06-25 12:17:48 +01004146 /** {@hide} */
4147 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4148
Santos Cordon15a13782015-03-31 18:32:31 -07004149 /**
4150 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4151 * activation request.
4152 * TODO: Add information about the structure and response data used with the pending intent.
4153 * @hide
4154 */
4155 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4156 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4157
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004158 /**
4159 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004160 *
4161 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004162 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004163 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4164
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004165 /**
4166 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004167 * When a profile goes into quiet mode, all apps in the profile are killed and the
4168 * profile user is stopped. Widgets originating from the profile are masked, and app
4169 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004170 */
4171 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004172
4173 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004174 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004175 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004176 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4177 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004178 *
4179 * @hide
4180 */
4181 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4182 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4183
4184 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004185 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004186 * to represent that a video codec is allowed to use.
4187 *
4188 * @hide
4189 */
4190 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4191
4192 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004193 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004194 * to represent that a audio codec is allowed to use.
4195 *
4196 * @hide
4197 */
4198 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4199
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004200 // ---------------------------------------------------------------------
4201 // ---------------------------------------------------------------------
4202 // Intent flags (see mFlags variable).
4203
Tor Norbyed9273d62013-05-30 15:59:53 -07004204 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004205 @IntDef(flag = true, value = {
4206 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4207 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004208 @Retention(RetentionPolicy.SOURCE)
4209 public @interface GrantUriMode {}
4210
Jeff Sharkey846318a2014-04-04 12:12:41 -07004211 /** @hide */
4212 @IntDef(flag = true, value = {
4213 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4214 @Retention(RetentionPolicy.SOURCE)
4215 public @interface AccessUriMode {}
4216
4217 /**
4218 * Test if given mode flags specify an access mode, which must be at least
4219 * read and/or write.
4220 *
4221 * @hide
4222 */
4223 public static boolean isAccessUriMode(int modeFlags) {
4224 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4225 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4226 }
4227
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004228 /**
4229 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004230 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004231 * specified in its ClipData. When applying to an Intent's ClipData,
4232 * all URIs as well as recursive traversals through data or other ClipData
4233 * in Intent items will be granted; only the grant flags of the top-level
4234 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004235 */
4236 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4237 /**
4238 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004239 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004240 * specified in its ClipData. When applying to an Intent's ClipData,
4241 * all URIs as well as recursive traversals through data or other ClipData
4242 * in Intent items will be granted; only the grant flags of the top-level
4243 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004244 */
4245 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4246 /**
4247 * Can be set by the caller to indicate that this Intent is coming from
4248 * a background operation, not from direct user interaction.
4249 */
4250 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4251 /**
4252 * A flag you can enable for debugging: when set, log messages will be
4253 * printed during the resolution of this intent to show you what has
4254 * been found to create the final resolved list.
4255 */
4256 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004257 /**
4258 * If set, this intent will not match any components in packages that
4259 * are currently stopped. If this is not set, then the default behavior
4260 * is to include such applications in the result.
4261 */
4262 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4263 /**
4264 * If set, this intent will always match any components in packages that
4265 * are currently stopped. This is the default behavior when
4266 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4267 * flags are set, this one wins (it allows overriding of exclude for
4268 * places where the framework may automatically set the exclude flag).
4269 */
4270 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004271
4272 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004273 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004274 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004275 * persisted across device reboots until explicitly revoked with
4276 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4277 * grant for possible persisting; the receiving application must call
4278 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4279 * actually persist.
4280 *
4281 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4282 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4283 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004284 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004285 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004286 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004287
4288 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004289 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4290 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4291 * applies to any URI that is a prefix match against the original granted
4292 * URI. (Without this flag, the URI must match exactly for access to be
4293 * granted.) Another URI is considered a prefix match only when scheme,
4294 * authority, and all path segments defined by the prefix are an exact
4295 * match.
4296 */
4297 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4298
4299 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004300 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004301 * homework and verified that they correctly handle packages and components
4302 * that come and go over time. In particular:
4303 * <ul>
4304 * <li>Apps installed on external storage, which will appear to be
4305 * uninstalled while the the device is ejected.
4306 * <li>Apps with encryption unaware components, which will appear to not
4307 * exist while the device is locked.
4308 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004309 *
4310 * @hide
4311 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004312 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004313
4314 /**
Todd Kennedyfea1b772016-06-28 14:09:55 -07004315 * Internal flag used to indicate ephemeral applications should not be
4316 * considered when resolving the intent.
4317 *
4318 * @hide
4319 */
4320 public static final int FLAG_IGNORE_EPHEMERAL = 0x00000200;
4321
4322 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004323 * If set, the new activity is not kept in the history stack. As soon as
4324 * the user navigates away from it, the activity is finished. This may also
4325 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4326 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004327 *
4328 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4329 * is never invoked when the current activity starts a new activity which
4330 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331 */
4332 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4333 /**
4334 * If set, the activity will not be launched if it is already running
4335 * at the top of the history stack.
4336 */
4337 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4338 /**
4339 * If set, this activity will become the start of a new task on this
4340 * history stack. A task (from the activity that started it to the
4341 * next task activity) defines an atomic group of activities that the
4342 * user can move to. Tasks can be moved to the foreground and background;
4343 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004344 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004345 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4346 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004347 *
4348 * <p>This flag is generally used by activities that want
4349 * to present a "launcher" style behavior: they give the user a list of
4350 * separate things that can be done, which otherwise run completely
4351 * independently of the activity launching them.
4352 *
4353 * <p>When using this flag, if a task is already running for the activity
4354 * you are now starting, then a new activity will not be started; instead,
4355 * the current task will simply be brought to the front of the screen with
4356 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4357 * to disable this behavior.
4358 *
4359 * <p>This flag can not be used when the caller is requesting a result from
4360 * the activity being launched.
4361 */
4362 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4363 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004364 * This flag is used to create a new task and launch an activity into it.
4365 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4366 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4367 * search through existing tasks for ones matching this Intent. Only if no such
4368 * task is found would a new task be created. When paired with
4369 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4370 * the search for a matching task and unconditionally start a new task.
4371 *
4372 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4373 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004374 * top-level application launcher.</strong> Used in conjunction with
4375 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4376 * behavior of bringing an existing task to the foreground. When set,
4377 * a new task is <em>always</em> started to host the Activity for the
4378 * Intent, regardless of whether there is already an existing task running
4379 * the same thing.
4380 *
4381 * <p><strong>Because the default system does not include graphical task management,
4382 * you should not use this flag unless you provide some way for a user to
4383 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004384 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004385 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4386 * creating new document tasks.
4387 *
4388 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004389 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004390 *
Scott Main7aee61f2011-02-08 11:25:01 -08004391 * <p>See
4392 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4393 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004394 *
4395 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4396 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004397 */
4398 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4399 /**
4400 * If set, and the activity being launched is already running in the
4401 * current task, then instead of launching a new instance of that activity,
4402 * all of the other activities on top of it will be closed and this Intent
4403 * will be delivered to the (now on top) old activity as a new Intent.
4404 *
4405 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4406 * If D calls startActivity() with an Intent that resolves to the component
4407 * of activity B, then C and D will be finished and B receive the given
4408 * Intent, resulting in the stack now being: A, B.
4409 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004410 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004411 * either receive the new intent you are starting here in its
4412 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004413 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004414 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4415 * the same intent, then it will be finished and re-created; for all other
4416 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4417 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004418 *
4419 * <p>This launch mode can also be used to good effect in conjunction with
4420 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4421 * of a task, it will bring any currently running instance of that task
4422 * to the foreground, and then clear it to its root state. This is
4423 * especially useful, for example, when launching an activity from the
4424 * notification manager.
4425 *
Scott Main7aee61f2011-02-08 11:25:01 -08004426 * <p>See
4427 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4428 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004429 */
4430 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4431 /**
4432 * If set and this intent is being used to launch a new activity from an
4433 * existing one, then the reply target of the existing activity will be
4434 * transfered to the new activity. This way the new activity can call
4435 * {@link android.app.Activity#setResult} and have that result sent back to
4436 * the reply target of the original activity.
4437 */
4438 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4439 /**
4440 * If set and this intent is being used to launch a new activity from an
4441 * existing one, the current activity will not be counted as the top
4442 * activity for deciding whether the new intent should be delivered to
4443 * the top instead of starting a new one. The previous activity will
4444 * be used as the top, with the assumption being that the current activity
4445 * will finish itself immediately.
4446 */
4447 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4448 /**
4449 * If set, the new activity is not kept in the list of recently launched
4450 * activities.
4451 */
4452 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4453 /**
4454 * This flag is not normally set by application code, but set for you by
4455 * the system as described in the
4456 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4457 * launchMode} documentation for the singleTask mode.
4458 */
4459 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4460 /**
4461 * If set, and this activity is either being started in a new task or
4462 * bringing to the top an existing task, then it will be launched as
4463 * the front door of the task. This will result in the application of
4464 * any affinities needed to have that task in the proper state (either
4465 * moving activities to or from it), or simply resetting that task to
4466 * its initial state if needed.
4467 */
4468 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4469 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004470 * This flag is not normally set by application code, but set for you by
4471 * the system if this activity is being launched from history
4472 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004473 */
4474 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004475 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004476 * @deprecated As of API 21 this performs identically to
4477 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004478 */
4479 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004480 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004481 * This flag is used to open a document into a new task rooted at the activity launched
4482 * by this Intent. Through the use of this flag, or its equivalent attribute,
4483 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004484 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004485 *
Craig Mautner026596b2014-05-21 15:35:44 -07004486 * <p>The use of the activity attribute form of this,
4487 * {@link android.R.attr#documentLaunchMode}, is
4488 * preferred over the Intent flag described here. The attribute form allows the
4489 * Activity to specify multiple document behavior for all launchers of the Activity
4490 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004491 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004492 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4493 * it is kept after the activity is finished is different than the use of
4494 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4495 * this flag is being used to create a new recents entry, then by default that entry
4496 * will be removed once the activity is finished. You can modify this behavior with
4497 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4498 *
Craig Mautner026596b2014-05-21 15:35:44 -07004499 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4500 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4501 * equivalent of the Activity manifest specifying {@link
4502 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4503 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4504 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004505 *
Craig Mautner026596b2014-05-21 15:35:44 -07004506 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004507 *
Craig Mautner026596b2014-05-21 15:35:44 -07004508 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004509 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4510 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004511 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004512 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004513 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004514 * callback from occurring on the current frontmost activity before it is
4515 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004516 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004517 * <p>Typically, an activity can rely on that callback to indicate that an
4518 * explicit user action has caused their activity to be moved out of the
4519 * foreground. The callback marks an appropriate point in the activity's
4520 * lifecycle for it to dismiss any notifications that it intends to display
4521 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004522 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004523 * <p>If an activity is ever started via any non-user-driven events such as
4524 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4525 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004526 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004527 */
4528 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004529 /**
4530 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4531 * this flag will cause the launched activity to be brought to the front of its
4532 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004533 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004534 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4535 * If D calls startActivity() with an Intent that resolves to the component
4536 * of activity B, then B will be brought to the front of the history stack,
4537 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004538 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004539 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004540 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004541 */
4542 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004543 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004544 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4545 * this flag will prevent the system from applying an activity transition
4546 * animation to go to the next activity state. This doesn't mean an
4547 * animation will never run -- if another activity change happens that doesn't
4548 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004549 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004550 * when you are going to do a series of activity operations but the
4551 * animation seen by the user shouldn't be driven by the first activity
4552 * change but rather a later one.
4553 */
4554 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4555 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004556 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4557 * this flag will cause any existing task that would be associated with the
4558 * activity to be cleared before the activity is started. That is, the activity
4559 * becomes the new root of an otherwise empty task, and any old activities
4560 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4561 */
4562 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4563 /**
4564 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4565 * this flag will cause a newly launching task to be placed on top of the current
4566 * home activity task (if there is one). That is, pressing back from the task
4567 * will always return the user to home even if that was not the last activity they
4568 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4569 */
4570 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4571 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004572 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4573 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004574 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004575 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004576 * this flag. When set and the task's activity is finished, the recents
4577 * entry will remain in the interface for the user to re-launch it, like a
4578 * recents entry for a top-level application.
4579 * <p>
4580 * The receiving activity can override this request with
4581 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4582 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004583 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004584 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004585 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004586
4587 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004588 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4589 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004590 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4591 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004592 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004593 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004594
4595 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004596 * If set, when sending a broadcast only registered receivers will be
4597 * called -- no BroadcastReceiver components will be launched.
4598 */
4599 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004600 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004601 * If set, when sending a broadcast the new broadcast will replace
4602 * any existing pending broadcast that matches it. Matching is defined
4603 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4604 * true for the intents of the two broadcasts. When a match is found,
4605 * the new broadcast (and receivers associated with it) will replace the
4606 * existing one in the pending broadcast list, remaining at the same
4607 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004608 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004609 * <p>This flag is most typically used with sticky broadcasts, which
4610 * only care about delivering the most recent values of the broadcast
4611 * to their receivers.
4612 */
4613 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4614 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004615 * If set, when sending a broadcast the recipient is allowed to run at
4616 * foreground priority, with a shorter timeout interval. During normal
4617 * broadcasts the receivers are not automatically hoisted out of the
4618 * background priority class.
4619 */
4620 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4621 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004622 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4623 * They can still propagate results through to later receivers, but they can not prevent
4624 * later receivers from seeing the broadcast.
4625 */
4626 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4627 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004628 * If set, when sending a broadcast <i>before boot has completed</i> only
4629 * registered receivers will be called -- no BroadcastReceiver components
4630 * will be launched. Sticky intent state will be recorded properly even
4631 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4632 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004633 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004634 * <p>This flag is only for use by system sevices as a convenience to
4635 * avoid having to implement a more complex mechanism around detection
4636 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004637 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004638 * @hide
4639 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004640 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004641 /**
4642 * Set when this broadcast is for a boot upgrade, a special mode that
4643 * allows the broadcast to be sent before the system is ready and launches
4644 * the app process with no providers running in it.
4645 * @hide
4646 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004647 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004648 /**
4649 * If set, the broadcast will always go to manifest receivers in background (cached
4650 * or not running) apps, regardless of whether that would be done by default. By
4651 * default they will only receive broadcasts if the broadcast has specified an
4652 * explicit component or package name.
4653 * @hide
4654 */
4655 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4656 /**
4657 * If set, the broadcast will never go to manifest receivers in background (cached
4658 * or not running) apps, regardless of whether that would be done by default. By
4659 * default they will receive broadcasts if the broadcast has specified an
4660 * explicit component or package name.
4661 * @hide
4662 */
4663 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004664
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004665 /**
4666 * @hide Flags that can't be changed with PendingIntent.
4667 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004668 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4669 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4670 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004671
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004672 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004673 // ---------------------------------------------------------------------
4674 // toUri() and parseUri() options.
4675
4676 /**
4677 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4678 * always has the "intent:" scheme. This syntax can be used when you want
4679 * to later disambiguate between URIs that are intended to describe an
4680 * Intent vs. all others that should be treated as raw URIs. When used
4681 * with {@link #parseUri}, any other scheme will result in a generic
4682 * VIEW action for that raw URI.
4683 */
4684 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004685
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004686 /**
4687 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4688 * always has the "android-app:" scheme. This is a variation of
4689 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4690 * http/https URI being delivered to a specific package name. The format
4691 * is:
4692 *
4693 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004694 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004695 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004696 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4697 * you must also include a scheme; including a path also requires both a host and a scheme.
4698 * The final #Intent; fragment can be used without a scheme, host, or path.
4699 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004700 * used with intents that have a {@link #setSelector}, since the base intent
4701 * will always have an explicit package name.</p>
4702 *
4703 * <p>Some examples of how this scheme maps to Intent objects:</p>
4704 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4705 * <colgroup align="left" />
4706 * <colgroup align="left" />
4707 * <thead>
4708 * <tr><th>URI</th> <th>Intent</th></tr>
4709 * </thead>
4710 *
4711 * <tbody>
4712 * <tr><td><code>android-app://com.example.app</code></td>
4713 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4714 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4715 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4716 * </table></td>
4717 * </tr>
4718 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4719 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4720 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4721 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4722 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4723 * </table></td>
4724 * </tr>
4725 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4726 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4727 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4728 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4729 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4730 * </table></td>
4731 * </tr>
4732 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4733 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4734 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4735 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4736 * </table></td>
4737 * </tr>
4738 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4739 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4740 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4741 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4742 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4743 * </table></td>
4744 * </tr>
4745 * <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>
4746 * <td><table border="" style="margin:0" >
4747 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4748 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4749 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4750 * </table></td>
4751 * </tr>
4752 * </tbody>
4753 * </table>
4754 */
4755 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4756
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004757 /**
4758 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4759 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4760 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4761 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4762 * generated Intent can not cause unexpected data access to happen.
4763 *
4764 * <p>If you do not trust the source of the URI being parsed, you should still do further
4765 * processing to protect yourself from it. In particular, when using it to start an
4766 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4767 * that can handle it.</p>
4768 */
4769 public static final int URI_ALLOW_UNSAFE = 1<<2;
4770
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004771 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004772
4773 private String mAction;
4774 private Uri mData;
4775 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004776 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004777 private ComponentName mComponent;
4778 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004779 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004780 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004781 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004782 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004783 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004784 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004785
4786 // ---------------------------------------------------------------------
4787
4788 /**
4789 * Create an empty intent.
4790 */
4791 public Intent() {
4792 }
4793
4794 /**
4795 * Copy constructor.
4796 */
4797 public Intent(Intent o) {
4798 this.mAction = o.mAction;
4799 this.mData = o.mData;
4800 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004801 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004802 this.mComponent = o.mComponent;
4803 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004804 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004805 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004806 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004807 }
4808 if (o.mExtras != null) {
4809 this.mExtras = new Bundle(o.mExtras);
4810 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004811 if (o.mSourceBounds != null) {
4812 this.mSourceBounds = new Rect(o.mSourceBounds);
4813 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004814 if (o.mSelector != null) {
4815 this.mSelector = new Intent(o.mSelector);
4816 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004817 if (o.mClipData != null) {
4818 this.mClipData = new ClipData(o.mClipData);
4819 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004820 }
4821
4822 @Override
4823 public Object clone() {
4824 return new Intent(this);
4825 }
4826
4827 private Intent(Intent o, boolean all) {
4828 this.mAction = o.mAction;
4829 this.mData = o.mData;
4830 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004831 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004832 this.mComponent = o.mComponent;
4833 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004834 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004835 }
4836 }
4837
4838 /**
4839 * Make a clone of only the parts of the Intent that are relevant for
4840 * filter matching: the action, data, type, component, and categories.
4841 */
4842 public Intent cloneFilter() {
4843 return new Intent(this, false);
4844 }
4845
4846 /**
4847 * Create an intent with a given action. All other fields (data, type,
4848 * class) are null. Note that the action <em>must</em> be in a
4849 * namespace because Intents are used globally in the system -- for
4850 * example the system VIEW action is android.intent.action.VIEW; an
4851 * application's custom action would be something like
4852 * com.google.app.myapp.CUSTOM_ACTION.
4853 *
4854 * @param action The Intent action, such as ACTION_VIEW.
4855 */
4856 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004857 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004858 }
4859
4860 /**
4861 * Create an intent with a given action and for a given data url. Note
4862 * that the action <em>must</em> be in a namespace because Intents are
4863 * used globally in the system -- for example the system VIEW action is
4864 * android.intent.action.VIEW; an application's custom action would be
4865 * something like com.google.app.myapp.CUSTOM_ACTION.
4866 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004867 * <p><em>Note: scheme and host name matching in the Android framework is
4868 * case-sensitive, unlike the formal RFC. As a result,
4869 * you should always ensure that you write your Uri with these elements
4870 * using lower case letters, and normalize any Uris you receive from
4871 * outside of Android to ensure the scheme and host is lower case.</em></p>
4872 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873 * @param action The Intent action, such as ACTION_VIEW.
4874 * @param uri The Intent data URI.
4875 */
4876 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004877 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004878 mData = uri;
4879 }
4880
4881 /**
4882 * Create an intent for a specific component. All other fields (action, data,
4883 * type, class) are null, though they can be modified later with explicit
4884 * calls. This provides a convenient way to create an intent that is
4885 * intended to execute a hard-coded class name, rather than relying on the
4886 * system to find an appropriate class for you; see {@link #setComponent}
4887 * for more information on the repercussions of this.
4888 *
4889 * @param packageContext A Context of the application package implementing
4890 * this class.
4891 * @param cls The component class that is to be used for the intent.
4892 *
4893 * @see #setClass
4894 * @see #setComponent
4895 * @see #Intent(String, android.net.Uri , Context, Class)
4896 */
4897 public Intent(Context packageContext, Class<?> cls) {
4898 mComponent = new ComponentName(packageContext, cls);
4899 }
4900
4901 /**
4902 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004903 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004904 * construct the Intent and then calling {@link #setClass} to set its
4905 * class.
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 * @param packageContext A Context of the application package implementing
4916 * this class.
4917 * @param cls The component class that is to be used for the intent.
4918 *
4919 * @see #Intent(String, android.net.Uri)
4920 * @see #Intent(Context, Class)
4921 * @see #setClass
4922 * @see #setComponent
4923 */
4924 public Intent(String action, Uri uri,
4925 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004926 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004927 mData = uri;
4928 mComponent = new ComponentName(packageContext, cls);
4929 }
4930
4931 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004932 * Create an intent to launch the main (root) activity of a task. This
4933 * is the Intent that is started when the application's is launched from
4934 * Home. For anything else that wants to launch an application in the
4935 * same way, it is important that they use an Intent structured the same
4936 * way, and can use this function to ensure this is the case.
4937 *
4938 * <p>The returned Intent has the given Activity component as its explicit
4939 * component, {@link #ACTION_MAIN} as its action, and includes the
4940 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4941 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4942 * to do that through {@link #addFlags(int)} on the returned Intent.
4943 *
4944 * @param mainActivity The main activity component that this Intent will
4945 * launch.
4946 * @return Returns a newly created Intent that can be used to launch the
4947 * activity as a main application entry.
4948 *
4949 * @see #setClass
4950 * @see #setComponent
4951 */
4952 public static Intent makeMainActivity(ComponentName mainActivity) {
4953 Intent intent = new Intent(ACTION_MAIN);
4954 intent.setComponent(mainActivity);
4955 intent.addCategory(CATEGORY_LAUNCHER);
4956 return intent;
4957 }
4958
4959 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004960 * Make an Intent for the main activity of an application, without
4961 * specifying a specific activity to run but giving a selector to find
4962 * the activity. This results in a final Intent that is structured
4963 * the same as when the application is launched from
4964 * Home. For anything else that wants to launch an application in the
4965 * same way, it is important that they use an Intent structured the same
4966 * way, and can use this function to ensure this is the case.
4967 *
4968 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4969 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4970 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4971 * to do that through {@link #addFlags(int)} on the returned Intent.
4972 *
4973 * @param selectorAction The action name of the Intent's selector.
4974 * @param selectorCategory The name of a category to add to the Intent's
4975 * selector.
4976 * @return Returns a newly created Intent that can be used to launch the
4977 * activity as a main application entry.
4978 *
4979 * @see #setSelector(Intent)
4980 */
4981 public static Intent makeMainSelectorActivity(String selectorAction,
4982 String selectorCategory) {
4983 Intent intent = new Intent(ACTION_MAIN);
4984 intent.addCategory(CATEGORY_LAUNCHER);
4985 Intent selector = new Intent();
4986 selector.setAction(selectorAction);
4987 selector.addCategory(selectorCategory);
4988 intent.setSelector(selector);
4989 return intent;
4990 }
4991
4992 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004993 * Make an Intent that can be used to re-launch an application's task
4994 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4995 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4996 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4997 *
4998 * @param mainActivity The activity component that is the root of the
4999 * task; this is the activity that has been published in the application's
5000 * manifest as the main launcher icon.
5001 *
5002 * @return Returns a newly created Intent that can be used to relaunch the
5003 * activity's task in its root state.
5004 */
5005 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5006 Intent intent = makeMainActivity(mainActivity);
5007 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5008 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5009 return intent;
5010 }
5011
5012 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005013 * Call {@link #parseUri} with 0 flags.
5014 * @deprecated Use {@link #parseUri} instead.
5015 */
5016 @Deprecated
5017 public static Intent getIntent(String uri) throws URISyntaxException {
5018 return parseUri(uri, 0);
5019 }
Tom Taylord4a47292009-12-21 13:59:18 -08005020
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005021 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005022 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005023 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005024 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005025 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005026 *
5027 * <p>The URI given here must not be relative -- that is, it must include
5028 * the scheme and full path.
5029 *
5030 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005031 * @param flags Additional processing flags. Either 0,
5032 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005033 *
5034 * @return Intent The newly created Intent object.
5035 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005036 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5037 * it bad (as parsed by the Uri class) or the Intent data within the
5038 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005039 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005040 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005041 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005042 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005043 int i = 0;
5044 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005045 final boolean androidApp = uri.startsWith("android-app:");
5046
5047 // Validate intent scheme if requested.
5048 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5049 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005050 Intent intent = new Intent(ACTION_VIEW);
5051 try {
5052 intent.setData(Uri.parse(uri));
5053 } catch (IllegalArgumentException e) {
5054 throw new URISyntaxException(uri, e.getMessage());
5055 }
5056 return intent;
5057 }
5058 }
Tom Taylord4a47292009-12-21 13:59:18 -08005059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005060 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005061 // simple case
5062 if (i == -1) {
5063 if (!androidApp) {
5064 return new Intent(ACTION_VIEW, Uri.parse(uri));
5065 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005066
5067 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005068 } else if (!uri.startsWith("#Intent;", i)) {
5069 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005070 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005071 } else {
5072 i = -1;
5073 }
5074 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005075
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005076 // new format
5077 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005078 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005079 boolean explicitAction = false;
5080 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081
5082 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005083 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005084 String data;
5085 if (i >= 0) {
5086 data = uri.substring(0, i);
5087 i += 8; // length of "#Intent;"
5088 } else {
5089 data = uri;
5090 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005091
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005092 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005093 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005094 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005095 if (eq < 0) eq = i-1;
5096 int semi = uri.indexOf(';', i);
5097 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005098
5099 // action
5100 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005101 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005102 if (!inSelector) {
5103 explicitAction = true;
5104 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005105 }
5106
5107 // categories
5108 else if (uri.startsWith("category=", i)) {
5109 intent.addCategory(value);
5110 }
5111
5112 // type
5113 else if (uri.startsWith("type=", i)) {
5114 intent.mType = value;
5115 }
5116
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005117 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005118 else if (uri.startsWith("launchFlags=", i)) {
5119 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005120 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5121 intent.mFlags &= ~IMMUTABLE_FLAGS;
5122 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005123 }
5124
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005125 // package
5126 else if (uri.startsWith("package=", i)) {
5127 intent.mPackage = value;
5128 }
5129
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005130 // component
5131 else if (uri.startsWith("component=", i)) {
5132 intent.mComponent = ComponentName.unflattenFromString(value);
5133 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005134
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005135 // scheme
5136 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005137 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005138 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005139 } else {
5140 scheme = value;
5141 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005142 }
5143
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005144 // source bounds
5145 else if (uri.startsWith("sourceBounds=", i)) {
5146 intent.mSourceBounds = Rect.unflattenFromString(value);
5147 }
5148
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005149 // selector
5150 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5151 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005152 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005153 }
5154
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005155 // extra
5156 else {
5157 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005158 // create Bundle if it doesn't already exist
5159 if (intent.mExtras == null) intent.mExtras = new Bundle();
5160 Bundle b = intent.mExtras;
5161 // add EXTRA
5162 if (uri.startsWith("S.", i)) b.putString(key, value);
5163 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5164 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5165 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5166 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5167 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5168 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5169 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5170 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5171 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5172 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005173
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005174 // move to the next item
5175 i = semi + 1;
5176 }
5177
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005178 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005179 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005180 if (baseIntent.mPackage == null) {
5181 baseIntent.setSelector(intent);
5182 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005183 intent = baseIntent;
5184 }
5185
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005186 if (data != null) {
5187 if (data.startsWith("intent:")) {
5188 data = data.substring(7);
5189 if (scheme != null) {
5190 data = scheme + ':' + data;
5191 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005192 } else if (data.startsWith("android-app:")) {
5193 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5194 // Correctly formed android-app, first part is package name.
5195 int end = data.indexOf('/', 14);
5196 if (end < 0) {
5197 // All we have is a package name.
5198 intent.mPackage = data.substring(14);
5199 if (!explicitAction) {
5200 intent.setAction(ACTION_MAIN);
5201 }
5202 data = "";
5203 } else {
5204 // Target the Intent at the given package name always.
5205 String authority = null;
5206 intent.mPackage = data.substring(14, end);
5207 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005208 if ((end+1) < data.length()) {
5209 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5210 // Found a scheme, remember it.
5211 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005212 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005213 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5214 // Found a authority, remember it.
5215 authority = data.substring(end+1, newEnd);
5216 end = newEnd;
5217 }
5218 } else {
5219 // All we have is a scheme.
5220 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005221 }
5222 }
5223 if (scheme == null) {
5224 // If there was no scheme, then this just targets the package.
5225 if (!explicitAction) {
5226 intent.setAction(ACTION_MAIN);
5227 }
5228 data = "";
5229 } else if (authority == null) {
5230 data = scheme + ":";
5231 } else {
5232 data = scheme + "://" + authority + data.substring(end);
5233 }
5234 }
5235 } else {
5236 data = "";
5237 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005238 }
Tom Taylord4a47292009-12-21 13:59:18 -08005239
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005240 if (data.length() > 0) {
5241 try {
5242 intent.mData = Uri.parse(data);
5243 } catch (IllegalArgumentException e) {
5244 throw new URISyntaxException(uri, e.getMessage());
5245 }
5246 }
5247 }
Tom Taylord4a47292009-12-21 13:59:18 -08005248
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005250
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005251 } catch (IndexOutOfBoundsException e) {
5252 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5253 }
5254 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005255
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005256 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005257 return getIntentOld(uri, 0);
5258 }
5259
5260 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261 Intent intent;
5262
5263 int i = uri.lastIndexOf('#');
5264 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005265 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005266 final int intentFragmentStart = i;
5267 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268
5269 i++;
5270
5271 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005272 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005273 i += 7;
5274 int j = uri.indexOf(')', i);
5275 action = uri.substring(i, j);
5276 i = j + 1;
5277 }
5278
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005279 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005280
5281 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005282 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005283 i += 11;
5284 int j = uri.indexOf(')', i);
5285 while (i < j) {
5286 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005287 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005288 if (i < sep) {
5289 intent.addCategory(uri.substring(i, sep));
5290 }
5291 i = sep + 1;
5292 }
5293 i = j + 1;
5294 }
5295
5296 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005297 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005298 i += 5;
5299 int j = uri.indexOf(')', i);
5300 intent.mType = uri.substring(i, j);
5301 i = j + 1;
5302 }
5303
5304 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005305 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005306 i += 12;
5307 int j = uri.indexOf(')', i);
5308 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005309 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5310 intent.mFlags &= ~IMMUTABLE_FLAGS;
5311 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005312 i = j + 1;
5313 }
5314
5315 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005316 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005317 i += 10;
5318 int j = uri.indexOf(')', i);
5319 int sep = uri.indexOf('!', i);
5320 if (sep >= 0 && sep < j) {
5321 String pkg = uri.substring(i, sep);
5322 String cls = uri.substring(sep + 1, j);
5323 intent.mComponent = new ComponentName(pkg, cls);
5324 }
5325 i = j + 1;
5326 }
5327
5328 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005329 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005330 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005331
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005332 final int closeParen = uri.indexOf(')', i);
5333 if (closeParen == -1) throw new URISyntaxException(uri,
5334 "EXTRA missing trailing ')'", i);
5335
5336 while (i < closeParen) {
5337 // fetch the key value
5338 int j = uri.indexOf('=', i);
5339 if (j <= i + 1 || i >= closeParen) {
5340 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5341 }
5342 char type = uri.charAt(i);
5343 i++;
5344 String key = uri.substring(i, j);
5345 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005346
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005347 // get type-value
5348 j = uri.indexOf('!', i);
5349 if (j == -1 || j >= closeParen) j = closeParen;
5350 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5351 String value = uri.substring(i, j);
5352 i = j;
5353
5354 // create Bundle if it doesn't already exist
5355 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005356
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005357 // add item to bundle
5358 try {
5359 switch (type) {
5360 case 'S':
5361 intent.mExtras.putString(key, Uri.decode(value));
5362 break;
5363 case 'B':
5364 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5365 break;
5366 case 'b':
5367 intent.mExtras.putByte(key, Byte.parseByte(value));
5368 break;
5369 case 'c':
5370 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5371 break;
5372 case 'd':
5373 intent.mExtras.putDouble(key, Double.parseDouble(value));
5374 break;
5375 case 'f':
5376 intent.mExtras.putFloat(key, Float.parseFloat(value));
5377 break;
5378 case 'i':
5379 intent.mExtras.putInt(key, Integer.parseInt(value));
5380 break;
5381 case 'l':
5382 intent.mExtras.putLong(key, Long.parseLong(value));
5383 break;
5384 case 's':
5385 intent.mExtras.putShort(key, Short.parseShort(value));
5386 break;
5387 default:
5388 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5389 }
5390 } catch (NumberFormatException e) {
5391 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5392 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005393
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005394 char ch = uri.charAt(i);
5395 if (ch == ')') break;
5396 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5397 i++;
5398 }
5399 }
5400
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005401 if (isIntentFragment) {
5402 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5403 } else {
5404 intent.mData = Uri.parse(uri);
5405 }
Tom Taylord4a47292009-12-21 13:59:18 -08005406
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005407 if (intent.mAction == null) {
5408 // By default, if no action is specified, then use VIEW.
5409 intent.mAction = ACTION_VIEW;
5410 }
5411
5412 } else {
5413 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5414 }
5415
5416 return intent;
5417 }
5418
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005419 /** @hide */
5420 public interface CommandOptionHandler {
5421 boolean handleOption(String opt, ShellCommand cmd);
5422 }
5423
5424 /** @hide */
5425 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5426 throws URISyntaxException {
5427 Intent intent = new Intent();
5428 Intent baseIntent = intent;
5429 boolean hasIntentInfo = false;
5430
5431 Uri data = null;
5432 String type = null;
5433
5434 String opt;
5435 while ((opt=cmd.getNextOption()) != null) {
5436 switch (opt) {
5437 case "-a":
5438 intent.setAction(cmd.getNextArgRequired());
5439 if (intent == baseIntent) {
5440 hasIntentInfo = true;
5441 }
5442 break;
5443 case "-d":
5444 data = Uri.parse(cmd.getNextArgRequired());
5445 if (intent == baseIntent) {
5446 hasIntentInfo = true;
5447 }
5448 break;
5449 case "-t":
5450 type = cmd.getNextArgRequired();
5451 if (intent == baseIntent) {
5452 hasIntentInfo = true;
5453 }
5454 break;
5455 case "-c":
5456 intent.addCategory(cmd.getNextArgRequired());
5457 if (intent == baseIntent) {
5458 hasIntentInfo = true;
5459 }
5460 break;
5461 case "-e":
5462 case "--es": {
5463 String key = cmd.getNextArgRequired();
5464 String value = cmd.getNextArgRequired();
5465 intent.putExtra(key, value);
5466 }
5467 break;
5468 case "--esn": {
5469 String key = cmd.getNextArgRequired();
5470 intent.putExtra(key, (String) null);
5471 }
5472 break;
5473 case "--ei": {
5474 String key = cmd.getNextArgRequired();
5475 String value = cmd.getNextArgRequired();
5476 intent.putExtra(key, Integer.decode(value));
5477 }
5478 break;
5479 case "--eu": {
5480 String key = cmd.getNextArgRequired();
5481 String value = cmd.getNextArgRequired();
5482 intent.putExtra(key, Uri.parse(value));
5483 }
5484 break;
5485 case "--ecn": {
5486 String key = cmd.getNextArgRequired();
5487 String value = cmd.getNextArgRequired();
5488 ComponentName cn = ComponentName.unflattenFromString(value);
5489 if (cn == null)
5490 throw new IllegalArgumentException("Bad component name: " + value);
5491 intent.putExtra(key, cn);
5492 }
5493 break;
5494 case "--eia": {
5495 String key = cmd.getNextArgRequired();
5496 String value = cmd.getNextArgRequired();
5497 String[] strings = value.split(",");
5498 int[] list = new int[strings.length];
5499 for (int i = 0; i < strings.length; i++) {
5500 list[i] = Integer.decode(strings[i]);
5501 }
5502 intent.putExtra(key, list);
5503 }
5504 break;
5505 case "--eial": {
5506 String key = cmd.getNextArgRequired();
5507 String value = cmd.getNextArgRequired();
5508 String[] strings = value.split(",");
5509 ArrayList<Integer> list = new ArrayList<>(strings.length);
5510 for (int i = 0; i < strings.length; i++) {
5511 list.add(Integer.decode(strings[i]));
5512 }
5513 intent.putExtra(key, list);
5514 }
5515 break;
5516 case "--el": {
5517 String key = cmd.getNextArgRequired();
5518 String value = cmd.getNextArgRequired();
5519 intent.putExtra(key, Long.valueOf(value));
5520 }
5521 break;
5522 case "--ela": {
5523 String key = cmd.getNextArgRequired();
5524 String value = cmd.getNextArgRequired();
5525 String[] strings = value.split(",");
5526 long[] list = new long[strings.length];
5527 for (int i = 0; i < strings.length; i++) {
5528 list[i] = Long.valueOf(strings[i]);
5529 }
5530 intent.putExtra(key, list);
5531 hasIntentInfo = true;
5532 }
5533 break;
5534 case "--elal": {
5535 String key = cmd.getNextArgRequired();
5536 String value = cmd.getNextArgRequired();
5537 String[] strings = value.split(",");
5538 ArrayList<Long> list = new ArrayList<>(strings.length);
5539 for (int i = 0; i < strings.length; i++) {
5540 list.add(Long.valueOf(strings[i]));
5541 }
5542 intent.putExtra(key, list);
5543 hasIntentInfo = true;
5544 }
5545 break;
5546 case "--ef": {
5547 String key = cmd.getNextArgRequired();
5548 String value = cmd.getNextArgRequired();
5549 intent.putExtra(key, Float.valueOf(value));
5550 hasIntentInfo = true;
5551 }
5552 break;
5553 case "--efa": {
5554 String key = cmd.getNextArgRequired();
5555 String value = cmd.getNextArgRequired();
5556 String[] strings = value.split(",");
5557 float[] list = new float[strings.length];
5558 for (int i = 0; i < strings.length; i++) {
5559 list[i] = Float.valueOf(strings[i]);
5560 }
5561 intent.putExtra(key, list);
5562 hasIntentInfo = true;
5563 }
5564 break;
5565 case "--efal": {
5566 String key = cmd.getNextArgRequired();
5567 String value = cmd.getNextArgRequired();
5568 String[] strings = value.split(",");
5569 ArrayList<Float> list = new ArrayList<>(strings.length);
5570 for (int i = 0; i < strings.length; i++) {
5571 list.add(Float.valueOf(strings[i]));
5572 }
5573 intent.putExtra(key, list);
5574 hasIntentInfo = true;
5575 }
5576 break;
5577 case "--esa": {
5578 String key = cmd.getNextArgRequired();
5579 String value = cmd.getNextArgRequired();
5580 // Split on commas unless they are preceeded by an escape.
5581 // The escape character must be escaped for the string and
5582 // again for the regex, thus four escape characters become one.
5583 String[] strings = value.split("(?<!\\\\),");
5584 intent.putExtra(key, strings);
5585 hasIntentInfo = true;
5586 }
5587 break;
5588 case "--esal": {
5589 String key = cmd.getNextArgRequired();
5590 String value = cmd.getNextArgRequired();
5591 // Split on commas unless they are preceeded by an escape.
5592 // The escape character must be escaped for the string and
5593 // again for the regex, thus four escape characters become one.
5594 String[] strings = value.split("(?<!\\\\),");
5595 ArrayList<String> list = new ArrayList<>(strings.length);
5596 for (int i = 0; i < strings.length; i++) {
5597 list.add(strings[i]);
5598 }
5599 intent.putExtra(key, list);
5600 hasIntentInfo = true;
5601 }
5602 break;
5603 case "--ez": {
5604 String key = cmd.getNextArgRequired();
5605 String value = cmd.getNextArgRequired().toLowerCase();
5606 // Boolean.valueOf() results in false for anything that is not "true", which is
5607 // error-prone in shell commands
5608 boolean arg;
5609 if ("true".equals(value) || "t".equals(value)) {
5610 arg = true;
5611 } else if ("false".equals(value) || "f".equals(value)) {
5612 arg = false;
5613 } else {
5614 try {
5615 arg = Integer.decode(value) != 0;
5616 } catch (NumberFormatException ex) {
5617 throw new IllegalArgumentException("Invalid boolean value: " + value);
5618 }
5619 }
5620
5621 intent.putExtra(key, arg);
5622 }
5623 break;
5624 case "-n": {
5625 String str = cmd.getNextArgRequired();
5626 ComponentName cn = ComponentName.unflattenFromString(str);
5627 if (cn == null)
5628 throw new IllegalArgumentException("Bad component name: " + str);
5629 intent.setComponent(cn);
5630 if (intent == baseIntent) {
5631 hasIntentInfo = true;
5632 }
5633 }
5634 break;
5635 case "-p": {
5636 String str = cmd.getNextArgRequired();
5637 intent.setPackage(str);
5638 if (intent == baseIntent) {
5639 hasIntentInfo = true;
5640 }
5641 }
5642 break;
5643 case "-f":
5644 String str = cmd.getNextArgRequired();
5645 intent.setFlags(Integer.decode(str).intValue());
5646 break;
5647 case "--grant-read-uri-permission":
5648 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5649 break;
5650 case "--grant-write-uri-permission":
5651 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5652 break;
5653 case "--grant-persistable-uri-permission":
5654 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5655 break;
5656 case "--grant-prefix-uri-permission":
5657 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5658 break;
5659 case "--exclude-stopped-packages":
5660 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5661 break;
5662 case "--include-stopped-packages":
5663 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5664 break;
5665 case "--debug-log-resolution":
5666 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5667 break;
5668 case "--activity-brought-to-front":
5669 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5670 break;
5671 case "--activity-clear-top":
5672 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5673 break;
5674 case "--activity-clear-when-task-reset":
5675 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5676 break;
5677 case "--activity-exclude-from-recents":
5678 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5679 break;
5680 case "--activity-launched-from-history":
5681 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5682 break;
5683 case "--activity-multiple-task":
5684 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5685 break;
5686 case "--activity-no-animation":
5687 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5688 break;
5689 case "--activity-no-history":
5690 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5691 break;
5692 case "--activity-no-user-action":
5693 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5694 break;
5695 case "--activity-previous-is-top":
5696 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5697 break;
5698 case "--activity-reorder-to-front":
5699 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5700 break;
5701 case "--activity-reset-task-if-needed":
5702 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5703 break;
5704 case "--activity-single-top":
5705 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5706 break;
5707 case "--activity-clear-task":
5708 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5709 break;
5710 case "--activity-task-on-home":
5711 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5712 break;
5713 case "--receiver-registered-only":
5714 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5715 break;
5716 case "--receiver-replace-pending":
5717 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5718 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005719 case "--receiver-foreground":
5720 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5721 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005722 case "--selector":
5723 intent.setDataAndType(data, type);
5724 intent = new Intent();
5725 break;
5726 default:
5727 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5728 // Okay, caller handled this option.
5729 } else {
5730 throw new IllegalArgumentException("Unknown option: " + opt);
5731 }
5732 break;
5733 }
5734 }
5735 intent.setDataAndType(data, type);
5736
5737 final boolean hasSelector = intent != baseIntent;
5738 if (hasSelector) {
5739 // A selector was specified; fix up.
5740 baseIntent.setSelector(intent);
5741 intent = baseIntent;
5742 }
5743
5744 String arg = cmd.getNextArg();
5745 baseIntent = null;
5746 if (arg == null) {
5747 if (hasSelector) {
5748 // If a selector has been specified, and no arguments
5749 // have been supplied for the main Intent, then we can
5750 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5751 // need to have a component name specified yet, the
5752 // selector will take care of that.
5753 baseIntent = new Intent(Intent.ACTION_MAIN);
5754 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5755 }
5756 } else if (arg.indexOf(':') >= 0) {
5757 // The argument is a URI. Fully parse it, and use that result
5758 // to fill in any data not specified so far.
5759 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5760 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5761 } else if (arg.indexOf('/') >= 0) {
5762 // The argument is a component name. Build an Intent to launch
5763 // it.
5764 baseIntent = new Intent(Intent.ACTION_MAIN);
5765 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5766 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5767 } else {
5768 // Assume the argument is a package name.
5769 baseIntent = new Intent(Intent.ACTION_MAIN);
5770 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5771 baseIntent.setPackage(arg);
5772 }
5773 if (baseIntent != null) {
5774 Bundle extras = intent.getExtras();
5775 intent.replaceExtras((Bundle)null);
5776 Bundle uriExtras = baseIntent.getExtras();
5777 baseIntent.replaceExtras((Bundle)null);
5778 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5779 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5780 for (String c : cats) {
5781 baseIntent.removeCategory(c);
5782 }
5783 }
5784 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5785 if (extras == null) {
5786 extras = uriExtras;
5787 } else if (uriExtras != null) {
5788 uriExtras.putAll(extras);
5789 extras = uriExtras;
5790 }
5791 intent.replaceExtras(extras);
5792 hasIntentInfo = true;
5793 }
5794
5795 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5796 return intent;
5797 }
5798
5799 /** @hide */
5800 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5801 final String[] lines = new String[] {
5802 "<INTENT> specifications include these flags and arguments:",
5803 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5804 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5805 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5806 " [--esn <EXTRA_KEY> ...]",
5807 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5808 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5809 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5810 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5811 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5812 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5813 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5814 " (mutiple extras passed as Integer[])",
5815 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5816 " (mutiple extras passed as List<Integer>)",
5817 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5818 " (mutiple extras passed as Long[])",
5819 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5820 " (mutiple extras passed as List<Long>)",
5821 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5822 " (mutiple extras passed as Float[])",
5823 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5824 " (mutiple extras passed as List<Float>)",
5825 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5826 " (mutiple extras passed as String[]; to embed a comma into a string,",
5827 " escape it using \"\\,\")",
5828 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5829 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5830 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005831 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005832 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5833 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5834 " [--debug-log-resolution] [--exclude-stopped-packages]",
5835 " [--include-stopped-packages]",
5836 " [--activity-brought-to-front] [--activity-clear-top]",
5837 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5838 " [--activity-launched-from-history] [--activity-multiple-task]",
5839 " [--activity-no-animation] [--activity-no-history]",
5840 " [--activity-no-user-action] [--activity-previous-is-top]",
5841 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5842 " [--activity-single-top] [--activity-clear-task]",
5843 " [--activity-task-on-home]",
5844 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005845 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005846 " [--selector]",
5847 " [<URI> | <PACKAGE> | <COMPONENT>]"
5848 };
5849 for (String line : lines) {
5850 pw.print(prefix);
5851 pw.println(line);
5852 }
5853 }
5854
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005855 /**
5856 * Retrieve the general action to be performed, such as
5857 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5858 * the information in the intent should be interpreted -- most importantly,
5859 * what to do with the data returned by {@link #getData}.
5860 *
5861 * @return The action of this intent or null if none is specified.
5862 *
5863 * @see #setAction
5864 */
5865 public String getAction() {
5866 return mAction;
5867 }
5868
5869 /**
5870 * Retrieve data this intent is operating on. This URI specifies the name
5871 * of the data; often it uses the content: scheme, specifying data in a
5872 * content provider. Other schemes may be handled by specific activities,
5873 * such as http: by the web browser.
5874 *
5875 * @return The URI of the data this intent is targeting or null.
5876 *
5877 * @see #getScheme
5878 * @see #setData
5879 */
5880 public Uri getData() {
5881 return mData;
5882 }
5883
5884 /**
5885 * The same as {@link #getData()}, but returns the URI as an encoded
5886 * String.
5887 */
5888 public String getDataString() {
5889 return mData != null ? mData.toString() : null;
5890 }
5891
5892 /**
5893 * Return the scheme portion of the intent's data. If the data is null or
5894 * does not include a scheme, null is returned. Otherwise, the scheme
5895 * prefix without the final ':' is returned, i.e. "http".
5896 *
5897 * <p>This is the same as calling getData().getScheme() (and checking for
5898 * null data).
5899 *
5900 * @return The scheme of this intent.
5901 *
5902 * @see #getData
5903 */
5904 public String getScheme() {
5905 return mData != null ? mData.getScheme() : null;
5906 }
5907
5908 /**
5909 * Retrieve any explicit MIME type included in the intent. This is usually
5910 * null, as the type is determined by the intent data.
5911 *
5912 * @return If a type was manually set, it is returned; else null is
5913 * returned.
5914 *
5915 * @see #resolveType(ContentResolver)
5916 * @see #setType
5917 */
5918 public String getType() {
5919 return mType;
5920 }
5921
5922 /**
5923 * Return the MIME data type of this intent. If the type field is
5924 * explicitly set, that is simply returned. Otherwise, if the data is set,
5925 * the type of that data is returned. If neither fields are set, a null is
5926 * returned.
5927 *
5928 * @return The MIME type of this intent.
5929 *
5930 * @see #getType
5931 * @see #resolveType(ContentResolver)
5932 */
5933 public String resolveType(Context context) {
5934 return resolveType(context.getContentResolver());
5935 }
5936
5937 /**
5938 * Return the MIME data type of this intent. If the type field is
5939 * explicitly set, that is simply returned. Otherwise, if the data is set,
5940 * the type of that data is returned. If neither fields are set, a null is
5941 * returned.
5942 *
5943 * @param resolver A ContentResolver that can be used to determine the MIME
5944 * type of the intent's data.
5945 *
5946 * @return The MIME type of this intent.
5947 *
5948 * @see #getType
5949 * @see #resolveType(Context)
5950 */
5951 public String resolveType(ContentResolver resolver) {
5952 if (mType != null) {
5953 return mType;
5954 }
5955 if (mData != null) {
5956 if ("content".equals(mData.getScheme())) {
5957 return resolver.getType(mData);
5958 }
5959 }
5960 return null;
5961 }
5962
5963 /**
5964 * Return the MIME data type of this intent, only if it will be needed for
5965 * intent resolution. This is not generally useful for application code;
5966 * it is used by the frameworks for communicating with back-end system
5967 * services.
5968 *
5969 * @param resolver A ContentResolver that can be used to determine the MIME
5970 * type of the intent's data.
5971 *
5972 * @return The MIME type of this intent, or null if it is unknown or not
5973 * needed.
5974 */
5975 public String resolveTypeIfNeeded(ContentResolver resolver) {
5976 if (mComponent != null) {
5977 return mType;
5978 }
5979 return resolveType(resolver);
5980 }
5981
5982 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005983 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005984 *
5985 * @param category The category to check.
5986 *
5987 * @return boolean True if the intent contains the category, else false.
5988 *
5989 * @see #getCategories
5990 * @see #addCategory
5991 */
5992 public boolean hasCategory(String category) {
5993 return mCategories != null && mCategories.contains(category);
5994 }
5995
5996 /**
5997 * Return the set of all categories in the intent. If there are no categories,
5998 * returns NULL.
5999 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006000 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006001 *
6002 * @see #hasCategory
6003 * @see #addCategory
6004 */
6005 public Set<String> getCategories() {
6006 return mCategories;
6007 }
6008
6009 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006010 * Return the specific selector associated with this Intent. If there is
6011 * none, returns null. See {@link #setSelector} for more information.
6012 *
6013 * @see #setSelector
6014 */
6015 public Intent getSelector() {
6016 return mSelector;
6017 }
6018
6019 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006020 * Return the {@link ClipData} associated with this Intent. If there is
6021 * none, returns null. See {@link #setClipData} for more information.
6022 *
John Spurlock125d1332013-11-25 11:58:37 -05006023 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006024 */
6025 public ClipData getClipData() {
6026 return mClipData;
6027 }
6028
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006029 /** @hide */
6030 public int getContentUserHint() {
6031 return mContentUserHint;
6032 }
6033
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006035 * Sets the ClassLoader that will be used when unmarshalling
6036 * any Parcelable values from the extras of this Intent.
6037 *
6038 * @param loader a ClassLoader, or null to use the default loader
6039 * at the time of unmarshalling.
6040 */
6041 public void setExtrasClassLoader(ClassLoader loader) {
6042 if (mExtras != null) {
6043 mExtras.setClassLoader(loader);
6044 }
6045 }
6046
6047 /**
6048 * Returns true if an extra value is associated with the given name.
6049 * @param name the extra's name
6050 * @return true if the given extra is present.
6051 */
6052 public boolean hasExtra(String name) {
6053 return mExtras != null && mExtras.containsKey(name);
6054 }
6055
6056 /**
6057 * Returns true if the Intent's extras contain a parcelled file descriptor.
6058 * @return true if the Intent contains a parcelled file descriptor.
6059 */
6060 public boolean hasFileDescriptors() {
6061 return mExtras != null && mExtras.hasFileDescriptors();
6062 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006063
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006064 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006065 public void setAllowFds(boolean allowFds) {
6066 if (mExtras != null) {
6067 mExtras.setAllowFds(allowFds);
6068 }
6069 }
6070
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006071 /** {@hide} */
6072 public void setDefusable(boolean defusable) {
6073 if (mExtras != null) {
6074 mExtras.setDefusable(defusable);
6075 }
6076 }
6077
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006078 /**
6079 * Retrieve extended data from the intent.
6080 *
6081 * @param name The name of the desired item.
6082 *
6083 * @return the value of an item that previously added with putExtra()
6084 * or null if none was found.
6085 *
6086 * @deprecated
6087 * @hide
6088 */
6089 @Deprecated
6090 public Object getExtra(String name) {
6091 return getExtra(name, null);
6092 }
6093
6094 /**
6095 * Retrieve extended data from the intent.
6096 *
6097 * @param name The name of the desired item.
6098 * @param defaultValue the value to be returned if no value of the desired
6099 * type is stored with the given name.
6100 *
6101 * @return the value of an item that previously added with putExtra()
6102 * or the default value if none was found.
6103 *
6104 * @see #putExtra(String, boolean)
6105 */
6106 public boolean getBooleanExtra(String name, boolean defaultValue) {
6107 return mExtras == null ? defaultValue :
6108 mExtras.getBoolean(name, defaultValue);
6109 }
6110
6111 /**
6112 * Retrieve extended data from the intent.
6113 *
6114 * @param name The name of the desired item.
6115 * @param defaultValue the value to be returned if no value of the desired
6116 * type is stored with the given name.
6117 *
6118 * @return the value of an item that previously added with putExtra()
6119 * or the default value if none was found.
6120 *
6121 * @see #putExtra(String, byte)
6122 */
6123 public byte getByteExtra(String name, byte defaultValue) {
6124 return mExtras == null ? defaultValue :
6125 mExtras.getByte(name, defaultValue);
6126 }
6127
6128 /**
6129 * Retrieve extended data from the intent.
6130 *
6131 * @param name The name of the desired item.
6132 * @param defaultValue the value to be returned if no value of the desired
6133 * type is stored with the given name.
6134 *
6135 * @return the value of an item that previously added with putExtra()
6136 * or the default value if none was found.
6137 *
6138 * @see #putExtra(String, short)
6139 */
6140 public short getShortExtra(String name, short defaultValue) {
6141 return mExtras == null ? defaultValue :
6142 mExtras.getShort(name, defaultValue);
6143 }
6144
6145 /**
6146 * Retrieve extended data from the intent.
6147 *
6148 * @param name The name of the desired item.
6149 * @param defaultValue the value to be returned if no value of the desired
6150 * type is stored with the given name.
6151 *
6152 * @return the value of an item that previously added with putExtra()
6153 * or the default value if none was found.
6154 *
6155 * @see #putExtra(String, char)
6156 */
6157 public char getCharExtra(String name, char defaultValue) {
6158 return mExtras == null ? defaultValue :
6159 mExtras.getChar(name, defaultValue);
6160 }
6161
6162 /**
6163 * Retrieve extended data from the intent.
6164 *
6165 * @param name The name of the desired item.
6166 * @param defaultValue the value to be returned if no value of the desired
6167 * type is stored with the given name.
6168 *
6169 * @return the value of an item that previously added with putExtra()
6170 * or the default value if none was found.
6171 *
6172 * @see #putExtra(String, int)
6173 */
6174 public int getIntExtra(String name, int defaultValue) {
6175 return mExtras == null ? defaultValue :
6176 mExtras.getInt(name, defaultValue);
6177 }
6178
6179 /**
6180 * Retrieve extended data from the intent.
6181 *
6182 * @param name The name of the desired item.
6183 * @param defaultValue the value to be returned if no value of the desired
6184 * type is stored with the given name.
6185 *
6186 * @return the value of an item that previously added with putExtra()
6187 * or the default value if none was found.
6188 *
6189 * @see #putExtra(String, long)
6190 */
6191 public long getLongExtra(String name, long defaultValue) {
6192 return mExtras == null ? defaultValue :
6193 mExtras.getLong(name, defaultValue);
6194 }
6195
6196 /**
6197 * Retrieve extended data from the intent.
6198 *
6199 * @param name The name of the desired item.
6200 * @param defaultValue the value to be returned if no value of the desired
6201 * type is stored with the given name.
6202 *
6203 * @return the value of an item that previously added with putExtra(),
6204 * or the default value if no such item is present
6205 *
6206 * @see #putExtra(String, float)
6207 */
6208 public float getFloatExtra(String name, float defaultValue) {
6209 return mExtras == null ? defaultValue :
6210 mExtras.getFloat(name, defaultValue);
6211 }
6212
6213 /**
6214 * Retrieve extended data from the intent.
6215 *
6216 * @param name The name of the desired item.
6217 * @param defaultValue the value to be returned if no value of the desired
6218 * type is stored with the given name.
6219 *
6220 * @return the value of an item that previously added with putExtra()
6221 * or the default value if none was found.
6222 *
6223 * @see #putExtra(String, double)
6224 */
6225 public double getDoubleExtra(String name, double defaultValue) {
6226 return mExtras == null ? defaultValue :
6227 mExtras.getDouble(name, defaultValue);
6228 }
6229
6230 /**
6231 * Retrieve extended data from the intent.
6232 *
6233 * @param name The name of the desired item.
6234 *
6235 * @return the value of an item that previously added with putExtra()
6236 * or null if no String value was found.
6237 *
6238 * @see #putExtra(String, String)
6239 */
6240 public String getStringExtra(String name) {
6241 return mExtras == null ? null : mExtras.getString(name);
6242 }
6243
6244 /**
6245 * Retrieve extended data from the intent.
6246 *
6247 * @param name The name of the desired item.
6248 *
6249 * @return the value of an item that previously added with putExtra()
6250 * or null if no CharSequence value was found.
6251 *
6252 * @see #putExtra(String, CharSequence)
6253 */
6254 public CharSequence getCharSequenceExtra(String name) {
6255 return mExtras == null ? null : mExtras.getCharSequence(name);
6256 }
6257
6258 /**
6259 * Retrieve extended data from the intent.
6260 *
6261 * @param name The name of the desired item.
6262 *
6263 * @return the value of an item that previously added with putExtra()
6264 * or null if no Parcelable value was found.
6265 *
6266 * @see #putExtra(String, Parcelable)
6267 */
6268 public <T extends Parcelable> T getParcelableExtra(String name) {
6269 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6270 }
6271
6272 /**
6273 * Retrieve extended data from the intent.
6274 *
6275 * @param name The name of the desired item.
6276 *
6277 * @return the value of an item that previously added with putExtra()
6278 * or null if no Parcelable[] value was found.
6279 *
6280 * @see #putExtra(String, Parcelable[])
6281 */
6282 public Parcelable[] getParcelableArrayExtra(String name) {
6283 return mExtras == null ? null : mExtras.getParcelableArray(name);
6284 }
6285
6286 /**
6287 * Retrieve extended data from the intent.
6288 *
6289 * @param name The name of the desired item.
6290 *
6291 * @return the value of an item that previously added with putExtra()
6292 * or null if no ArrayList<Parcelable> value was found.
6293 *
6294 * @see #putParcelableArrayListExtra(String, ArrayList)
6295 */
6296 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6297 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6298 }
6299
6300 /**
6301 * Retrieve extended data from the intent.
6302 *
6303 * @param name The name of the desired item.
6304 *
6305 * @return the value of an item that previously added with putExtra()
6306 * or null if no Serializable value was found.
6307 *
6308 * @see #putExtra(String, Serializable)
6309 */
6310 public Serializable getSerializableExtra(String name) {
6311 return mExtras == null ? null : mExtras.getSerializable(name);
6312 }
6313
6314 /**
6315 * Retrieve extended data from the intent.
6316 *
6317 * @param name The name of the desired item.
6318 *
6319 * @return the value of an item that previously added with putExtra()
6320 * or null if no ArrayList<Integer> value was found.
6321 *
6322 * @see #putIntegerArrayListExtra(String, ArrayList)
6323 */
6324 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6325 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6326 }
6327
6328 /**
6329 * Retrieve extended data from the intent.
6330 *
6331 * @param name The name of the desired item.
6332 *
6333 * @return the value of an item that previously added with putExtra()
6334 * or null if no ArrayList<String> value was found.
6335 *
6336 * @see #putStringArrayListExtra(String, ArrayList)
6337 */
6338 public ArrayList<String> getStringArrayListExtra(String name) {
6339 return mExtras == null ? null : mExtras.getStringArrayList(name);
6340 }
6341
6342 /**
6343 * Retrieve extended data from the intent.
6344 *
6345 * @param name The name of the desired item.
6346 *
6347 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006348 * or null if no ArrayList<CharSequence> value was found.
6349 *
6350 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6351 */
6352 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6353 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6354 }
6355
6356 /**
6357 * Retrieve extended data from the intent.
6358 *
6359 * @param name The name of the desired item.
6360 *
6361 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006362 * or null if no boolean array value was found.
6363 *
6364 * @see #putExtra(String, boolean[])
6365 */
6366 public boolean[] getBooleanArrayExtra(String name) {
6367 return mExtras == null ? null : mExtras.getBooleanArray(name);
6368 }
6369
6370 /**
6371 * Retrieve extended data from the intent.
6372 *
6373 * @param name The name of the desired item.
6374 *
6375 * @return the value of an item that previously added with putExtra()
6376 * or null if no byte array value was found.
6377 *
6378 * @see #putExtra(String, byte[])
6379 */
6380 public byte[] getByteArrayExtra(String name) {
6381 return mExtras == null ? null : mExtras.getByteArray(name);
6382 }
6383
6384 /**
6385 * Retrieve extended data from the intent.
6386 *
6387 * @param name The name of the desired item.
6388 *
6389 * @return the value of an item that previously added with putExtra()
6390 * or null if no short array value was found.
6391 *
6392 * @see #putExtra(String, short[])
6393 */
6394 public short[] getShortArrayExtra(String name) {
6395 return mExtras == null ? null : mExtras.getShortArray(name);
6396 }
6397
6398 /**
6399 * Retrieve extended data from the intent.
6400 *
6401 * @param name The name of the desired item.
6402 *
6403 * @return the value of an item that previously added with putExtra()
6404 * or null if no char array value was found.
6405 *
6406 * @see #putExtra(String, char[])
6407 */
6408 public char[] getCharArrayExtra(String name) {
6409 return mExtras == null ? null : mExtras.getCharArray(name);
6410 }
6411
6412 /**
6413 * Retrieve extended data from the intent.
6414 *
6415 * @param name The name of the desired item.
6416 *
6417 * @return the value of an item that previously added with putExtra()
6418 * or null if no int array value was found.
6419 *
6420 * @see #putExtra(String, int[])
6421 */
6422 public int[] getIntArrayExtra(String name) {
6423 return mExtras == null ? null : mExtras.getIntArray(name);
6424 }
6425
6426 /**
6427 * Retrieve extended data from the intent.
6428 *
6429 * @param name The name of the desired item.
6430 *
6431 * @return the value of an item that previously added with putExtra()
6432 * or null if no long array value was found.
6433 *
6434 * @see #putExtra(String, long[])
6435 */
6436 public long[] getLongArrayExtra(String name) {
6437 return mExtras == null ? null : mExtras.getLongArray(name);
6438 }
6439
6440 /**
6441 * Retrieve extended data from the intent.
6442 *
6443 * @param name The name of the desired item.
6444 *
6445 * @return the value of an item that previously added with putExtra()
6446 * or null if no float array value was found.
6447 *
6448 * @see #putExtra(String, float[])
6449 */
6450 public float[] getFloatArrayExtra(String name) {
6451 return mExtras == null ? null : mExtras.getFloatArray(name);
6452 }
6453
6454 /**
6455 * Retrieve extended data from the intent.
6456 *
6457 * @param name The name of the desired item.
6458 *
6459 * @return the value of an item that previously added with putExtra()
6460 * or null if no double array value was found.
6461 *
6462 * @see #putExtra(String, double[])
6463 */
6464 public double[] getDoubleArrayExtra(String name) {
6465 return mExtras == null ? null : mExtras.getDoubleArray(name);
6466 }
6467
6468 /**
6469 * Retrieve extended data from the intent.
6470 *
6471 * @param name The name of the desired item.
6472 *
6473 * @return the value of an item that previously added with putExtra()
6474 * or null if no String array value was found.
6475 *
6476 * @see #putExtra(String, String[])
6477 */
6478 public String[] getStringArrayExtra(String name) {
6479 return mExtras == null ? null : mExtras.getStringArray(name);
6480 }
6481
6482 /**
6483 * Retrieve extended data from the intent.
6484 *
6485 * @param name The name of the desired item.
6486 *
6487 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006488 * or null if no CharSequence array value was found.
6489 *
6490 * @see #putExtra(String, CharSequence[])
6491 */
6492 public CharSequence[] getCharSequenceArrayExtra(String name) {
6493 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6494 }
6495
6496 /**
6497 * Retrieve extended data from the intent.
6498 *
6499 * @param name The name of the desired item.
6500 *
6501 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006502 * or null if no Bundle value was found.
6503 *
6504 * @see #putExtra(String, Bundle)
6505 */
6506 public Bundle getBundleExtra(String name) {
6507 return mExtras == null ? null : mExtras.getBundle(name);
6508 }
6509
6510 /**
6511 * Retrieve extended data from the intent.
6512 *
6513 * @param name The name of the desired item.
6514 *
6515 * @return the value of an item that previously added with putExtra()
6516 * or null if no IBinder value was found.
6517 *
6518 * @see #putExtra(String, IBinder)
6519 *
6520 * @deprecated
6521 * @hide
6522 */
6523 @Deprecated
6524 public IBinder getIBinderExtra(String name) {
6525 return mExtras == null ? null : mExtras.getIBinder(name);
6526 }
6527
6528 /**
6529 * Retrieve extended data from the intent.
6530 *
6531 * @param name The name of the desired item.
6532 * @param defaultValue The default value to return in case no item is
6533 * associated with the key 'name'
6534 *
6535 * @return the value of an item that previously added with putExtra()
6536 * or defaultValue if none was found.
6537 *
6538 * @see #putExtra
6539 *
6540 * @deprecated
6541 * @hide
6542 */
6543 @Deprecated
6544 public Object getExtra(String name, Object defaultValue) {
6545 Object result = defaultValue;
6546 if (mExtras != null) {
6547 Object result2 = mExtras.get(name);
6548 if (result2 != null) {
6549 result = result2;
6550 }
6551 }
6552
6553 return result;
6554 }
6555
6556 /**
6557 * Retrieves a map of extended data from the intent.
6558 *
6559 * @return the map of all extras previously added with putExtra(),
6560 * or null if none have been added.
6561 */
6562 public Bundle getExtras() {
6563 return (mExtras != null)
6564 ? new Bundle(mExtras)
6565 : null;
6566 }
6567
6568 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006569 * Filter extras to only basic types.
6570 * @hide
6571 */
6572 public void removeUnsafeExtras() {
6573 if (mExtras != null) {
Dianne Hackborn851ec492016-10-12 17:20:07 -07006574 mExtras = mExtras.filterValues();
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006575 }
6576 }
6577
6578 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006579 * Retrieve any special flags associated with this intent. You will
6580 * normally just set them with {@link #setFlags} and let the system
6581 * take the appropriate action with them.
6582 *
6583 * @return int The currently set flags.
6584 *
6585 * @see #setFlags
6586 */
6587 public int getFlags() {
6588 return mFlags;
6589 }
6590
Dianne Hackborne7f97212011-02-24 14:40:20 -08006591 /** @hide */
6592 public boolean isExcludingStopped() {
6593 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6594 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6595 }
6596
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006597 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006598 * Retrieve the application package name this Intent is limited to. When
6599 * resolving an Intent, if non-null this limits the resolution to only
6600 * components in the given application package.
6601 *
6602 * @return The name of the application package for the Intent.
6603 *
6604 * @see #resolveActivity
6605 * @see #setPackage
6606 */
6607 public String getPackage() {
6608 return mPackage;
6609 }
6610
6611 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006612 * Retrieve the concrete component associated with the intent. When receiving
6613 * an intent, this is the component that was found to best handle it (that is,
6614 * yourself) and will always be non-null; in all other cases it will be
6615 * null unless explicitly set.
6616 *
6617 * @return The name of the application component to handle the intent.
6618 *
6619 * @see #resolveActivity
6620 * @see #setComponent
6621 */
6622 public ComponentName getComponent() {
6623 return mComponent;
6624 }
6625
6626 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006627 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6628 * used as a hint to the receiver for animations and the like. Null means that there
6629 * is no source bounds.
6630 */
6631 public Rect getSourceBounds() {
6632 return mSourceBounds;
6633 }
6634
6635 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006636 * Return the Activity component that should be used to handle this intent.
6637 * The appropriate component is determined based on the information in the
6638 * intent, evaluated as follows:
6639 *
6640 * <p>If {@link #getComponent} returns an explicit class, that is returned
6641 * without any further consideration.
6642 *
6643 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6644 * category to be considered.
6645 *
6646 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6647 * action.
6648 *
6649 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6650 * this type.
6651 *
6652 * <p>If {@link #addCategory} has added any categories, the activity must
6653 * handle ALL of the categories specified.
6654 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006655 * <p>If {@link #getPackage} is non-NULL, only activity components in
6656 * that application package will be considered.
6657 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006658 * <p>If there are no activities that satisfy all of these conditions, a
6659 * null string is returned.
6660 *
6661 * <p>If multiple activities are found to satisfy the intent, the one with
6662 * the highest priority will be used. If there are multiple activities
6663 * with the same priority, the system will either pick the best activity
6664 * based on user preference, or resolve to a system class that will allow
6665 * the user to pick an activity and forward from there.
6666 *
6667 * <p>This method is implemented simply by calling
6668 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6669 * true.</p>
6670 * <p> This API is called for you as part of starting an activity from an
6671 * intent. You do not normally need to call it yourself.</p>
6672 *
6673 * @param pm The package manager with which to resolve the Intent.
6674 *
6675 * @return Name of the component implementing an activity that can
6676 * display the intent.
6677 *
6678 * @see #setComponent
6679 * @see #getComponent
6680 * @see #resolveActivityInfo
6681 */
6682 public ComponentName resolveActivity(PackageManager pm) {
6683 if (mComponent != null) {
6684 return mComponent;
6685 }
6686
6687 ResolveInfo info = pm.resolveActivity(
6688 this, PackageManager.MATCH_DEFAULT_ONLY);
6689 if (info != null) {
6690 return new ComponentName(
6691 info.activityInfo.applicationInfo.packageName,
6692 info.activityInfo.name);
6693 }
6694
6695 return null;
6696 }
6697
6698 /**
6699 * Resolve the Intent into an {@link ActivityInfo}
6700 * describing the activity that should execute the intent. Resolution
6701 * follows the same rules as described for {@link #resolveActivity}, but
6702 * you get back the completely information about the resolved activity
6703 * instead of just its class name.
6704 *
6705 * @param pm The package manager with which to resolve the Intent.
6706 * @param flags Addition information to retrieve as per
6707 * {@link PackageManager#getActivityInfo(ComponentName, int)
6708 * PackageManager.getActivityInfo()}.
6709 *
6710 * @return PackageManager.ActivityInfo
6711 *
6712 * @see #resolveActivity
6713 */
6714 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6715 ActivityInfo ai = null;
6716 if (mComponent != null) {
6717 try {
6718 ai = pm.getActivityInfo(mComponent, flags);
6719 } catch (PackageManager.NameNotFoundException e) {
6720 // ignore
6721 }
6722 } else {
6723 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006724 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006725 if (info != null) {
6726 ai = info.activityInfo;
6727 }
6728 }
6729
6730 return ai;
6731 }
6732
6733 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006734 * Special function for use by the system to resolve service
6735 * intents to system apps. Throws an exception if there are
6736 * multiple potential matches to the Intent. Returns null if
6737 * there are no matches.
6738 * @hide
6739 */
6740 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6741 if (mComponent != null) {
6742 return mComponent;
6743 }
6744
6745 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6746 if (results == null) {
6747 return null;
6748 }
6749 ComponentName comp = null;
6750 for (int i=0; i<results.size(); i++) {
6751 ResolveInfo ri = results.get(i);
6752 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6753 continue;
6754 }
6755 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6756 ri.serviceInfo.name);
6757 if (comp != null) {
6758 throw new IllegalStateException("Multiple system services handle " + this
6759 + ": " + comp + ", " + foundComp);
6760 }
6761 comp = foundComp;
6762 }
6763 return comp;
6764 }
6765
6766 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006767 * Set the general action to be performed.
6768 *
6769 * @param action An action name, such as ACTION_VIEW. Application-specific
6770 * actions should be prefixed with the vendor's package name.
6771 *
6772 * @return Returns the same Intent object, for chaining multiple calls
6773 * into a single statement.
6774 *
6775 * @see #getAction
6776 */
6777 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006778 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006779 return this;
6780 }
6781
6782 /**
6783 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006784 * clears any type that was previously set by {@link #setType} or
6785 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006786 *
Nick Pellyccae4122012-01-09 14:12:58 -08006787 * <p><em>Note: scheme matching in the Android framework is
6788 * case-sensitive, unlike the formal RFC. As a result,
6789 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006790 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006791 * {@link #setDataAndNormalize}
6792 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006793 *
Nick Pellyccae4122012-01-09 14:12:58 -08006794 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006795 *
6796 * @return Returns the same Intent object, for chaining multiple calls
6797 * into a single statement.
6798 *
6799 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006800 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006801 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006802 */
6803 public Intent setData(Uri data) {
6804 mData = data;
6805 mType = null;
6806 return this;
6807 }
6808
6809 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006810 * Normalize and set the data this intent is operating on.
6811 *
6812 * <p>This method automatically clears any type that was
6813 * previously set (for example, by {@link #setType}).
6814 *
6815 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006816 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006817 * so really this is just a convenience method for
6818 * <pre>
6819 * setData(data.normalize())
6820 * </pre>
6821 *
6822 * @param data The Uri of the data this intent is now targeting.
6823 *
6824 * @return Returns the same Intent object, for chaining multiple calls
6825 * into a single statement.
6826 *
6827 * @see #getData
6828 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006829 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006830 */
6831 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006832 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006833 }
6834
6835 /**
6836 * Set an explicit MIME data type.
6837 *
6838 * <p>This is used to create intents that only specify a type and not data,
6839 * for example to indicate the type of data to return.
6840 *
6841 * <p>This method automatically clears any data that was
6842 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006843 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006844 * <p><em>Note: MIME type matching in the Android framework is
6845 * case-sensitive, unlike formal RFC MIME types. As a result,
6846 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006847 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6848 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006849 *
6850 * @param type The MIME type of the data being handled by this intent.
6851 *
6852 * @return Returns the same Intent object, for chaining multiple calls
6853 * into a single statement.
6854 *
6855 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006856 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006857 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006858 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006859 */
6860 public Intent setType(String type) {
6861 mData = null;
6862 mType = type;
6863 return this;
6864 }
6865
6866 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006867 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006868 *
Nick Pellyccae4122012-01-09 14:12:58 -08006869 * <p>This is used to create intents that only specify a type and not data,
6870 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006871 *
Nick Pellyccae4122012-01-09 14:12:58 -08006872 * <p>This method automatically clears any data that was
6873 * previously set (for example by {@link #setData}).
6874 *
6875 * <p>The MIME type is normalized using
6876 * {@link #normalizeMimeType} before it is set,
6877 * so really this is just a convenience method for
6878 * <pre>
6879 * setType(Intent.normalizeMimeType(type))
6880 * </pre>
6881 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006882 * @param type The MIME type of the data being handled by this intent.
6883 *
6884 * @return Returns the same Intent object, for chaining multiple calls
6885 * into a single statement.
6886 *
Nick Pellyccae4122012-01-09 14:12:58 -08006887 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006888 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006889 * @see #normalizeMimeType
6890 */
6891 public Intent setTypeAndNormalize(String type) {
6892 return setType(normalizeMimeType(type));
6893 }
6894
6895 /**
6896 * (Usually optional) Set the data for the intent along with an explicit
6897 * MIME data type. This method should very rarely be used -- it allows you
6898 * to override the MIME type that would ordinarily be inferred from the
6899 * data with your own type given here.
6900 *
6901 * <p><em>Note: MIME type and Uri scheme matching in the
6902 * Android framework is case-sensitive, unlike the formal RFC definitions.
6903 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006904 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006905 * {@link #setDataAndTypeAndNormalize}
6906 * to ensure that they are converted to lower case.</em>
6907 *
6908 * @param data The Uri of the data this intent is now targeting.
6909 * @param type The MIME type of the data being handled by this intent.
6910 *
6911 * @return Returns the same Intent object, for chaining multiple calls
6912 * into a single statement.
6913 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006914 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006915 * @see #setData
6916 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006917 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006918 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006919 */
6920 public Intent setDataAndType(Uri data, String type) {
6921 mData = data;
6922 mType = type;
6923 return this;
6924 }
6925
6926 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006927 * (Usually optional) Normalize and set both the data Uri and an explicit
6928 * MIME data type. This method should very rarely be used -- it allows you
6929 * to override the MIME type that would ordinarily be inferred from the
6930 * data with your own type given here.
6931 *
6932 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006933 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006934 * before they are set, so really this is just a convenience method for
6935 * <pre>
6936 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6937 * </pre>
6938 *
6939 * @param data The Uri of the data this intent is now targeting.
6940 * @param type The MIME type of the data being handled by this intent.
6941 *
6942 * @return Returns the same Intent object, for chaining multiple calls
6943 * into a single statement.
6944 *
6945 * @see #setType
6946 * @see #setData
6947 * @see #setDataAndType
6948 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006949 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006950 */
6951 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006952 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006953 }
6954
6955 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006956 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006957 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006958 * activities that provide <em>all</em> of the requested categories will be
6959 * used.
6960 *
6961 * @param category The desired category. This can be either one of the
6962 * predefined Intent categories, or a custom category in your own
6963 * namespace.
6964 *
6965 * @return Returns the same Intent object, for chaining multiple calls
6966 * into a single statement.
6967 *
6968 * @see #hasCategory
6969 * @see #removeCategory
6970 */
6971 public Intent addCategory(String category) {
6972 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006973 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006974 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006975 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006976 return this;
6977 }
6978
6979 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006980 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006981 *
6982 * @param category The category to remove.
6983 *
6984 * @see #addCategory
6985 */
6986 public void removeCategory(String category) {
6987 if (mCategories != null) {
6988 mCategories.remove(category);
6989 if (mCategories.size() == 0) {
6990 mCategories = null;
6991 }
6992 }
6993 }
6994
6995 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006996 * Set a selector for this Intent. This is a modification to the kinds of
6997 * things the Intent will match. If the selector is set, it will be used
6998 * when trying to find entities that can handle the Intent, instead of the
6999 * main contents of the Intent. This allows you build an Intent containing
7000 * a generic protocol while targeting it more specifically.
7001 *
7002 * <p>An example of where this may be used is with things like
7003 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7004 * Intent that will launch the Browser application. However, the correct
7005 * main entry point of an application is actually {@link #ACTION_MAIN}
7006 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7007 * used to specify the actual Activity to launch. If you launch the browser
7008 * with something different, undesired behavior may happen if the user has
7009 * previously or later launches it the normal way, since they do not match.
7010 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7011 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7012 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7013 *
7014 * <p>Setting a selector does not impact the behavior of
7015 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7016 * desired behavior of a selector -- it does not impact the base meaning
7017 * of the Intent, just what kinds of things will be matched against it
7018 * when determining who can handle it.</p>
7019 *
7020 * <p>You can not use both a selector and {@link #setPackage(String)} on
7021 * the same base Intent.</p>
7022 *
7023 * @param selector The desired selector Intent; set to null to not use
7024 * a special selector.
7025 */
7026 public void setSelector(Intent selector) {
7027 if (selector == this) {
7028 throw new IllegalArgumentException(
7029 "Intent being set as a selector of itself");
7030 }
7031 if (selector != null && mPackage != null) {
7032 throw new IllegalArgumentException(
7033 "Can't set selector when package name is already set");
7034 }
7035 mSelector = selector;
7036 }
7037
7038 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007039 * Set a {@link ClipData} associated with this Intent. This replaces any
7040 * previously set ClipData.
7041 *
7042 * <p>The ClipData in an intent is not used for Intent matching or other
7043 * such operations. Semantically it is like extras, used to transmit
7044 * additional data with the Intent. The main feature of using this over
7045 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7046 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7047 * items included in the clip data. This is useful, in particular, if
7048 * you want to transmit an Intent containing multiple <code>content:</code>
7049 * URIs for which the recipient may not have global permission to access the
7050 * content provider.
7051 *
7052 * <p>If the ClipData contains items that are themselves Intents, any
7053 * grant flags in those Intents will be ignored. Only the top-level flags
7054 * of the main Intent are respected, and will be applied to all Uri or
7055 * Intent items in the clip (or sub-items of the clip).
7056 *
7057 * <p>The MIME type, label, and icon in the ClipData object are not
7058 * directly used by Intent. Applications should generally rely on the
7059 * MIME type of the Intent itself, not what it may find in the ClipData.
7060 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007061 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007062 *
7063 * @param clip The new clip to set. May be null to clear the current clip.
7064 */
7065 public void setClipData(ClipData clip) {
7066 mClipData = clip;
7067 }
7068
7069 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007070 * This is NOT a secure mechanism to identify the user who sent the intent.
7071 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7072 * who sent the intent.
7073 * @hide
7074 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007075 public void prepareToLeaveUser(int userId) {
7076 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7077 // We want mContentUserHint to refer to the original user, so don't do anything.
7078 if (mContentUserHint == UserHandle.USER_CURRENT) {
7079 mContentUserHint = userId;
7080 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007081 }
7082
7083 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007084 * Add extended data to the intent. The name must include a package
7085 * prefix, for example the app com.android.contacts would use names
7086 * like "com.android.contacts.ShowAll".
7087 *
7088 * @param name The name of the extra data, with package prefix.
7089 * @param value The boolean data value.
7090 *
7091 * @return Returns the same Intent object, for chaining multiple calls
7092 * into a single statement.
7093 *
7094 * @see #putExtras
7095 * @see #removeExtra
7096 * @see #getBooleanExtra(String, boolean)
7097 */
7098 public Intent putExtra(String name, boolean value) {
7099 if (mExtras == null) {
7100 mExtras = new Bundle();
7101 }
7102 mExtras.putBoolean(name, value);
7103 return this;
7104 }
7105
7106 /**
7107 * Add extended data to the intent. The name must include a package
7108 * prefix, for example the app com.android.contacts would use names
7109 * like "com.android.contacts.ShowAll".
7110 *
7111 * @param name The name of the extra data, with package prefix.
7112 * @param value The byte data value.
7113 *
7114 * @return Returns the same Intent object, for chaining multiple calls
7115 * into a single statement.
7116 *
7117 * @see #putExtras
7118 * @see #removeExtra
7119 * @see #getByteExtra(String, byte)
7120 */
7121 public Intent putExtra(String name, byte value) {
7122 if (mExtras == null) {
7123 mExtras = new Bundle();
7124 }
7125 mExtras.putByte(name, value);
7126 return this;
7127 }
7128
7129 /**
7130 * Add extended data to the intent. The name must include a package
7131 * prefix, for example the app com.android.contacts would use names
7132 * like "com.android.contacts.ShowAll".
7133 *
7134 * @param name The name of the extra data, with package prefix.
7135 * @param value The char data value.
7136 *
7137 * @return Returns the same Intent object, for chaining multiple calls
7138 * into a single statement.
7139 *
7140 * @see #putExtras
7141 * @see #removeExtra
7142 * @see #getCharExtra(String, char)
7143 */
7144 public Intent putExtra(String name, char value) {
7145 if (mExtras == null) {
7146 mExtras = new Bundle();
7147 }
7148 mExtras.putChar(name, value);
7149 return this;
7150 }
7151
7152 /**
7153 * Add extended data to the intent. The name must include a package
7154 * prefix, for example the app com.android.contacts would use names
7155 * like "com.android.contacts.ShowAll".
7156 *
7157 * @param name The name of the extra data, with package prefix.
7158 * @param value The short data value.
7159 *
7160 * @return Returns the same Intent object, for chaining multiple calls
7161 * into a single statement.
7162 *
7163 * @see #putExtras
7164 * @see #removeExtra
7165 * @see #getShortExtra(String, short)
7166 */
7167 public Intent putExtra(String name, short value) {
7168 if (mExtras == null) {
7169 mExtras = new Bundle();
7170 }
7171 mExtras.putShort(name, value);
7172 return this;
7173 }
7174
7175 /**
7176 * Add extended data to the intent. The name must include a package
7177 * prefix, for example the app com.android.contacts would use names
7178 * like "com.android.contacts.ShowAll".
7179 *
7180 * @param name The name of the extra data, with package prefix.
7181 * @param value The integer data value.
7182 *
7183 * @return Returns the same Intent object, for chaining multiple calls
7184 * into a single statement.
7185 *
7186 * @see #putExtras
7187 * @see #removeExtra
7188 * @see #getIntExtra(String, int)
7189 */
7190 public Intent putExtra(String name, int value) {
7191 if (mExtras == null) {
7192 mExtras = new Bundle();
7193 }
7194 mExtras.putInt(name, value);
7195 return this;
7196 }
7197
7198 /**
7199 * Add extended data to the intent. The name must include a package
7200 * prefix, for example the app com.android.contacts would use names
7201 * like "com.android.contacts.ShowAll".
7202 *
7203 * @param name The name of the extra data, with package prefix.
7204 * @param value The long data value.
7205 *
7206 * @return Returns the same Intent object, for chaining multiple calls
7207 * into a single statement.
7208 *
7209 * @see #putExtras
7210 * @see #removeExtra
7211 * @see #getLongExtra(String, long)
7212 */
7213 public Intent putExtra(String name, long value) {
7214 if (mExtras == null) {
7215 mExtras = new Bundle();
7216 }
7217 mExtras.putLong(name, value);
7218 return this;
7219 }
7220
7221 /**
7222 * Add extended data to the intent. The name must include a package
7223 * prefix, for example the app com.android.contacts would use names
7224 * like "com.android.contacts.ShowAll".
7225 *
7226 * @param name The name of the extra data, with package prefix.
7227 * @param value The float data value.
7228 *
7229 * @return Returns the same Intent object, for chaining multiple calls
7230 * into a single statement.
7231 *
7232 * @see #putExtras
7233 * @see #removeExtra
7234 * @see #getFloatExtra(String, float)
7235 */
7236 public Intent putExtra(String name, float value) {
7237 if (mExtras == null) {
7238 mExtras = new Bundle();
7239 }
7240 mExtras.putFloat(name, value);
7241 return this;
7242 }
7243
7244 /**
7245 * Add extended data to the intent. The name must include a package
7246 * prefix, for example the app com.android.contacts would use names
7247 * like "com.android.contacts.ShowAll".
7248 *
7249 * @param name The name of the extra data, with package prefix.
7250 * @param value The double data value.
7251 *
7252 * @return Returns the same Intent object, for chaining multiple calls
7253 * into a single statement.
7254 *
7255 * @see #putExtras
7256 * @see #removeExtra
7257 * @see #getDoubleExtra(String, double)
7258 */
7259 public Intent putExtra(String name, double value) {
7260 if (mExtras == null) {
7261 mExtras = new Bundle();
7262 }
7263 mExtras.putDouble(name, value);
7264 return this;
7265 }
7266
7267 /**
7268 * Add extended data to the intent. The name must include a package
7269 * prefix, for example the app com.android.contacts would use names
7270 * like "com.android.contacts.ShowAll".
7271 *
7272 * @param name The name of the extra data, with package prefix.
7273 * @param value The String data value.
7274 *
7275 * @return Returns the same Intent object, for chaining multiple calls
7276 * into a single statement.
7277 *
7278 * @see #putExtras
7279 * @see #removeExtra
7280 * @see #getStringExtra(String)
7281 */
7282 public Intent putExtra(String name, String value) {
7283 if (mExtras == null) {
7284 mExtras = new Bundle();
7285 }
7286 mExtras.putString(name, value);
7287 return this;
7288 }
7289
7290 /**
7291 * Add extended data to the intent. The name must include a package
7292 * prefix, for example the app com.android.contacts would use names
7293 * like "com.android.contacts.ShowAll".
7294 *
7295 * @param name The name of the extra data, with package prefix.
7296 * @param value The CharSequence data value.
7297 *
7298 * @return Returns the same Intent object, for chaining multiple calls
7299 * into a single statement.
7300 *
7301 * @see #putExtras
7302 * @see #removeExtra
7303 * @see #getCharSequenceExtra(String)
7304 */
7305 public Intent putExtra(String name, CharSequence value) {
7306 if (mExtras == null) {
7307 mExtras = new Bundle();
7308 }
7309 mExtras.putCharSequence(name, value);
7310 return this;
7311 }
7312
7313 /**
7314 * Add extended data to the intent. The name must include a package
7315 * prefix, for example the app com.android.contacts would use names
7316 * like "com.android.contacts.ShowAll".
7317 *
7318 * @param name The name of the extra data, with package prefix.
7319 * @param value The Parcelable data value.
7320 *
7321 * @return Returns the same Intent object, for chaining multiple calls
7322 * into a single statement.
7323 *
7324 * @see #putExtras
7325 * @see #removeExtra
7326 * @see #getParcelableExtra(String)
7327 */
7328 public Intent putExtra(String name, Parcelable value) {
7329 if (mExtras == null) {
7330 mExtras = new Bundle();
7331 }
7332 mExtras.putParcelable(name, value);
7333 return this;
7334 }
7335
7336 /**
7337 * Add extended data to the intent. The name must include a package
7338 * prefix, for example the app com.android.contacts would use names
7339 * like "com.android.contacts.ShowAll".
7340 *
7341 * @param name The name of the extra data, with package prefix.
7342 * @param value The Parcelable[] data value.
7343 *
7344 * @return Returns the same Intent object, for chaining multiple calls
7345 * into a single statement.
7346 *
7347 * @see #putExtras
7348 * @see #removeExtra
7349 * @see #getParcelableArrayExtra(String)
7350 */
7351 public Intent putExtra(String name, Parcelable[] value) {
7352 if (mExtras == null) {
7353 mExtras = new Bundle();
7354 }
7355 mExtras.putParcelableArray(name, value);
7356 return this;
7357 }
7358
7359 /**
7360 * Add extended data to the intent. The name must include a package
7361 * prefix, for example the app com.android.contacts would use names
7362 * like "com.android.contacts.ShowAll".
7363 *
7364 * @param name The name of the extra data, with package prefix.
7365 * @param value The ArrayList<Parcelable> data value.
7366 *
7367 * @return Returns the same Intent object, for chaining multiple calls
7368 * into a single statement.
7369 *
7370 * @see #putExtras
7371 * @see #removeExtra
7372 * @see #getParcelableArrayListExtra(String)
7373 */
7374 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7375 if (mExtras == null) {
7376 mExtras = new Bundle();
7377 }
7378 mExtras.putParcelableArrayList(name, value);
7379 return this;
7380 }
7381
7382 /**
7383 * Add extended data to the intent. The name must include a package
7384 * prefix, for example the app com.android.contacts would use names
7385 * like "com.android.contacts.ShowAll".
7386 *
7387 * @param name The name of the extra data, with package prefix.
7388 * @param value The ArrayList<Integer> data value.
7389 *
7390 * @return Returns the same Intent object, for chaining multiple calls
7391 * into a single statement.
7392 *
7393 * @see #putExtras
7394 * @see #removeExtra
7395 * @see #getIntegerArrayListExtra(String)
7396 */
7397 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7398 if (mExtras == null) {
7399 mExtras = new Bundle();
7400 }
7401 mExtras.putIntegerArrayList(name, value);
7402 return this;
7403 }
7404
7405 /**
7406 * Add extended data to the intent. The name must include a package
7407 * prefix, for example the app com.android.contacts would use names
7408 * like "com.android.contacts.ShowAll".
7409 *
7410 * @param name The name of the extra data, with package prefix.
7411 * @param value The ArrayList<String> data value.
7412 *
7413 * @return Returns the same Intent object, for chaining multiple calls
7414 * into a single statement.
7415 *
7416 * @see #putExtras
7417 * @see #removeExtra
7418 * @see #getStringArrayListExtra(String)
7419 */
7420 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7421 if (mExtras == null) {
7422 mExtras = new Bundle();
7423 }
7424 mExtras.putStringArrayList(name, value);
7425 return this;
7426 }
7427
7428 /**
7429 * Add extended data to the intent. The name must include a package
7430 * prefix, for example the app com.android.contacts would use names
7431 * like "com.android.contacts.ShowAll".
7432 *
7433 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007434 * @param value The ArrayList<CharSequence> data value.
7435 *
7436 * @return Returns the same Intent object, for chaining multiple calls
7437 * into a single statement.
7438 *
7439 * @see #putExtras
7440 * @see #removeExtra
7441 * @see #getCharSequenceArrayListExtra(String)
7442 */
7443 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7444 if (mExtras == null) {
7445 mExtras = new Bundle();
7446 }
7447 mExtras.putCharSequenceArrayList(name, value);
7448 return this;
7449 }
7450
7451 /**
7452 * Add extended data to the intent. The name must include a package
7453 * prefix, for example the app com.android.contacts would use names
7454 * like "com.android.contacts.ShowAll".
7455 *
7456 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007457 * @param value The Serializable data value.
7458 *
7459 * @return Returns the same Intent object, for chaining multiple calls
7460 * into a single statement.
7461 *
7462 * @see #putExtras
7463 * @see #removeExtra
7464 * @see #getSerializableExtra(String)
7465 */
7466 public Intent putExtra(String name, Serializable value) {
7467 if (mExtras == null) {
7468 mExtras = new Bundle();
7469 }
7470 mExtras.putSerializable(name, value);
7471 return this;
7472 }
7473
7474 /**
7475 * Add extended data to the intent. The name must include a package
7476 * prefix, for example the app com.android.contacts would use names
7477 * like "com.android.contacts.ShowAll".
7478 *
7479 * @param name The name of the extra data, with package prefix.
7480 * @param value The boolean array data value.
7481 *
7482 * @return Returns the same Intent object, for chaining multiple calls
7483 * into a single statement.
7484 *
7485 * @see #putExtras
7486 * @see #removeExtra
7487 * @see #getBooleanArrayExtra(String)
7488 */
7489 public Intent putExtra(String name, boolean[] value) {
7490 if (mExtras == null) {
7491 mExtras = new Bundle();
7492 }
7493 mExtras.putBooleanArray(name, value);
7494 return this;
7495 }
7496
7497 /**
7498 * Add extended data to the intent. The name must include a package
7499 * prefix, for example the app com.android.contacts would use names
7500 * like "com.android.contacts.ShowAll".
7501 *
7502 * @param name The name of the extra data, with package prefix.
7503 * @param value The byte array data value.
7504 *
7505 * @return Returns the same Intent object, for chaining multiple calls
7506 * into a single statement.
7507 *
7508 * @see #putExtras
7509 * @see #removeExtra
7510 * @see #getByteArrayExtra(String)
7511 */
7512 public Intent putExtra(String name, byte[] value) {
7513 if (mExtras == null) {
7514 mExtras = new Bundle();
7515 }
7516 mExtras.putByteArray(name, value);
7517 return this;
7518 }
7519
7520 /**
7521 * Add extended data to the intent. The name must include a package
7522 * prefix, for example the app com.android.contacts would use names
7523 * like "com.android.contacts.ShowAll".
7524 *
7525 * @param name The name of the extra data, with package prefix.
7526 * @param value The short array data value.
7527 *
7528 * @return Returns the same Intent object, for chaining multiple calls
7529 * into a single statement.
7530 *
7531 * @see #putExtras
7532 * @see #removeExtra
7533 * @see #getShortArrayExtra(String)
7534 */
7535 public Intent putExtra(String name, short[] value) {
7536 if (mExtras == null) {
7537 mExtras = new Bundle();
7538 }
7539 mExtras.putShortArray(name, value);
7540 return this;
7541 }
7542
7543 /**
7544 * Add extended data to the intent. The name must include a package
7545 * prefix, for example the app com.android.contacts would use names
7546 * like "com.android.contacts.ShowAll".
7547 *
7548 * @param name The name of the extra data, with package prefix.
7549 * @param value The char array data value.
7550 *
7551 * @return Returns the same Intent object, for chaining multiple calls
7552 * into a single statement.
7553 *
7554 * @see #putExtras
7555 * @see #removeExtra
7556 * @see #getCharArrayExtra(String)
7557 */
7558 public Intent putExtra(String name, char[] value) {
7559 if (mExtras == null) {
7560 mExtras = new Bundle();
7561 }
7562 mExtras.putCharArray(name, value);
7563 return this;
7564 }
7565
7566 /**
7567 * Add extended data to the intent. The name must include a package
7568 * prefix, for example the app com.android.contacts would use names
7569 * like "com.android.contacts.ShowAll".
7570 *
7571 * @param name The name of the extra data, with package prefix.
7572 * @param value The int array data value.
7573 *
7574 * @return Returns the same Intent object, for chaining multiple calls
7575 * into a single statement.
7576 *
7577 * @see #putExtras
7578 * @see #removeExtra
7579 * @see #getIntArrayExtra(String)
7580 */
7581 public Intent putExtra(String name, int[] value) {
7582 if (mExtras == null) {
7583 mExtras = new Bundle();
7584 }
7585 mExtras.putIntArray(name, value);
7586 return this;
7587 }
7588
7589 /**
7590 * Add extended data to the intent. The name must include a package
7591 * prefix, for example the app com.android.contacts would use names
7592 * like "com.android.contacts.ShowAll".
7593 *
7594 * @param name The name of the extra data, with package prefix.
7595 * @param value The byte array data value.
7596 *
7597 * @return Returns the same Intent object, for chaining multiple calls
7598 * into a single statement.
7599 *
7600 * @see #putExtras
7601 * @see #removeExtra
7602 * @see #getLongArrayExtra(String)
7603 */
7604 public Intent putExtra(String name, long[] value) {
7605 if (mExtras == null) {
7606 mExtras = new Bundle();
7607 }
7608 mExtras.putLongArray(name, value);
7609 return this;
7610 }
7611
7612 /**
7613 * Add extended data to the intent. The name must include a package
7614 * prefix, for example the app com.android.contacts would use names
7615 * like "com.android.contacts.ShowAll".
7616 *
7617 * @param name The name of the extra data, with package prefix.
7618 * @param value The float array data value.
7619 *
7620 * @return Returns the same Intent object, for chaining multiple calls
7621 * into a single statement.
7622 *
7623 * @see #putExtras
7624 * @see #removeExtra
7625 * @see #getFloatArrayExtra(String)
7626 */
7627 public Intent putExtra(String name, float[] value) {
7628 if (mExtras == null) {
7629 mExtras = new Bundle();
7630 }
7631 mExtras.putFloatArray(name, value);
7632 return this;
7633 }
7634
7635 /**
7636 * Add extended data to the intent. The name must include a package
7637 * prefix, for example the app com.android.contacts would use names
7638 * like "com.android.contacts.ShowAll".
7639 *
7640 * @param name The name of the extra data, with package prefix.
7641 * @param value The double array data value.
7642 *
7643 * @return Returns the same Intent object, for chaining multiple calls
7644 * into a single statement.
7645 *
7646 * @see #putExtras
7647 * @see #removeExtra
7648 * @see #getDoubleArrayExtra(String)
7649 */
7650 public Intent putExtra(String name, double[] value) {
7651 if (mExtras == null) {
7652 mExtras = new Bundle();
7653 }
7654 mExtras.putDoubleArray(name, value);
7655 return this;
7656 }
7657
7658 /**
7659 * Add extended data to the intent. The name must include a package
7660 * prefix, for example the app com.android.contacts would use names
7661 * like "com.android.contacts.ShowAll".
7662 *
7663 * @param name The name of the extra data, with package prefix.
7664 * @param value The String array data value.
7665 *
7666 * @return Returns the same Intent object, for chaining multiple calls
7667 * into a single statement.
7668 *
7669 * @see #putExtras
7670 * @see #removeExtra
7671 * @see #getStringArrayExtra(String)
7672 */
7673 public Intent putExtra(String name, String[] value) {
7674 if (mExtras == null) {
7675 mExtras = new Bundle();
7676 }
7677 mExtras.putStringArray(name, value);
7678 return this;
7679 }
7680
7681 /**
7682 * Add extended data to the intent. The name must include a package
7683 * prefix, for example the app com.android.contacts would use names
7684 * like "com.android.contacts.ShowAll".
7685 *
7686 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007687 * @param value The CharSequence array data value.
7688 *
7689 * @return Returns the same Intent object, for chaining multiple calls
7690 * into a single statement.
7691 *
7692 * @see #putExtras
7693 * @see #removeExtra
7694 * @see #getCharSequenceArrayExtra(String)
7695 */
7696 public Intent putExtra(String name, CharSequence[] value) {
7697 if (mExtras == null) {
7698 mExtras = new Bundle();
7699 }
7700 mExtras.putCharSequenceArray(name, value);
7701 return this;
7702 }
7703
7704 /**
7705 * Add extended data to the intent. The name must include a package
7706 * prefix, for example the app com.android.contacts would use names
7707 * like "com.android.contacts.ShowAll".
7708 *
7709 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007710 * @param value The Bundle data value.
7711 *
7712 * @return Returns the same Intent object, for chaining multiple calls
7713 * into a single statement.
7714 *
7715 * @see #putExtras
7716 * @see #removeExtra
7717 * @see #getBundleExtra(String)
7718 */
7719 public Intent putExtra(String name, Bundle value) {
7720 if (mExtras == null) {
7721 mExtras = new Bundle();
7722 }
7723 mExtras.putBundle(name, value);
7724 return this;
7725 }
7726
7727 /**
7728 * Add extended data to the intent. The name must include a package
7729 * prefix, for example the app com.android.contacts would use names
7730 * like "com.android.contacts.ShowAll".
7731 *
7732 * @param name The name of the extra data, with package prefix.
7733 * @param value The IBinder data value.
7734 *
7735 * @return Returns the same Intent object, for chaining multiple calls
7736 * into a single statement.
7737 *
7738 * @see #putExtras
7739 * @see #removeExtra
7740 * @see #getIBinderExtra(String)
7741 *
7742 * @deprecated
7743 * @hide
7744 */
7745 @Deprecated
7746 public Intent putExtra(String name, IBinder value) {
7747 if (mExtras == null) {
7748 mExtras = new Bundle();
7749 }
7750 mExtras.putIBinder(name, value);
7751 return this;
7752 }
7753
7754 /**
7755 * Copy all extras in 'src' in to this intent.
7756 *
7757 * @param src Contains the extras to copy.
7758 *
7759 * @see #putExtra
7760 */
7761 public Intent putExtras(Intent src) {
7762 if (src.mExtras != null) {
7763 if (mExtras == null) {
7764 mExtras = new Bundle(src.mExtras);
7765 } else {
7766 mExtras.putAll(src.mExtras);
7767 }
7768 }
7769 return this;
7770 }
7771
7772 /**
7773 * Add a set of extended data to the intent. The keys must include a package
7774 * prefix, for example the app com.android.contacts would use names
7775 * like "com.android.contacts.ShowAll".
7776 *
7777 * @param extras The Bundle of extras to add to this intent.
7778 *
7779 * @see #putExtra
7780 * @see #removeExtra
7781 */
7782 public Intent putExtras(Bundle extras) {
7783 if (mExtras == null) {
7784 mExtras = new Bundle();
7785 }
7786 mExtras.putAll(extras);
7787 return this;
7788 }
7789
7790 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007791 * Completely replace the extras in the Intent with the extras in the
7792 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007793 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007794 * @param src The exact extras contained in this Intent are copied
7795 * into the target intent, replacing any that were previously there.
7796 */
7797 public Intent replaceExtras(Intent src) {
7798 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7799 return this;
7800 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007801
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007802 /**
7803 * Completely replace the extras in the Intent with the given Bundle of
7804 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007805 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007806 * @param extras The new set of extras in the Intent, or null to erase
7807 * all extras.
7808 */
7809 public Intent replaceExtras(Bundle extras) {
7810 mExtras = extras != null ? new Bundle(extras) : null;
7811 return this;
7812 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007813
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007814 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007815 * Remove extended data from the intent.
7816 *
7817 * @see #putExtra
7818 */
7819 public void removeExtra(String name) {
7820 if (mExtras != null) {
7821 mExtras.remove(name);
7822 if (mExtras.size() == 0) {
7823 mExtras = null;
7824 }
7825 }
7826 }
7827
7828 /**
7829 * Set special flags controlling how this intent is handled. Most values
7830 * here depend on the type of component being executed by the Intent,
7831 * specifically the FLAG_ACTIVITY_* flags are all for use with
7832 * {@link Context#startActivity Context.startActivity()} and the
7833 * FLAG_RECEIVER_* flags are all for use with
7834 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7835 *
Scott Main7aee61f2011-02-08 11:25:01 -08007836 * <p>See the
7837 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7838 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007839 * the behavior of your application.
7840 *
7841 * @param flags The desired flags.
7842 *
7843 * @return Returns the same Intent object, for chaining multiple calls
7844 * into a single statement.
7845 *
7846 * @see #getFlags
7847 * @see #addFlags
7848 *
7849 * @see #FLAG_GRANT_READ_URI_PERMISSION
7850 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007851 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7852 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007853 * @see #FLAG_DEBUG_LOG_RESOLUTION
7854 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007855 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007856 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007857 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007858 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007859 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7860 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007861 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007862 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007863 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007864 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007865 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007866 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007867 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007868 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7869 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007870 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007871 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007872 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007873 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7874 */
7875 public Intent setFlags(int flags) {
7876 mFlags = flags;
7877 return this;
7878 }
7879
7880 /**
7881 * Add additional flags to the intent (or with existing flags
7882 * value).
7883 *
7884 * @param flags The new flags to set.
7885 *
7886 * @return Returns the same Intent object, for chaining multiple calls
7887 * into a single statement.
7888 *
7889 * @see #setFlags
7890 */
7891 public Intent addFlags(int flags) {
7892 mFlags |= flags;
7893 return this;
7894 }
7895
7896 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007897 * (Usually optional) Set an explicit application package name that limits
7898 * the components this Intent will resolve to. If left to the default
7899 * value of null, all components in all applications will considered.
7900 * If non-null, the Intent can only match the components in the given
7901 * application package.
7902 *
7903 * @param packageName The name of the application package to handle the
7904 * intent, or null to allow any application package.
7905 *
7906 * @return Returns the same Intent object, for chaining multiple calls
7907 * into a single statement.
7908 *
7909 * @see #getPackage
7910 * @see #resolveActivity
7911 */
7912 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007913 if (packageName != null && mSelector != null) {
7914 throw new IllegalArgumentException(
7915 "Can't set package name when selector is already set");
7916 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007917 mPackage = packageName;
7918 return this;
7919 }
7920
7921 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007922 * (Usually optional) Explicitly set the component to handle the intent.
7923 * If left with the default value of null, the system will determine the
7924 * appropriate class to use based on the other fields (action, data,
7925 * type, categories) in the Intent. If this class is defined, the
7926 * specified class will always be used regardless of the other fields. You
7927 * should only set this value when you know you absolutely want a specific
7928 * class to be used; otherwise it is better to let the system find the
7929 * appropriate class so that you will respect the installed applications
7930 * and user preferences.
7931 *
7932 * @param component The name of the application component to handle the
7933 * intent, or null to let the system find one for you.
7934 *
7935 * @return Returns the same Intent object, for chaining multiple calls
7936 * into a single statement.
7937 *
7938 * @see #setClass
7939 * @see #setClassName(Context, String)
7940 * @see #setClassName(String, String)
7941 * @see #getComponent
7942 * @see #resolveActivity
7943 */
7944 public Intent setComponent(ComponentName component) {
7945 mComponent = component;
7946 return this;
7947 }
7948
7949 /**
7950 * Convenience for calling {@link #setComponent} with an
7951 * explicit class name.
7952 *
7953 * @param packageContext A Context of the application package implementing
7954 * this class.
7955 * @param className The name of a class inside of the application package
7956 * that will be used as the component for this Intent.
7957 *
7958 * @return Returns the same Intent object, for chaining multiple calls
7959 * into a single statement.
7960 *
7961 * @see #setComponent
7962 * @see #setClass
7963 */
7964 public Intent setClassName(Context packageContext, String className) {
7965 mComponent = new ComponentName(packageContext, className);
7966 return this;
7967 }
7968
7969 /**
7970 * Convenience for calling {@link #setComponent} with an
7971 * explicit application package name and class name.
7972 *
7973 * @param packageName The name of the package implementing the desired
7974 * component.
7975 * @param className The name of a class inside of the application package
7976 * that will be used as the component for this Intent.
7977 *
7978 * @return Returns the same Intent object, for chaining multiple calls
7979 * into a single statement.
7980 *
7981 * @see #setComponent
7982 * @see #setClass
7983 */
7984 public Intent setClassName(String packageName, String className) {
7985 mComponent = new ComponentName(packageName, className);
7986 return this;
7987 }
7988
7989 /**
7990 * Convenience for calling {@link #setComponent(ComponentName)} with the
7991 * name returned by a {@link Class} object.
7992 *
7993 * @param packageContext A Context of the application package implementing
7994 * this class.
7995 * @param cls The class name to set, equivalent to
7996 * <code>setClassName(context, cls.getName())</code>.
7997 *
7998 * @return Returns the same Intent object, for chaining multiple calls
7999 * into a single statement.
8000 *
8001 * @see #setComponent
8002 */
8003 public Intent setClass(Context packageContext, Class<?> cls) {
8004 mComponent = new ComponentName(packageContext, cls);
8005 return this;
8006 }
8007
8008 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008009 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8010 * used as a hint to the receiver for animations and the like. Null means that there
8011 * is no source bounds.
8012 */
8013 public void setSourceBounds(Rect r) {
8014 if (r != null) {
8015 mSourceBounds = new Rect(r);
8016 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008017 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008018 }
8019 }
8020
Tor Norbyed9273d62013-05-30 15:59:53 -07008021 /** @hide */
8022 @IntDef(flag = true,
8023 value = {
8024 FILL_IN_ACTION,
8025 FILL_IN_DATA,
8026 FILL_IN_CATEGORIES,
8027 FILL_IN_COMPONENT,
8028 FILL_IN_PACKAGE,
8029 FILL_IN_SOURCE_BOUNDS,
8030 FILL_IN_SELECTOR,
8031 FILL_IN_CLIP_DATA
8032 })
8033 @Retention(RetentionPolicy.SOURCE)
8034 public @interface FillInFlags {}
8035
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008036 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008037 * Use with {@link #fillIn} to allow the current action value to be
8038 * overwritten, even if it is already set.
8039 */
8040 public static final int FILL_IN_ACTION = 1<<0;
8041
8042 /**
8043 * Use with {@link #fillIn} to allow the current data or type value
8044 * overwritten, even if it is already set.
8045 */
8046 public static final int FILL_IN_DATA = 1<<1;
8047
8048 /**
8049 * Use with {@link #fillIn} to allow the current categories to be
8050 * overwritten, even if they are already set.
8051 */
8052 public static final int FILL_IN_CATEGORIES = 1<<2;
8053
8054 /**
8055 * Use with {@link #fillIn} to allow the current component value to be
8056 * overwritten, even if it is already set.
8057 */
8058 public static final int FILL_IN_COMPONENT = 1<<3;
8059
8060 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008061 * Use with {@link #fillIn} to allow the current package value to be
8062 * overwritten, even if it is already set.
8063 */
8064 public static final int FILL_IN_PACKAGE = 1<<4;
8065
8066 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008067 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008068 * overwritten, even if it is already set.
8069 */
8070 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8071
8072 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008073 * Use with {@link #fillIn} to allow the current selector to be
8074 * overwritten, even if it is already set.
8075 */
8076 public static final int FILL_IN_SELECTOR = 1<<6;
8077
8078 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008079 * Use with {@link #fillIn} to allow the current ClipData to be
8080 * overwritten, even if it is already set.
8081 */
8082 public static final int FILL_IN_CLIP_DATA = 1<<7;
8083
8084 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008085 * Copy the contents of <var>other</var> in to this object, but only
8086 * where fields are not defined by this object. For purposes of a field
8087 * being defined, the following pieces of data in the Intent are
8088 * considered to be separate fields:
8089 *
8090 * <ul>
8091 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008092 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008093 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8094 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008095 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008096 * <li> component, as set by {@link #setComponent(ComponentName)} or
8097 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008098 * <li> source bounds, as set by {@link #setSourceBounds}.
8099 * <li> selector, as set by {@link #setSelector(Intent)}.
8100 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008101 * <li> each top-level name in the associated extras.
8102 * </ul>
8103 *
8104 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008105 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008106 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8107 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8108 * the restriction where the corresponding field will not be replaced if
8109 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008111 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8112 * is explicitly specified. The selector will only be copied if
8113 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008114 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008115 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8116 * and Intent B with {action="gotit", data-type="some/thing",
8117 * categories="one","two"}.
8118 *
8119 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8120 * containing: {action="gotit", data-type="some/thing",
8121 * categories="bar"}.
8122 *
8123 * @param other Another Intent whose values are to be used to fill in
8124 * the current one.
8125 * @param flags Options to control which fields can be filled in.
8126 *
8127 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008128 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008129 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8130 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8131 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008132 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008133 @FillInFlags
8134 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008135 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008136 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008137 if (other.mAction != null
8138 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008139 mAction = other.mAction;
8140 changes |= FILL_IN_ACTION;
8141 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008142 if ((other.mData != null || other.mType != null)
8143 && ((mData == null && mType == null)
8144 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008145 mData = other.mData;
8146 mType = other.mType;
8147 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008148 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008149 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008150 if (other.mCategories != null
8151 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008152 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008153 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008154 }
8155 changes |= FILL_IN_CATEGORIES;
8156 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008157 if (other.mPackage != null
8158 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008159 // Only do this if mSelector is not set.
8160 if (mSelector == null) {
8161 mPackage = other.mPackage;
8162 changes |= FILL_IN_PACKAGE;
8163 }
8164 }
8165 // Selector is special: it can only be set if explicitly allowed,
8166 // for the same reason as the component name.
8167 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8168 if (mPackage == null) {
8169 mSelector = new Intent(other.mSelector);
8170 mPackage = null;
8171 changes |= FILL_IN_SELECTOR;
8172 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008173 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008174 if (other.mClipData != null
8175 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8176 mClipData = other.mClipData;
8177 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008178 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008179 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008180 // Component is special: it can -only- be set if explicitly allowed,
8181 // since otherwise the sender could force the intent somewhere the
8182 // originator didn't intend.
8183 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008184 mComponent = other.mComponent;
8185 changes |= FILL_IN_COMPONENT;
8186 }
8187 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008188 if (other.mSourceBounds != null
8189 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8190 mSourceBounds = new Rect(other.mSourceBounds);
8191 changes |= FILL_IN_SOURCE_BOUNDS;
8192 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008193 if (mExtras == null) {
8194 if (other.mExtras != null) {
8195 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008196 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008197 }
8198 } else if (other.mExtras != null) {
8199 try {
8200 Bundle newb = new Bundle(other.mExtras);
8201 newb.putAll(mExtras);
8202 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008203 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008204 } catch (RuntimeException e) {
8205 // Modifying the extras can cause us to unparcel the contents
8206 // of the bundle, and if we do this in the system process that
8207 // may fail. We really should handle this (i.e., the Bundle
8208 // impl shouldn't be on top of a plain map), but for now just
8209 // ignore it and keep the original contents. :(
8210 Log.w("Intent", "Failure filling in extras", e);
8211 }
8212 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008213 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8214 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8215 mContentUserHint = other.mContentUserHint;
8216 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008217 return changes;
8218 }
8219
8220 /**
8221 * Wrapper class holding an Intent and implementing comparisons on it for
8222 * the purpose of filtering. The class implements its
8223 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8224 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8225 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8226 * on the wrapped Intent.
8227 */
8228 public static final class FilterComparison {
8229 private final Intent mIntent;
8230 private final int mHashCode;
8231
8232 public FilterComparison(Intent intent) {
8233 mIntent = intent;
8234 mHashCode = intent.filterHashCode();
8235 }
8236
8237 /**
8238 * Return the Intent that this FilterComparison represents.
8239 * @return Returns the Intent held by the FilterComparison. Do
8240 * not modify!
8241 */
8242 public Intent getIntent() {
8243 return mIntent;
8244 }
8245
8246 @Override
8247 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008248 if (obj instanceof FilterComparison) {
8249 Intent other = ((FilterComparison)obj).mIntent;
8250 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008251 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008252 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008253 }
8254
8255 @Override
8256 public int hashCode() {
8257 return mHashCode;
8258 }
8259 }
8260
8261 /**
8262 * Determine if two intents are the same for the purposes of intent
8263 * resolution (filtering). That is, if their action, data, type,
8264 * class, and categories are the same. This does <em>not</em> compare
8265 * any extra data included in the intents.
8266 *
8267 * @param other The other Intent to compare against.
8268 *
8269 * @return Returns true if action, data, type, class, and categories
8270 * are the same.
8271 */
8272 public boolean filterEquals(Intent other) {
8273 if (other == null) {
8274 return false;
8275 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008276 if (!Objects.equals(this.mAction, other.mAction)) return false;
8277 if (!Objects.equals(this.mData, other.mData)) return false;
8278 if (!Objects.equals(this.mType, other.mType)) return false;
8279 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8280 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8281 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008282
8283 return true;
8284 }
8285
8286 /**
8287 * Generate hash code that matches semantics of filterEquals().
8288 *
8289 * @return Returns the hash value of the action, data, type, class, and
8290 * categories.
8291 *
8292 * @see #filterEquals
8293 */
8294 public int filterHashCode() {
8295 int code = 0;
8296 if (mAction != null) {
8297 code += mAction.hashCode();
8298 }
8299 if (mData != null) {
8300 code += mData.hashCode();
8301 }
8302 if (mType != null) {
8303 code += mType.hashCode();
8304 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008305 if (mPackage != null) {
8306 code += mPackage.hashCode();
8307 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008308 if (mComponent != null) {
8309 code += mComponent.hashCode();
8310 }
8311 if (mCategories != null) {
8312 code += mCategories.hashCode();
8313 }
8314 return code;
8315 }
8316
8317 @Override
8318 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008319 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008320
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008321 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008322 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008323 b.append(" }");
8324
8325 return b.toString();
8326 }
8327
8328 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008329 public String toInsecureString() {
8330 StringBuilder b = new StringBuilder(128);
8331
8332 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008333 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008334 b.append(" }");
8335
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008336 return b.toString();
8337 }
Romain Guy4969af72009-06-17 10:53:19 -07008338
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008339 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008340 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008341 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008342
8343 b.append("Intent { ");
8344 toShortString(b, false, true, true, true);
8345 b.append(" }");
8346
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008347 return b.toString();
8348 }
8349
8350 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008351 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8352 StringBuilder b = new StringBuilder(128);
8353 toShortString(b, secure, comp, extras, clip);
8354 return b.toString();
8355 }
8356
8357 /** @hide */
8358 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8359 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008360 boolean first = true;
8361 if (mAction != null) {
8362 b.append("act=").append(mAction);
8363 first = false;
8364 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008365 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008366 if (!first) {
8367 b.append(' ');
8368 }
8369 first = false;
8370 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008371 for (int i=0; i<mCategories.size(); i++) {
8372 if (i > 0) b.append(',');
8373 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008374 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008375 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008376 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008377 if (mData != null) {
8378 if (!first) {
8379 b.append(' ');
8380 }
8381 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008382 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008383 if (secure) {
8384 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008385 } else {
8386 b.append(mData);
8387 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008388 }
8389 if (mType != null) {
8390 if (!first) {
8391 b.append(' ');
8392 }
8393 first = false;
8394 b.append("typ=").append(mType);
8395 }
8396 if (mFlags != 0) {
8397 if (!first) {
8398 b.append(' ');
8399 }
8400 first = false;
8401 b.append("flg=0x").append(Integer.toHexString(mFlags));
8402 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008403 if (mPackage != null) {
8404 if (!first) {
8405 b.append(' ');
8406 }
8407 first = false;
8408 b.append("pkg=").append(mPackage);
8409 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008410 if (comp && mComponent != null) {
8411 if (!first) {
8412 b.append(' ');
8413 }
8414 first = false;
8415 b.append("cmp=").append(mComponent.flattenToShortString());
8416 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008417 if (mSourceBounds != null) {
8418 if (!first) {
8419 b.append(' ');
8420 }
8421 first = false;
8422 b.append("bnds=").append(mSourceBounds.toShortString());
8423 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008424 if (mClipData != null) {
8425 if (!first) {
8426 b.append(' ');
8427 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008428 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008429 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008430 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008431 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008432 if (mClipData.getDescription() != null) {
8433 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8434 } else {
8435 first = true;
8436 }
8437 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008438 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008439 first = false;
8440 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008441 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008442 if (extras && mExtras != null) {
8443 if (!first) {
8444 b.append(' ');
8445 }
8446 first = false;
8447 b.append("(has extras)");
8448 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008449 if (mContentUserHint != UserHandle.USER_CURRENT) {
8450 if (!first) {
8451 b.append(' ');
8452 }
8453 first = false;
8454 b.append("u=").append(mContentUserHint);
8455 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008456 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008457 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008458 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008459 b.append("}");
8460 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008461 }
8462
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008463 /**
8464 * Call {@link #toUri} with 0 flags.
8465 * @deprecated Use {@link #toUri} instead.
8466 */
8467 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008468 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008469 return toUri(0);
8470 }
8471
8472 /**
8473 * Convert this Intent into a String holding a URI representation of it.
8474 * The returned URI string has been properly URI encoded, so it can be
8475 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8476 * Intent's data as the base URI, with an additional fragment describing
8477 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008478 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008479 * <p>You can convert the returned string back to an Intent with
8480 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008481 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008482 * @param flags Additional operating flags. Either 0,
8483 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008484 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008485 * @return Returns a URI encoding URI string describing the entire contents
8486 * of the Intent.
8487 */
8488 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008489 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008490 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8491 if (mPackage == null) {
8492 throw new IllegalArgumentException(
8493 "Intent must include an explicit package name to build an android-app: "
8494 + this);
8495 }
8496 uri.append("android-app://");
8497 uri.append(mPackage);
8498 String scheme = null;
8499 if (mData != null) {
8500 scheme = mData.getScheme();
8501 if (scheme != null) {
8502 uri.append('/');
8503 uri.append(scheme);
8504 String authority = mData.getEncodedAuthority();
8505 if (authority != null) {
8506 uri.append('/');
8507 uri.append(authority);
8508 String path = mData.getEncodedPath();
8509 if (path != null) {
8510 uri.append(path);
8511 }
8512 String queryParams = mData.getEncodedQuery();
8513 if (queryParams != null) {
8514 uri.append('?');
8515 uri.append(queryParams);
8516 }
8517 String fragment = mData.getEncodedFragment();
8518 if (fragment != null) {
8519 uri.append('#');
8520 uri.append(fragment);
8521 }
8522 }
8523 }
8524 }
8525 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8526 mPackage, flags);
8527 return uri.toString();
8528 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008529 String scheme = null;
8530 if (mData != null) {
8531 String data = mData.toString();
8532 if ((flags&URI_INTENT_SCHEME) != 0) {
8533 final int N = data.length();
8534 for (int i=0; i<N; i++) {
8535 char c = data.charAt(i);
8536 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8537 || c == '.' || c == '-') {
8538 continue;
8539 }
8540 if (c == ':' && i > 0) {
8541 // Valid scheme.
8542 scheme = data.substring(0, i);
8543 uri.append("intent:");
8544 data = data.substring(i+1);
8545 break;
8546 }
Tom Taylord4a47292009-12-21 13:59:18 -08008547
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008548 // No scheme.
8549 break;
8550 }
8551 }
8552 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008553
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008554 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8555 uri.append("intent:");
8556 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008557
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008558 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008559
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008560 return uri.toString();
8561 }
8562
8563 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8564 String defPackage, int flags) {
8565 StringBuilder frag = new StringBuilder(128);
8566
8567 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008568 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008569 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008570 // Note that for now we are not going to try to handle the
8571 // data part; not clear how to represent this as a URI, and
8572 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008573 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8574 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008575 }
8576
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008577 if (frag.length() > 0) {
8578 uri.append("#Intent;");
8579 uri.append(frag);
8580 uri.append("end");
8581 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008582 }
8583
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008584 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8585 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008586 if (scheme != null) {
8587 uri.append("scheme=").append(scheme).append(';');
8588 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008589 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008590 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008591 }
8592 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008593 for (int i=0; i<mCategories.size(); i++) {
8594 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008595 }
8596 }
8597 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008598 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008599 }
8600 if (mFlags != 0) {
8601 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8602 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008603 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008604 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8605 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008606 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008607 uri.append("component=").append(Uri.encode(
8608 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008609 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008610 if (mSourceBounds != null) {
8611 uri.append("sourceBounds=")
8612 .append(Uri.encode(mSourceBounds.flattenToString()))
8613 .append(';');
8614 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008615 if (mExtras != null) {
8616 for (String key : mExtras.keySet()) {
8617 final Object value = mExtras.get(key);
8618 char entryType =
8619 value instanceof String ? 'S' :
8620 value instanceof Boolean ? 'B' :
8621 value instanceof Byte ? 'b' :
8622 value instanceof Character ? 'c' :
8623 value instanceof Double ? 'd' :
8624 value instanceof Float ? 'f' :
8625 value instanceof Integer ? 'i' :
8626 value instanceof Long ? 'l' :
8627 value instanceof Short ? 's' :
8628 '\0';
8629
8630 if (entryType != '\0') {
8631 uri.append(entryType);
8632 uri.append('.');
8633 uri.append(Uri.encode(key));
8634 uri.append('=');
8635 uri.append(Uri.encode(value.toString()));
8636 uri.append(';');
8637 }
8638 }
8639 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008640 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008642 public int describeContents() {
8643 return (mExtras != null) ? mExtras.describeContents() : 0;
8644 }
8645
8646 public void writeToParcel(Parcel out, int flags) {
8647 out.writeString(mAction);
8648 Uri.writeToParcel(out, mData);
8649 out.writeString(mType);
8650 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008651 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008652 ComponentName.writeToParcel(mComponent, out);
8653
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008654 if (mSourceBounds != null) {
8655 out.writeInt(1);
8656 mSourceBounds.writeToParcel(out, flags);
8657 } else {
8658 out.writeInt(0);
8659 }
8660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008661 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008662 final int N = mCategories.size();
8663 out.writeInt(N);
8664 for (int i=0; i<N; i++) {
8665 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008666 }
8667 } else {
8668 out.writeInt(0);
8669 }
8670
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008671 if (mSelector != null) {
8672 out.writeInt(1);
8673 mSelector.writeToParcel(out, flags);
8674 } else {
8675 out.writeInt(0);
8676 }
8677
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008678 if (mClipData != null) {
8679 out.writeInt(1);
8680 mClipData.writeToParcel(out, flags);
8681 } else {
8682 out.writeInt(0);
8683 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008684 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008685 out.writeBundle(mExtras);
8686 }
8687
8688 public static final Parcelable.Creator<Intent> CREATOR
8689 = new Parcelable.Creator<Intent>() {
8690 public Intent createFromParcel(Parcel in) {
8691 return new Intent(in);
8692 }
8693 public Intent[] newArray(int size) {
8694 return new Intent[size];
8695 }
8696 };
8697
Dianne Hackborneb034652009-09-07 00:49:58 -07008698 /** @hide */
8699 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008700 readFromParcel(in);
8701 }
8702
8703 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008704 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008705 mData = Uri.CREATOR.createFromParcel(in);
8706 mType = in.readString();
8707 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008708 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008709 mComponent = ComponentName.readFromParcel(in);
8710
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008711 if (in.readInt() != 0) {
8712 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8713 }
8714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008715 int N = in.readInt();
8716 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008717 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008718 int i;
8719 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008720 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008721 }
8722 } else {
8723 mCategories = null;
8724 }
8725
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008726 if (in.readInt() != 0) {
8727 mSelector = new Intent(in);
8728 }
8729
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008730 if (in.readInt() != 0) {
8731 mClipData = new ClipData(in);
8732 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008733 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008734 mExtras = in.readBundle();
8735 }
8736
8737 /**
8738 * Parses the "intent" element (and its children) from XML and instantiates
8739 * an Intent object. The given XML parser should be located at the tag
8740 * where parsing should start (often named "intent"), from which the
8741 * basic action, data, type, and package and class name will be
8742 * retrieved. The function will then parse in to any child elements,
8743 * looking for <category android:name="xxx"> tags to add categories and
8744 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8745 * to the intent.
8746 *
8747 * @param resources The Resources to use when inflating resources.
8748 * @param parser The XML parser pointing at an "intent" tag.
8749 * @param attrs The AttributeSet interface for retrieving extended
8750 * attribute data at the current <var>parser</var> location.
8751 * @return An Intent object matching the XML data.
8752 * @throws XmlPullParserException If there was an XML parsing error.
8753 * @throws IOException If there was an I/O error.
8754 */
8755 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8756 throws XmlPullParserException, IOException {
8757 Intent intent = new Intent();
8758
8759 TypedArray sa = resources.obtainAttributes(attrs,
8760 com.android.internal.R.styleable.Intent);
8761
8762 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8763
8764 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8765 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8766 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8767
8768 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8769 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8770 if (packageName != null && className != null) {
8771 intent.setComponent(new ComponentName(packageName, className));
8772 }
8773
8774 sa.recycle();
8775
8776 int outerDepth = parser.getDepth();
8777 int type;
8778 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8779 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8780 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8781 continue;
8782 }
8783
8784 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008785 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008786 sa = resources.obtainAttributes(attrs,
8787 com.android.internal.R.styleable.IntentCategory);
8788 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8789 sa.recycle();
8790
8791 if (cat != null) {
8792 intent.addCategory(cat);
8793 }
8794 XmlUtils.skipCurrentTag(parser);
8795
Craig Mautner21d24a22014-04-23 11:45:37 -07008796 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008797 if (intent.mExtras == null) {
8798 intent.mExtras = new Bundle();
8799 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008800 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008801 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008802
8803 } else {
8804 XmlUtils.skipCurrentTag(parser);
8805 }
8806 }
8807
8808 return intent;
8809 }
Nick Pellyccae4122012-01-09 14:12:58 -08008810
Craig Mautner21d24a22014-04-23 11:45:37 -07008811 /** @hide */
8812 public void saveToXml(XmlSerializer out) throws IOException {
8813 if (mAction != null) {
8814 out.attribute(null, ATTR_ACTION, mAction);
8815 }
8816 if (mData != null) {
8817 out.attribute(null, ATTR_DATA, mData.toString());
8818 }
8819 if (mType != null) {
8820 out.attribute(null, ATTR_TYPE, mType);
8821 }
8822 if (mComponent != null) {
8823 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8824 }
8825 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8826
8827 if (mCategories != null) {
8828 out.startTag(null, TAG_CATEGORIES);
8829 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8830 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8831 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008832 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008833 }
8834 }
8835
8836 /** @hide */
8837 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8838 XmlPullParserException {
8839 Intent intent = new Intent();
8840 final int outerDepth = in.getDepth();
8841
8842 int attrCount = in.getAttributeCount();
8843 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8844 final String attrName = in.getAttributeName(attrNdx);
8845 final String attrValue = in.getAttributeValue(attrNdx);
8846 if (ATTR_ACTION.equals(attrName)) {
8847 intent.setAction(attrValue);
8848 } else if (ATTR_DATA.equals(attrName)) {
8849 intent.setData(Uri.parse(attrValue));
8850 } else if (ATTR_TYPE.equals(attrName)) {
8851 intent.setType(attrValue);
8852 } else if (ATTR_COMPONENT.equals(attrName)) {
8853 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8854 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008855 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008856 } else {
8857 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8858 }
8859 }
8860
8861 int event;
8862 String name;
8863 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8864 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8865 if (event == XmlPullParser.START_TAG) {
8866 name = in.getName();
8867 if (TAG_CATEGORIES.equals(name)) {
8868 attrCount = in.getAttributeCount();
8869 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8870 intent.addCategory(in.getAttributeValue(attrNdx));
8871 }
8872 } else {
8873 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8874 XmlUtils.skipCurrentTag(in);
8875 }
8876 }
8877 }
8878
8879 return intent;
8880 }
8881
Nick Pellyccae4122012-01-09 14:12:58 -08008882 /**
8883 * Normalize a MIME data type.
8884 *
8885 * <p>A normalized MIME type has white-space trimmed,
8886 * content-type parameters removed, and is lower-case.
8887 * This aligns the type with Android best practices for
8888 * intent filtering.
8889 *
8890 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8891 * "text/x-vCard" becomes "text/x-vcard".
8892 *
8893 * <p>All MIME types received from outside Android (such as user input,
8894 * or external sources like Bluetooth, NFC, or the Internet) should
8895 * be normalized before they are used to create an Intent.
8896 *
8897 * @param type MIME data type to normalize
8898 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008899 * @see #setType
8900 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008901 */
8902 public static String normalizeMimeType(String type) {
8903 if (type == null) {
8904 return null;
8905 }
8906
Elliott Hughescb64d432013-08-02 10:00:44 -07008907 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008908
8909 final int semicolonIndex = type.indexOf(';');
8910 if (semicolonIndex != -1) {
8911 type = type.substring(0, semicolonIndex);
8912 }
8913 return type;
8914 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008915
8916 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008917 * Prepare this {@link Intent} to leave an app process.
8918 *
8919 * @hide
8920 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008921 public void prepareToLeaveProcess(Context context) {
8922 final boolean leavingPackage = (mComponent == null)
8923 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8924 prepareToLeaveProcess(leavingPackage);
8925 }
8926
8927 /**
8928 * Prepare this {@link Intent} to leave an app process.
8929 *
8930 * @hide
8931 */
8932 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008933 setAllowFds(false);
8934
8935 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008936 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008937 }
8938 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008939 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008940 }
8941
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008942 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8943 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008944 switch (mAction) {
8945 case ACTION_MEDIA_REMOVED:
8946 case ACTION_MEDIA_UNMOUNTED:
8947 case ACTION_MEDIA_CHECKING:
8948 case ACTION_MEDIA_NOFS:
8949 case ACTION_MEDIA_MOUNTED:
8950 case ACTION_MEDIA_SHARED:
8951 case ACTION_MEDIA_UNSHARED:
8952 case ACTION_MEDIA_BAD_REMOVAL:
8953 case ACTION_MEDIA_UNMOUNTABLE:
8954 case ACTION_MEDIA_EJECT:
8955 case ACTION_MEDIA_SCANNER_STARTED:
8956 case ACTION_MEDIA_SCANNER_FINISHED:
8957 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008958 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8959 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008960 // Ignore legacy actions
8961 break;
8962 default:
8963 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008964 }
8965 }
8966 }
8967
8968 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008969 * @hide
8970 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008971 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008972 // We just entered destination process, so we should be able to read all
8973 // parcelables inside.
8974 setDefusable(true);
8975
8976 if (mSelector != null) {
8977 mSelector.prepareToEnterProcess();
8978 }
8979 if (mClipData != null) {
8980 mClipData.prepareToEnterProcess();
8981 }
8982
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008983 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008984 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8985 fixUris(mContentUserHint);
8986 mContentUserHint = UserHandle.USER_CURRENT;
8987 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008988 }
8989 }
8990
8991 /**
8992 * @hide
8993 */
8994 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008995 Uri data = getData();
8996 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008997 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008998 }
8999 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009000 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009001 }
9002 String action = getAction();
9003 if (ACTION_SEND.equals(action)) {
9004 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9005 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009006 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009007 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009008 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009009 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9010 if (streams != null) {
9011 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9012 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009013 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009014 }
9015 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9016 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009017 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9018 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9019 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9020 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9021 if (output != null) {
9022 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9023 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009024 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009025 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009026
9027 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009028 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009029 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9030 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009031 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009032 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009033 * @hide
9034 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009035 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009036 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009037 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009038
9039 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009040 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009041
9042 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009043 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009044 // Inspect contained intents to see if we need to migrate extras. We
9045 // don't promote ClipData to the parent, since ChooserActivity will
9046 // already start the picked item as the caller, and we can't combine
9047 // the flags in a safe way.
9048
9049 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009050 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009051 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9052 if (intent != null) {
9053 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009054 }
9055 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009056 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009057 try {
9058 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9059 if (intents != null) {
9060 for (int i = 0; i < intents.length; i++) {
9061 final Intent intent = (Intent) intents[i];
9062 if (intent != null) {
9063 migrated |= intent.migrateExtraStreamToClipData();
9064 }
9065 }
9066 }
9067 } catch (ClassCastException e) {
9068 }
9069 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009070
9071 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009072 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009073 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9074 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9075 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9076 if (stream != null || text != null || htmlText != null) {
9077 final ClipData clipData = new ClipData(
9078 null, new String[] { getType() },
9079 new ClipData.Item(text, htmlText, null, stream));
9080 setClipData(clipData);
9081 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009082 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009083 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009084 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009085 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009086
9087 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009088 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009089 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9090 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9091 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9092 int num = -1;
9093 if (streams != null) {
9094 num = streams.size();
9095 }
9096 if (texts != null) {
9097 if (num >= 0 && num != texts.size()) {
9098 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009099 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009100 }
9101 num = texts.size();
9102 }
9103 if (htmlTexts != null) {
9104 if (num >= 0 && num != htmlTexts.size()) {
9105 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009106 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009107 }
9108 num = htmlTexts.size();
9109 }
9110 if (num > 0) {
9111 final ClipData clipData = new ClipData(
9112 null, new String[] { getType() },
9113 makeClipItem(streams, texts, htmlTexts, 0));
9114
9115 for (int i = 1; i < num; i++) {
9116 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9117 }
9118
9119 setClipData(clipData);
9120 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009121 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009122 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009123 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009124 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009125 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9126 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9127 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9128 final Uri output;
9129 try {
9130 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9131 } catch (ClassCastException e) {
9132 return false;
9133 }
9134 if (output != null) {
9135 setClipData(ClipData.newRawUri("", output));
9136 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9137 return true;
9138 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009139 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009140
9141 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009142 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009143
9144 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9145 ArrayList<String> htmlTexts, int which) {
9146 Uri uri = streams != null ? streams.get(which) : null;
9147 CharSequence text = texts != null ? texts.get(which) : null;
9148 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9149 return new ClipData.Item(text, htmlText, null, uri);
9150 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009151
9152 /** @hide */
9153 public boolean isDocument() {
9154 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9155 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009156}