blob: 2df25d8ce22fbe28e75033f3152561c9c78d6473 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Tor Norbye7b9c9122013-05-30 16:48:33 -070019import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070020import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import android.annotation.SdkConstant;
22import android.annotation.SdkConstant.SdkConstantType;
Jason Monk2f68e8a2016-02-23 17:57:28 -050023import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070024import android.content.pm.ActivityInfo;
Jason Monk2f68e8a2016-02-23 17:57:28 -050025import android.content.pm.ApplicationInfo;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060026import android.content.pm.ComponentInfo;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -060033import android.os.Build;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.os.Bundle;
35import android.os.IBinder;
36import android.os.Parcel;
37import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000038import android.os.Process;
Jason Monk2f68e8a2016-02-23 17:57:28 -050039import android.os.ResultReceiver;
40import android.os.ShellCommand;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070041import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010042import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070043import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070044import android.provider.DocumentsProvider;
Jason Monk2f68e8a2016-02-23 17:57:28 -050045import android.provider.MediaStore;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070046import android.provider.OpenableColumns;
Jason Monk2f68e8a2016-02-23 17:57:28 -050047import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import android.util.AttributeSet;
49import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080050import com.android.internal.util.XmlUtils;
Jason Monk2f68e8a2016-02-23 17:57:28 -050051import org.xmlpull.v1.XmlPullParser;
52import org.xmlpull.v1.XmlPullParserException;
Craig Mautner21d24a22014-04-23 11:45:37 -070053import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054
55import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080056import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070057import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070063import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080064import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070065import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.util.Set;
67
Jason Monk2f68e8a2016-02-23 17:57:28 -050068import static android.content.ContentProvider.maybeAddUserId;
69
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070070/**
71 * An intent is an abstract description of an operation to be performed. It
72 * can be used with {@link Context#startActivity(Intent) startActivity} to
73 * launch an {@link android.app.Activity},
74 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
75 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
76 * and {@link android.content.Context#startService} or
77 * {@link android.content.Context#bindService} to communicate with a
78 * background {@link android.app.Service}.
79 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070080 * <p>An Intent provides a facility for performing late runtime binding between the code in
81 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070082 * can be thought of as the glue between activities. It is basically a passive data structure
83 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 *
85 * <div class="special reference">
86 * <h3>Developer Guides</h3>
87 * <p>For information about how to create and resolve intents, read the
88 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
89 * developer guide.</p>
90 * </div>
91 *
92 * <a name="IntentStructure"></a>
93 * <h3>Intent Structure</h3>
94 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 *
96 * <ul>
97 * <li> <p><b>action</b> -- The general action to be performed, such as
98 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
99 * etc.</p>
100 * </li>
101 * <li> <p><b>data</b> -- The data to operate on, such as a person record
102 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
103 * </li>
104 * </ul>
105 *
106 *
107 * <p>Some examples of action/data pairs are:</p>
108 *
109 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * information about the person whose identifier is "1".</p>
112 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700113 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700114 * the phone dialer with the person filled in.</p>
115 * </li>
116 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
117 * the phone dialer with the given number filled in. Note how the
Trevor Johns682c24e2016-04-12 10:13:47 -0700118 * VIEW action does what is considered the most reasonable thing for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
Kevin Hufnagleaedfd752016-09-08 21:56:25 -0700131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/people/N</i></b> }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
Trevor Johns682c24e2016-04-12 10:13:47 -0700189 * These strings use Java-style scoping, to ensure they are unique -- for
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700190 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700191 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700192 *
193 * <p>Put together, the set of actions, data types, categories, and extra data
194 * defines a language for the system allowing for the expression of phrases
195 * such as "call john smith's cell". As applications are added to the system,
196 * they can extend this language by adding new actions, types, and categories, or
197 * they can modify the behavior of existing phrases by supplying their own
198 * activities that handle them.</p>
199 *
200 * <a name="IntentResolution"></a>
201 * <h3>Intent Resolution</h3>
202 *
203 * <p>There are two primary forms of intents you will use.
204 *
205 * <ul>
206 * <li> <p><b>Explicit Intents</b> have specified a component (via
207 * {@link #setComponent} or {@link #setClass}), which provides the exact
208 * class to be run. Often these will not include any other information,
209 * simply being a way for an application to launch various internal
210 * activities it has as the user interacts with the application.
211 *
212 * <li> <p><b>Implicit Intents</b> have not specified a component;
213 * instead, they must include enough information for the system to
214 * determine which of the available components is best to run for that
215 * intent.
216 * </ul>
217 *
218 * <p>When using implicit intents, given such an arbitrary intent we need to
219 * know what to do with it. This is handled by the process of <em>Intent
220 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
221 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
222 * more activities/receivers) that can handle it.</p>
223 *
224 * <p>The intent resolution mechanism basically revolves around matching an
225 * Intent against all of the &lt;intent-filter&gt; descriptions in the
226 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
227 * objects explicitly registered with {@link Context#registerReceiver}.) More
228 * details on this can be found in the documentation on the {@link
229 * IntentFilter} class.</p>
230 *
231 * <p>There are three pieces of information in the Intent that are used for
232 * resolution: the action, type, and category. Using this information, a query
233 * is done on the {@link PackageManager} for a component that can handle the
234 * intent. The appropriate component is determined based on the intent
235 * information supplied in the <code>AndroidManifest.xml</code> file as
236 * follows:</p>
237 *
238 * <ul>
239 * <li> <p>The <b>action</b>, if given, must be listed by the component as
240 * one it handles.</p>
241 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
242 * already supplied in the Intent. Like the action, if a type is
243 * included in the intent (either explicitly or implicitly in its
244 * data), then this must be listed by the component as one it handles.</p>
245 * <li> For data that is not a <code>content:</code> URI and where no explicit
246 * type is included in the Intent, instead the <b>scheme</b> of the
247 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
248 * considered. Again like the action, if we are matching a scheme it
249 * must be listed by the component as one it can handle.
250 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
251 * by the activity as categories it handles. That is, if you include
252 * the categories {@link #CATEGORY_LAUNCHER} and
253 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
254 * with an intent that lists <em>both</em> of those categories.
255 * Activities will very often need to support the
256 * {@link #CATEGORY_DEFAULT} so that they can be found by
257 * {@link Context#startActivity Context.startActivity()}.</p>
258 * </ul>
259 *
260 * <p>For example, consider the Note Pad sample application that
261 * allows user to browse through a list of notes data and view details about
262 * individual items. Text in italics indicate places were you would replace a
263 * name with one specific to your own package.</p>
264 *
265 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
266 * package="<i>com.android.notepad</i>"&gt;
267 * &lt;application android:icon="@drawable/app_notes"
268 * android:label="@string/app_name"&gt;
269 *
270 * &lt;provider class=".NotePadProvider"
271 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
272 *
273 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
274 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700275 * &lt;action android:name="android.intent.action.MAIN" /&gt;
276 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.VIEW" /&gt;
280 * &lt;action android:name="android.intent.action.EDIT" /&gt;
281 * &lt;action android:name="android.intent.action.PICK" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700286 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
287 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
288 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700289 * &lt;/intent-filter&gt;
290 * &lt;/activity&gt;
291 *
292 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
293 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700294 * &lt;action android:name="android.intent.action.VIEW" /&gt;
295 * &lt;action android:name="android.intent.action.EDIT" /&gt;
296 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 *
300 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="android.intent.action.INSERT" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700304 * &lt;/intent-filter&gt;
305 *
306 * &lt;/activity&gt;
307 *
308 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
309 * android:theme="@android:style/Theme.Dialog"&gt;
310 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
312 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
313 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
314 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
315 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700316 * &lt;/intent-filter&gt;
317 * &lt;/activity&gt;
318 *
319 * &lt;/application&gt;
320 * &lt;/manifest&gt;</pre>
321 *
322 * <p>The first activity,
323 * <code>com.android.notepad.NotesList</code>, serves as our main
324 * entry into the app. It can do three things as described by its three intent
325 * templates:
326 * <ol>
327 * <li><pre>
328 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700329 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
330 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700331 * &lt;/intent-filter&gt;</pre>
332 * <p>This provides a top-level entry into the NotePad application: the standard
333 * MAIN action is a main entry point (not requiring any other information in
334 * the Intent), and the LAUNCHER category says that this entry point should be
335 * listed in the application launcher.</p>
336 * <li><pre>
337 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700338 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
339 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
340 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
341 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
Trevor Johns682c24e2016-04-12 10:13:47 -0700342 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700343 * &lt;/intent-filter&gt;</pre>
344 * <p>This declares the things that the activity can do on a directory of
345 * notes. The type being supported is given with the &lt;type&gt; tag, where
346 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
347 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
348 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
349 * The activity allows the user to view or edit the directory of data (via
350 * the VIEW and EDIT actions), or to pick a particular note and return it
351 * to the caller (via the PICK action). Note also the DEFAULT category
352 * supplied here: this is <em>required</em> for the
353 * {@link Context#startActivity Context.startActivity} method to resolve your
354 * activity when its component name is not explicitly specified.</p>
355 * <li><pre>
356 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700357 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
358 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
359 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700360 * &lt;/intent-filter&gt;</pre>
Trevor Johns682c24e2016-04-12 10:13:47 -0700361 * <p>This filter describes the ability to return to the caller a note selected by
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * the user without needing to know where it came from. The data type
363 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
364 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
365 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
366 * The GET_CONTENT action is similar to the PICK action, where the activity
367 * will return to its caller a piece of data selected by the user. Here,
368 * however, the caller specifies the type of data they desire instead of
369 * the type of data the user will be picking from.</p>
370 * </ol>
371 *
372 * <p>Given these capabilities, the following intents will resolve to the
373 * NotesList activity:</p>
374 *
375 * <ul>
376 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
377 * activities that can be used as top-level entry points into an
378 * application.</p>
379 * <li> <p><b>{ action=android.app.action.MAIN,
380 * category=android.app.category.LAUNCHER }</b> is the actual intent
381 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700382 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700383 * data=content://com.google.provider.NotePad/notes }</b>
384 * displays a list of all the notes under
385 * "content://com.google.provider.NotePad/notes", which
386 * the user can browse through and see the details on.</p>
387 * <li> <p><b>{ action=android.app.action.PICK
388 * data=content://com.google.provider.NotePad/notes }</b>
389 * provides a list of the notes under
390 * "content://com.google.provider.NotePad/notes", from which
391 * the user can pick a note whose data URL is returned back to the caller.</p>
392 * <li> <p><b>{ action=android.app.action.GET_CONTENT
393 * type=vnd.android.cursor.item/vnd.google.note }</b>
394 * is similar to the pick action, but allows the caller to specify the
395 * kind of data they want back so that the system can find the appropriate
396 * activity to pick something of that data type.</p>
397 * </ul>
398 *
399 * <p>The second activity,
400 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
401 * note entry and allows them to edit it. It can do two things as described
402 * by its two intent templates:
403 * <ol>
404 * <li><pre>
405 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700406 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
407 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
408 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
409 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700410 * &lt;/intent-filter&gt;</pre>
411 * <p>The first, primary, purpose of this activity is to let the user interact
412 * with a single note, as decribed by the MIME type
413 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
414 * either VIEW a note or allow the user to EDIT it. Again we support the
415 * DEFAULT category to allow the activity to be launched without explicitly
416 * specifying its component.</p>
417 * <li><pre>
418 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700419 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
420 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
421 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700422 * &lt;/intent-filter&gt;</pre>
423 * <p>The secondary use of this activity is to insert a new note entry into
424 * an existing directory of notes. This is used when the user creates a new
425 * note: the INSERT action is executed on the directory of notes, causing
426 * this activity to run and have the user create the new note data which
427 * it then adds to the content provider.</p>
428 * </ol>
429 *
430 * <p>Given these capabilities, the following intents will resolve to the
431 * NoteEditor activity:</p>
432 *
433 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700434 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * shows the user the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.EDIT
438 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
439 * allows the user to edit the content of note <var>{ID}</var>.</p>
440 * <li> <p><b>{ action=android.app.action.INSERT
441 * data=content://com.google.provider.NotePad/notes }</b>
442 * creates a new, empty note in the notes list at
443 * "content://com.google.provider.NotePad/notes"
444 * and allows the user to edit it. If they keep their changes, the URI
445 * of the newly created note is returned to the caller.</p>
446 * </ul>
447 *
448 * <p>The last activity,
449 * <code>com.android.notepad.TitleEditor</code>, allows the user to
450 * edit the title of a note. This could be implemented as a class that the
451 * application directly invokes (by explicitly setting its component in
452 * the Intent), but here we show a way you can publish alternative
453 * operations on existing data:</p>
454 *
455 * <pre>
456 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700457 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
458 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
459 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
460 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
461 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700462 * &lt;/intent-filter&gt;</pre>
463 *
464 * <p>In the single intent template here, we
465 * have created our own private action called
466 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
467 * edit the title of a note. It must be invoked on a specific note
468 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
469 * view and edit actions, but here displays and edits the title contained
470 * in the note data.
471 *
472 * <p>In addition to supporting the default category as usual, our title editor
473 * also supports two other standard categories: ALTERNATIVE and
474 * SELECTED_ALTERNATIVE. Implementing
475 * these categories allows others to find the special action it provides
476 * without directly knowing about it, through the
477 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
478 * more often to build dynamic menu items with
479 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
480 * template here was also supply an explicit name for the template
481 * (via <code>android:label="@string/resolve_title"</code>) to better control
482 * what the user sees when presented with this activity as an alternative
483 * action to the data they are viewing.
484 *
485 * <p>Given these capabilities, the following intent will resolve to the
486 * TitleEditor activity:</p>
487 *
488 * <ul>
489 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
490 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
491 * displays and allows the user to edit the title associated
492 * with note <var>{ID}</var>.</p>
493 * </ul>
494 *
495 * <h3>Standard Activity Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for launching
498 * activities (usually through {@link Context#startActivity}. The most
499 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
500 * {@link #ACTION_EDIT}.
501 *
502 * <ul>
503 * <li> {@link #ACTION_MAIN}
504 * <li> {@link #ACTION_VIEW}
505 * <li> {@link #ACTION_ATTACH_DATA}
506 * <li> {@link #ACTION_EDIT}
507 * <li> {@link #ACTION_PICK}
508 * <li> {@link #ACTION_CHOOSER}
509 * <li> {@link #ACTION_GET_CONTENT}
510 * <li> {@link #ACTION_DIAL}
511 * <li> {@link #ACTION_CALL}
512 * <li> {@link #ACTION_SEND}
513 * <li> {@link #ACTION_SENDTO}
514 * <li> {@link #ACTION_ANSWER}
515 * <li> {@link #ACTION_INSERT}
516 * <li> {@link #ACTION_DELETE}
517 * <li> {@link #ACTION_RUN}
518 * <li> {@link #ACTION_SYNC}
519 * <li> {@link #ACTION_PICK_ACTIVITY}
520 * <li> {@link #ACTION_SEARCH}
521 * <li> {@link #ACTION_WEB_SEARCH}
522 * <li> {@link #ACTION_FACTORY_TEST}
523 * </ul>
524 *
525 * <h3>Standard Broadcast Actions</h3>
526 *
527 * <p>These are the current standard actions that Intent defines for receiving
528 * broadcasts (usually through {@link Context#registerReceiver} or a
529 * &lt;receiver&gt; tag in a manifest).
530 *
531 * <ul>
532 * <li> {@link #ACTION_TIME_TICK}
533 * <li> {@link #ACTION_TIME_CHANGED}
534 * <li> {@link #ACTION_TIMEZONE_CHANGED}
535 * <li> {@link #ACTION_BOOT_COMPLETED}
536 * <li> {@link #ACTION_PACKAGE_ADDED}
537 * <li> {@link #ACTION_PACKAGE_CHANGED}
538 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #ACTION_PACKAGE_RESTARTED}
540 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000541 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
542 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #ACTION_UID_REMOVED}
544 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700545 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700546 * <li> {@link #ACTION_POWER_DISCONNECTED}
547 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700548 * </ul>
549 *
550 * <h3>Standard Categories</h3>
551 *
552 * <p>These are the current standard categories that can be used to further
553 * clarify an Intent via {@link #addCategory}.
554 *
555 * <ul>
556 * <li> {@link #CATEGORY_DEFAULT}
557 * <li> {@link #CATEGORY_BROWSABLE}
558 * <li> {@link #CATEGORY_TAB}
559 * <li> {@link #CATEGORY_ALTERNATIVE}
560 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
561 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #CATEGORY_HOME}
564 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700565 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400566 * <li> {@link #CATEGORY_CAR_DOCK}
567 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500568 * <li> {@link #CATEGORY_LE_DESK_DOCK}
569 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200570 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700571 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * </ul>
573 *
574 * <h3>Standard Extra Data</h3>
575 *
576 * <p>These are the current standard fields that can be used as extra data via
577 * {@link #putExtra}.
578 *
579 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_ALARM_COUNT}
581 * <li> {@link #EXTRA_BCC}
582 * <li> {@link #EXTRA_CC}
583 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
584 * <li> {@link #EXTRA_DATA_REMOVED}
585 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500586 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
587 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800588 * <li> {@link #EXTRA_DOCK_STATE_CAR}
589 * <li> {@link #EXTRA_DOCK_STATE_DESK}
590 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
591 * <li> {@link #EXTRA_DONT_KILL_APP}
592 * <li> {@link #EXTRA_EMAIL}
593 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700594 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800595 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700596 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700598 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
600 * <li> {@link #EXTRA_REPLACING}
601 * <li> {@link #EXTRA_SHORTCUT_ICON}
602 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
603 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700604 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800605 * <li> {@link #EXTRA_SHORTCUT_NAME}
606 * <li> {@link #EXTRA_SUBJECT}
607 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_TITLE}
610 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 * </ul>
612 *
613 * <h3>Flags</h3>
614 *
615 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800616 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
617 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700618 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800619public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700620 private static final String ATTR_ACTION = "action";
621 private static final String TAG_CATEGORIES = "categories";
622 private static final String ATTR_CATEGORY = "category";
623 private static final String TAG_EXTRA = "extra";
624 private static final String ATTR_TYPE = "type";
625 private static final String ATTR_COMPONENT = "component";
626 private static final String ATTR_DATA = "data";
627 private static final String ATTR_FLAGS = "flags";
628
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700629 // ---------------------------------------------------------------------
630 // ---------------------------------------------------------------------
631 // Standard intent activity actions (see action variable).
632
633 /**
634 * Activity Action: Start as a main entry point, does not expect to
635 * receive data.
636 * <p>Input: nothing
637 * <p>Output: nothing
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Display the data to the user. This is the most common
644 * action performed on data -- it is the generic action you can use on
645 * a piece of data to get the most reasonable thing to occur. For example,
646 * when used on a contacts entry it will view the entry; when used on a
647 * mailto: URI it will bring up a compose window filled with the information
648 * supplied by the URI; when used with a tel: URI it will invoke the
649 * dialer.
650 * <p>Input: {@link #getData} is URI from which to retrieve data.
651 * <p>Output: nothing.
652 */
653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
654 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700656 /**
657 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
658 * performed on a piece of data.
659 */
660 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800661
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700662 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900663 * Activity Action: Quick view the data. Launches a quick viewer for
664 * a URI or a list of URIs.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +0900665 * <p>Activities handling this intent action should handle the vast majority of
666 * MIME types rather than only specific ones.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * <p>Input: {@link #getData} is a mandatory content URI of the item to
668 * preview. {@link #getClipData} contains an optional list of content URIs
669 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
670 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700671 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
675
676 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * Used to indicate that some piece of data should be attached to some other
678 * place. For example, image data could be attached to a contact. It is up
679 * to the recipient to decide where the data should be attached; the intent
680 * does not specify the ultimate destination.
681 * <p>Input: {@link #getData} is URI of data to be attached.
682 * <p>Output: nothing.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Provide explicit editable access to the given data.
689 * <p>Input: {@link #getData} is URI of data to be edited.
690 * <p>Output: nothing.
691 */
692 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
693 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700695 /**
696 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
697 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
698 * The extras can contain type specific data to pass through to the editing/creating
699 * activity.
700 * <p>Output: The URI of the item that was picked. This must be a content:
701 * URI so that any receiver can access it.
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800705
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700706 /**
707 * Activity Action: Pick an item from the data, returning what was selected.
708 * <p>Input: {@link #getData} is URI containing a directory of data
709 * (vnd.android.cursor.dir/*) from which to pick an item.
710 * <p>Output: The URI of the item that was picked.
711 */
712 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
713 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 /**
716 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 * <p>Output: An Intent representing the shortcut. The intent must contain three
719 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
720 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * (value: ShortcutIconResource).</p>
722 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 * @see #EXTRA_SHORTCUT_INTENT
724 * @see #EXTRA_SHORTCUT_NAME
725 * @see #EXTRA_SHORTCUT_ICON
726 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
727 * @see android.content.Intent.ShortcutIconResource
728 */
729 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
730 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
731
732 /**
733 * The name of the extra used to define the Intent of a shortcut.
734 *
735 * @see #ACTION_CREATE_SHORTCUT
736 */
737 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
738 /**
739 * The name of the extra used to define the name of a shortcut.
740 *
741 * @see #ACTION_CREATE_SHORTCUT
742 */
743 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
744 /**
745 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
746 *
747 * @see #ACTION_CREATE_SHORTCUT
748 */
749 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
750 /**
751 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
752 *
753 * @see #ACTION_CREATE_SHORTCUT
754 * @see android.content.Intent.ShortcutIconResource
755 */
756 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
757 "android.intent.extra.shortcut.ICON_RESOURCE";
758
759 /**
Jason Monk2f68e8a2016-02-23 17:57:28 -0500760 * An activity that provides a user interface for adjusting application preferences.
761 * Optional but recommended settings for all applications which have settings.
762 */
763 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
764 public static final String ACTION_APPLICATION_PREFERENCES
765 = "android.intent.action.APPLICATION_PREFERENCES";
766
767 /**
Sudheer Shanka80b66412016-04-06 18:31:10 -0700768 * Activity Action: Launch an activity showing the app information.
769 * For applications which install other applications (such as app stores), it is recommended
770 * to handle this action for providing the app information to the user.
771 *
772 * <p>Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose information needs
773 * to be displayed.
774 * <p>Output: Nothing.
775 */
776 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
777 public static final String ACTION_SHOW_APP_INFO
778 = "android.intent.action.SHOW_APP_INFO";
779
780 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800781 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700782 *
783 * @see Intent#ACTION_CREATE_SHORTCUT
784 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800785 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
786 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700787 */
788 public static class ShortcutIconResource implements Parcelable {
789 /**
790 * The package name of the application containing the icon.
791 */
792 public String packageName;
793
794 /**
795 * The resource name of the icon, including package, name and type.
796 */
797 public String resourceName;
798
799 /**
800 * Creates a new ShortcutIconResource for the specified context and resource
801 * identifier.
802 *
803 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700804 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700805 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700806 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700807 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700808 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700809 ShortcutIconResource icon = new ShortcutIconResource();
810 icon.packageName = context.getPackageName();
811 icon.resourceName = context.getResources().getResourceName(resourceId);
812 return icon;
813 }
814
815 /**
816 * Used to read a ShortcutIconResource from a Parcel.
817 */
818 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
819 new Parcelable.Creator<ShortcutIconResource>() {
820
821 public ShortcutIconResource createFromParcel(Parcel source) {
822 ShortcutIconResource icon = new ShortcutIconResource();
823 icon.packageName = source.readString();
824 icon.resourceName = source.readString();
825 return icon;
826 }
827
828 public ShortcutIconResource[] newArray(int size) {
829 return new ShortcutIconResource[size];
830 }
831 };
832
833 /**
834 * No special parcel contents.
835 */
836 public int describeContents() {
837 return 0;
838 }
839
840 public void writeToParcel(Parcel dest, int flags) {
841 dest.writeString(packageName);
842 dest.writeString(resourceName);
843 }
844
845 @Override
846 public String toString() {
847 return resourceName;
848 }
849 }
850
851 /**
852 * Activity Action: Display an activity chooser, allowing the user to pick
853 * what they want to before proceeding. This can be used as an alternative
854 * to the standard activity picker that is displayed by the system when
855 * you try to start an activity with multiple possible matches, with these
856 * differences in behavior:
857 * <ul>
858 * <li>You can specify the title that will appear in the activity chooser.
859 * <li>The user does not have the option to make one of the matching
860 * activities a preferred activity, and all possible activities will
861 * always be shown even if one of them is currently marked as the
862 * preferred activity.
863 * </ul>
864 * <p>
865 * This action should be used when the user will naturally expect to
866 * select an activity in order to proceed. An example if when not to use
867 * it is when the user clicks on a "mailto:" link. They would naturally
868 * expect to go directly to their mail app, so startActivity() should be
869 * called directly: it will
870 * either launch the current preferred app, or put up a dialog allowing the
871 * user to pick an app to use and optionally marking that as preferred.
872 * <p>
873 * In contrast, if the user is selecting a menu item to send a picture
874 * they are viewing to someone else, there are many different things they
875 * may want to do at this point: send it through e-mail, upload it to a
876 * web service, etc. In this case the CHOOSER action should be used, to
877 * always present to the user a list of the things they can do, with a
878 * nice title given by the caller such as "Send this photo with:".
879 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700880 * If you need to grant URI permissions through a chooser, you must specify
881 * the permissions to be granted on the ACTION_CHOOSER Intent
882 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
883 * {@link #setClipData} to specify the URIs to be granted as well as
884 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
885 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
886 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 * As a convenience, an Intent of this form can be created with the
888 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700889 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700890 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700891 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
892 * and can optionally have a {@link #EXTRA_TITLE} field containing the
893 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700894 * <p>
895 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700896 */
897 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
898 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
899
900 /**
901 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
902 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700903 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
904 * target intent, also optionally supplying a title. If the target
905 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
906 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
907 * set in the returned chooser intent, with its ClipData set appropriately:
908 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500909 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700910 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * @param target The Intent that the user will be selecting an activity
912 * to perform.
913 * @param title Optional title that will be displayed in the chooser.
914 * @return Return a new Intent object that you can hand to
915 * {@link Context#startActivity(Intent) Context.startActivity()} and
916 * related methods.
917 */
918 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700919 return createChooser(target, title, null);
920 }
921
922 /**
923 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
924 *
925 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
926 * target intent, also optionally supplying a title. If the target
927 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
928 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
929 * set in the returned chooser intent, with its ClipData set appropriately:
930 * either a direct reflection of {@link #getClipData()} if that is non-null,
931 * or a new ClipData built from {@link #getData()}.</p>
932 *
933 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
934 * when the user makes a choice. This can be useful if the calling application wants
935 * to remember the last chosen target and surface it as a more prominent or one-touch
936 * affordance elsewhere in the UI for next time.</p>
937 *
938 * @param target The Intent that the user will be selecting an activity
939 * to perform.
940 * @param title Optional title that will be displayed in the chooser.
941 * @param sender Optional IntentSender to be called when a choice is made.
942 * @return Return a new Intent object that you can hand to
943 * {@link Context#startActivity(Intent) Context.startActivity()} and
944 * related methods.
945 */
946 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700947 Intent intent = new Intent(ACTION_CHOOSER);
948 intent.putExtra(EXTRA_INTENT, target);
949 if (title != null) {
950 intent.putExtra(EXTRA_TITLE, title);
951 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700952
Adam Powell0b3c1122014-10-09 12:50:14 -0700953 if (sender != null) {
954 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
955 }
956
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700957 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700958 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
959 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
960 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700961 if (permFlags != 0) {
962 ClipData targetClipData = target.getClipData();
963 if (targetClipData == null && target.getData() != null) {
964 ClipData.Item item = new ClipData.Item(target.getData());
965 String[] mimeTypes;
966 if (target.getType() != null) {
967 mimeTypes = new String[] { target.getType() };
968 } else {
969 mimeTypes = new String[] { };
970 }
971 targetClipData = new ClipData(null, mimeTypes, item);
972 }
973 if (targetClipData != null) {
974 intent.setClipData(targetClipData);
975 intent.addFlags(permFlags);
976 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700977 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700978
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700979 return intent;
980 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700982 /**
983 * Activity Action: Allow the user to select a particular kind of data and
984 * return it. This is different than {@link #ACTION_PICK} in that here we
985 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800986 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700987 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900988 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700989 * etc.
990 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900991 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700992 * of data, such as a person contact, you set the MIME type to the kind of
993 * data you want and launch it with {@link Context#startActivity(Intent)}.
994 * The system will then launch the best application to select that kind
995 * of data for you.
996 * <p>
997 * You may also be interested in any of a set of types of content the user
998 * can pick. For example, an e-mail application that wants to allow the
999 * user to add an attachment to an e-mail message can use this action to
1000 * bring up a list of all of the types of content the user can attach.
1001 * <p>
1002 * In this case, you should wrap the GET_CONTENT intent with a chooser
1003 * (through {@link #createChooser}), which will give the proper interface
1004 * for the user to pick how to send your data and allow you to specify
1005 * a prompt indicating what they are doing. You will usually specify a
1006 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
1007 * broad range of content types the user can select from.
1008 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001009 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001010 * only pick from data that can be represented as a stream. This is
1011 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
1012 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001013 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001014 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001015 * is locally available on the device. For example, if this extra is set
1016 * to true then an image picker should not show any pictures that are available
1017 * from a remote server but not already on the local device (thus requiring
1018 * they be downloaded when opened).
1019 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001020 * If the caller can handle multiple returned items (the user performing
1021 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1022 * to indicate this.
1023 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001024 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1025 * that no URI is supplied in the intent, as there are no constraints on
1026 * where the returned data originally comes from. You may also include the
1027 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001028 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001029 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1030 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001031 * <p>
1032 * Output: The URI of the item that was picked. This must be a content:
1033 * URI so that any receiver can access it.
1034 */
1035 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1036 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1037 /**
1038 * Activity Action: Dial a number as specified by the data. This shows a
1039 * UI with the number being dialed, allowing the user to explicitly
1040 * initiate the call.
1041 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1042 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1043 * number.
1044 * <p>Output: nothing.
1045 */
1046 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1047 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1048 /**
1049 * Activity Action: Perform a call to someone specified by the data.
1050 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1051 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1052 * number.
1053 * <p>Output: nothing.
1054 *
1055 * <p>Note: there will be restrictions on which applications can initiate a
1056 * call; most applications should use the {@link #ACTION_DIAL}.
1057 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1058 * numbers. Applications can <strong>dial</strong> emergency numbers using
1059 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001060 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001061 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001062 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001063 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001064 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 */
1066 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1067 public static final String ACTION_CALL = "android.intent.action.CALL";
1068 /**
1069 * Activity Action: Perform a call to an emergency number specified by the
1070 * data.
1071 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1072 * tel: URI of an explicit phone number.
1073 * <p>Output: nothing.
1074 * @hide
1075 */
1076 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1077 /**
1078 * Activity action: Perform a call to any number (emergency or not)
1079 * specified by the data.
1080 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1081 * tel: URI of an explicit phone number.
1082 * <p>Output: nothing.
1083 * @hide
1084 */
1085 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1086 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001087 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1088 * sending this intent is a no-op.
1089 * <p>Input: No data should be specified. get*Extra may have an optional
1090 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1091 * send the activation result.
1092 * <p>Output: nothing.
1093 * @hide
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1097 "android.intent.action.SIM_ACTIVATION_REQUEST";
1098 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001099 * Activity Action: Send a message to someone specified by the data.
1100 * <p>Input: {@link #getData} is URI describing the target.
1101 * <p>Output: nothing.
1102 */
1103 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1104 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1105 /**
1106 * Activity Action: Deliver some data to someone else. Who the data is
1107 * being delivered to is not specified; it is up to the receiver of this
1108 * action to ask the user where the data should be sent.
1109 * <p>
1110 * When launching a SEND intent, you should usually wrap it in a chooser
1111 * (through {@link #createChooser}), which will give the proper interface
1112 * for the user to pick how to send your data and allow you to specify
1113 * a prompt indicating what they are doing.
1114 * <p>
1115 * Input: {@link #getType} is the MIME type of the data being sent.
1116 * get*Extra can have either a {@link #EXTRA_TEXT}
1117 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1118 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1119 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1120 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001121 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1122 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1123 * your text with HTML formatting.
1124 * <p>
1125 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1126 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1127 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1128 * content: URIs and other advanced features of {@link ClipData}. If
1129 * using this approach, you still must supply the same data through the
1130 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1131 * for compatibility with old applications. If you don't set a ClipData,
1132 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001133 * <p>
1134 * Optional standard extras, which may be interpreted by some recipients as
1135 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1136 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1137 * <p>
1138 * Output: nothing.
1139 */
1140 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1141 public static final String ACTION_SEND = "android.intent.action.SEND";
1142 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001143 * Activity Action: Deliver multiple data to someone else.
1144 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001145 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001146 * <p>
1147 * Input: {@link #getType} is the MIME type of the data being sent.
1148 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001149 * #EXTRA_STREAM} field, containing the data to be sent. If using
1150 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1151 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001152 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001153 * Multiple types are supported, and receivers should handle mixed types
1154 * whenever possible. The right way for the receiver to check them is to
1155 * use the content resolver on each URI. The intent sender should try to
1156 * put the most concrete mime type in the intent type, but it can fall
1157 * back to {@literal <type>/*} or {@literal *}/* as needed.
1158 * <p>
1159 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1160 * be image/jpg, but if you are sending image/jpg and image/png, then the
1161 * intent's type should be image/*.
1162 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001163 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1164 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1165 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1166 * content: URIs and other advanced features of {@link ClipData}. If
1167 * using this approach, you still must supply the same data through the
1168 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1169 * for compatibility with old applications. If you don't set a ClipData,
1170 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1171 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001172 * Optional standard extras, which may be interpreted by some recipients as
1173 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1174 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1175 * <p>
1176 * Output: nothing.
1177 */
1178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1179 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1180 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001181 * Activity Action: Handle an incoming phone call.
1182 * <p>Input: nothing.
1183 * <p>Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1187 /**
1188 * Activity Action: Insert an empty item into the given container.
1189 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1190 * in which to place the data.
1191 * <p>Output: URI of the new data that was created.
1192 */
1193 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1194 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1195 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001196 * Activity Action: Create a new item in the given container, initializing it
1197 * from the current contents of the clipboard.
1198 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1199 * in which to place the data.
1200 * <p>Output: URI of the new data that was created.
1201 */
1202 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1203 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1204 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001205 * Activity Action: Delete the given data from its container.
1206 * <p>Input: {@link #getData} is URI of data to be deleted.
1207 * <p>Output: nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1211 /**
1212 * Activity Action: Run the data, whatever that means.
1213 * <p>Input: ? (Note: this is currently specific to the test harness.)
1214 * <p>Output: nothing.
1215 */
1216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1217 public static final String ACTION_RUN = "android.intent.action.RUN";
1218 /**
1219 * Activity Action: Perform a data synchronization.
1220 * <p>Input: ?
1221 * <p>Output: ?
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1225 /**
1226 * Activity Action: Pick an activity given an intent, returning the class
1227 * selected.
1228 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1229 * used with {@link PackageManager#queryIntentActivities} to determine the
1230 * set of activities from which to pick.
1231 * <p>Output: Class name of the activity that was selected.
1232 */
1233 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1234 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1235 /**
1236 * Activity Action: Perform a search.
1237 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1238 * is the text to search for. If empty, simply
1239 * enter your search results Activity with the search UI activated.
1240 * <p>Output: nothing.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1244 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001245 * Activity Action: Start the platform-defined tutorial
1246 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1247 * is the text to search for. If empty, simply
1248 * enter your search results Activity with the search UI activated.
1249 * <p>Output: nothing.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001254 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001255 * <p>
1256 * Input: {@link android.app.SearchManager#QUERY
1257 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1258 * a url starts with http or https, the site will be opened. If it is plain
1259 * text, Google search will be applied.
1260 * <p>
1261 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001265
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001266 /**
Jim Miller07994402012-05-02 14:22:27 -07001267 * Activity Action: Perform assist action.
1268 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001269 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1270 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001271 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1272 * information.
Jim Miller07994402012-05-02 14:22:27 -07001273 * Output: nothing.
1274 */
1275 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1276 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001277
1278 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001279 * Activity Action: Perform voice assist action.
1280 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001281 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1282 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001283 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001284 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001285 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1289
1290 /**
Adam Skory7140a252013-09-11 12:04:58 +01001291 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1292 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001293 */
1294 public static final String EXTRA_ASSIST_PACKAGE
1295 = "android.intent.extra.ASSIST_PACKAGE";
1296
1297 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001298 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1299 * application package at the time the assist was invoked.
1300 */
1301 public static final String EXTRA_ASSIST_UID
1302 = "android.intent.extra.ASSIST_UID";
1303
1304 /**
Adam Skory7140a252013-09-11 12:04:58 +01001305 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1306 * information supplied by the current foreground app at the time of the assist request.
1307 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001308 */
1309 public static final String EXTRA_ASSIST_CONTEXT
1310 = "android.intent.extra.ASSIST_CONTEXT";
1311
Jim Miller07994402012-05-02 14:22:27 -07001312 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001313 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1314 * keyboard as the primary input device for assistance.
1315 */
1316 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1317 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1318
1319 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001320 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1321 * that was used to invoke the assist.
1322 */
1323 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1324 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1325
1326 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001327 * Activity Action: List all available applications.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 * <p>Input: Nothing.
1329 * <p>Output: nothing.
1330 */
1331 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1332 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1333 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07001334 * Activity Action: Show settings for choosing wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001335 * <p>Input: Nothing.
1336 * <p>Output: Nothing.
1337 */
1338 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1339 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1340
1341 /**
1342 * Activity Action: Show activity for reporting a bug.
1343 * <p>Input: Nothing.
1344 * <p>Output: Nothing.
1345 */
1346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1347 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1348
1349 /**
1350 * Activity Action: Main entry point for factory tests. Only used when
1351 * the device is booting in factory test node. The implementing package
1352 * must be installed in the system image.
1353 * <p>Input: nothing
1354 * <p>Output: nothing
1355 */
1356 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1357
1358 /**
1359 * Activity Action: The user pressed the "call" button to go to the dialer
1360 * or other appropriate UI for placing a call.
1361 * <p>Input: Nothing.
1362 * <p>Output: Nothing.
1363 */
1364 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1365 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1366
1367 /**
1368 * Activity Action: Start Voice Command.
1369 * <p>Input: Nothing.
1370 * <p>Output: Nothing.
1371 */
1372 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1373 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001374
1375 /**
1376 * Activity Action: Start action associated with long pressing on the
1377 * search key.
1378 * <p>Input: Nothing.
1379 * <p>Output: Nothing.
1380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001383
Jacek Surazski86b6c532009-05-13 14:38:28 +02001384 /**
1385 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1386 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001387 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001388 * <p>Input: No data is specified. The bug report is passed in using
1389 * an {@link #EXTRA_BUG_REPORT} field.
1390 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001391 *
1392 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001396
1397 /**
1398 * Activity Action: Show power usage information to the user.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 */
1402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1403 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001404
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001405 /**
1406 * Activity Action: Setup wizard to launch after a platform update. This
1407 * activity should have a string meta-data field associated with it,
1408 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1409 * the platform for setup. The activity will be launched only if
1410 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1411 * same value.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 * @hide
1415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001418
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001419 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001420 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1421 * <p>Input: Nothing.
1422 * <p>Output: Nothing.
1423 * @hide
1424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1427 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1428
1429 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001430 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1431 * <p>Input: Nothing.
1432 * <p>Output: Nothing.
1433 * @hide
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1437 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1438
1439 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001440 * Activity Action: Show settings for managing network data usage of a
1441 * specific application. Applications should define an activity that offers
1442 * options to control data usage.
1443 */
1444 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1445 public static final String ACTION_MANAGE_NETWORK_USAGE =
1446 "android.intent.action.MANAGE_NETWORK_USAGE";
1447
1448 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001449 * Activity Action: Launch application installer.
1450 * <p>
1451 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001452 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1453 * you can also use "package:<package-name>" to install an application for the
1454 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001455 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1456 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1457 * <p>
1458 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1459 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001460 * <p>
1461 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1462 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1463 * in order to launch the application installer.
1464 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 *
1466 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1467 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1468 * @see #EXTRA_RETURN_RESULT
1469 */
1470 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1471 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1472
1473 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001474 * Activity Action: Launch ephemeral installer.
1475 * <p>
1476 * Input: The data must be a http: URI that the ephemeral application is registered
1477 * to handle.
1478 * <p class="note">
1479 * This is a protected intent that can only be sent by the system.
1480 * </p>
1481 *
1482 * @hide
1483 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001484 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1485 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1486 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1487
1488 /**
1489 * Service Action: Resolve ephemeral application.
1490 * <p>
1491 * The system will have a persistent connection to this service.
1492 * This is a protected intent that can only be sent by the system.
1493 * </p>
1494 *
1495 * @hide
1496 */
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001497 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1498 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1499 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1500
1501 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001502 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1503 * package. Specifies the installer package name; this package will receive the
1504 * {@link #ACTION_APP_ERROR} intent.
1505 */
1506 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1507 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1508
1509 /**
1510 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1511 * package. Specifies that the application being installed should not be
1512 * treated as coming from an unknown source, but as coming from the app
1513 * invoking the Intent. For this to work you must start the installer with
1514 * startActivityForResult().
1515 */
1516 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1517 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1518
1519 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001520 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1521 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001522 * data field originated from.
1523 */
rich cannings706e8ba2012-08-20 13:20:14 -07001524 public static final String EXTRA_ORIGINATING_URI
1525 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001526
1527 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001528 * This extra can be used with any Intent used to launch an activity, supplying information
1529 * about who is launching that activity. This field contains a {@link android.net.Uri}
1530 * object, typically an http: or https: URI of the web site that the referral came from;
1531 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1532 * a native application that it came from.
1533 *
1534 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1535 * instead of directly retrieving the extra. It is also valid for applications to
1536 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1537 * a string, not a Uri; the field here, if supplied, will always take precedence,
1538 * however.</p>
1539 *
1540 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001541 */
1542 public static final String EXTRA_REFERRER
1543 = "android.intent.extra.REFERRER";
1544
1545 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001546 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1547 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1548 * not be created, in particular when Intent extras are supplied through the
1549 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1550 * schemes.
1551 *
1552 * @see #EXTRA_REFERRER
1553 */
1554 public static final String EXTRA_REFERRER_NAME
1555 = "android.intent.extra.REFERRER_NAME";
1556
1557 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001558 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
Gina Dimino98ad8882016-05-31 17:25:48 -07001559 * {@link #ACTION_VIEW} to indicate the uid of the package that initiated the install
Ben Gruver37d83a32012-09-27 13:02:06 -07001560 * @hide
1561 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001562 @SystemApi
Ben Gruver37d83a32012-09-27 13:02:06 -07001563 public static final String EXTRA_ORIGINATING_UID
1564 = "android.intent.extra.ORIGINATING_UID";
1565
1566 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001567 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1568 * package. Tells the installer UI to skip the confirmation with the user
1569 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001570 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1571 * will no longer show an interstitial message about updating existing
1572 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001573 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001574 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001575 public static final String EXTRA_ALLOW_REPLACE
1576 = "android.intent.extra.ALLOW_REPLACE";
1577
1578 /**
1579 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1580 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1581 * return to the application the result code of the install/uninstall. The returned result
1582 * code will be {@link android.app.Activity#RESULT_OK} on success or
1583 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1584 */
1585 public static final String EXTRA_RETURN_RESULT
1586 = "android.intent.extra.RETURN_RESULT";
1587
1588 /**
1589 * Package manager install result code. @hide because result codes are not
1590 * yet ready to be exposed.
1591 */
1592 public static final String EXTRA_INSTALL_RESULT
1593 = "android.intent.extra.INSTALL_RESULT";
1594
1595 /**
1596 * Activity Action: Launch application uninstaller.
1597 * <p>
1598 * Input: The data must be a package: URI whose scheme specific part is
1599 * the package name of the current installed package to be uninstalled.
1600 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1601 * <p>
1602 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1603 * succeeded.
1604 */
1605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1606 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1607
1608 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001609 * Specify whether the package should be uninstalled for all users.
1610 * @hide because these should not be part of normal application flow.
1611 */
1612 public static final String EXTRA_UNINSTALL_ALL_USERS
1613 = "android.intent.extra.UNINSTALL_ALL_USERS";
1614
1615 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001616 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1617 * describing the last run version of the platform that was setup.
1618 * @hide
1619 */
1620 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1621
Svet Ganov3695b8a2015-03-24 16:30:25 -07001622 /**
1623 * Activity action: Launch UI to manage the permissions of an app.
1624 * <p>
1625 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1626 * will be managed by the launched UI.
1627 * </p>
1628 * <p>
1629 * Output: Nothing.
1630 * </p>
1631 *
1632 * @see #EXTRA_PACKAGE_NAME
1633 *
1634 * @hide
1635 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001636 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001637 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1638 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1639 "android.intent.action.MANAGE_APP_PERMISSIONS";
1640
1641 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001642 * Activity action: Launch UI to manage permissions.
1643 * <p>
1644 * Input: Nothing.
1645 * </p>
1646 * <p>
1647 * Output: Nothing.
1648 * </p>
1649 *
1650 * @hide
1651 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001652 @SystemApi
Svet Ganov321f0152015-05-16 22:51:50 -07001653 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1654 public static final String ACTION_MANAGE_PERMISSIONS =
1655 "android.intent.action.MANAGE_PERMISSIONS";
1656
1657 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001658 * Activity action: Launch UI to review permissions for an app.
1659 * The system uses this intent if permission review for apps not
1660 * supporting the new runtime permissions model is enabled. In
1661 * this mode a permission review is required before any of the
1662 * app components can run.
1663 * <p>
1664 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1665 * permissions will be reviewed (mandatory).
1666 * </p>
1667 * <p>
1668 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1669 * be fired after the permission review (optional).
1670 * </p>
1671 * <p>
1672 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1673 * be invoked after the permission review (optional).
1674 * </p>
1675 * <p>
1676 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1677 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1678 * </p>
1679 * <p>
1680 * Output: Nothing.
1681 * </p>
1682 *
1683 * @see #EXTRA_PACKAGE_NAME
1684 * @see #EXTRA_INTENT
1685 * @see #EXTRA_REMOTE_CALLBACK
1686 * @see #EXTRA_RESULT_NEEDED
1687 *
1688 * @hide
1689 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001690 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001691 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1692 public static final String ACTION_REVIEW_PERMISSIONS =
1693 "android.intent.action.REVIEW_PERMISSIONS";
1694
1695 /**
1696 * Intent extra: A callback for reporting remote result as a bundle.
1697 * <p>
1698 * Type: IRemoteCallback
1699 * </p>
1700 *
1701 * @hide
1702 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001703 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001704 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1705
1706 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001707 * Intent extra: An app package name.
1708 * <p>
1709 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001710 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001711 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001712 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001713 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1714
1715 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001716 * Intent extra: An extra for specifying whether a result is needed.
1717 * <p>
1718 * Type: boolean
1719 * </p>
1720 *
1721 * @hide
1722 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001723 @SystemApi
Svet Ganov9c165d72015-12-01 19:52:26 -08001724 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1725
1726 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001727 * Activity action: Launch UI to manage which apps have a given permission.
1728 * <p>
1729 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1730 * to which will be managed by the launched UI.
1731 * </p>
1732 * <p>
1733 * Output: Nothing.
1734 * </p>
1735 *
1736 * @see #EXTRA_PERMISSION_NAME
1737 *
1738 * @hide
1739 */
Svet Ganovae0e03a2016-02-25 18:22:10 -08001740 @SystemApi
Svet Ganov3695b8a2015-03-24 16:30:25 -07001741 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1742 public static final String ACTION_MANAGE_PERMISSION_APPS =
1743 "android.intent.action.MANAGE_PERMISSION_APPS";
1744
1745 /**
1746 * Intent extra: The name of a permission.
1747 * <p>
1748 * Type: String
1749 * </p>
1750 *
1751 * @hide
1752 */
1753 @SystemApi
1754 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1755
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001756 // ---------------------------------------------------------------------
1757 // ---------------------------------------------------------------------
1758 // Standard intent broadcast actions (see action variable).
1759
1760 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001761 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1762 * <p>
1763 * For historical reasons, the name of this broadcast action refers to the power
1764 * state of the screen but it is actually sent in response to changes in the
1765 * overall interactive state of the device.
1766 * </p><p>
1767 * This broadcast is sent when the device becomes non-interactive which may have
1768 * nothing to do with the screen turning off. To determine the
1769 * actual state of the screen, use {@link android.view.Display#getState}.
1770 * </p><p>
1771 * See {@link android.os.PowerManager#isInteractive} for details.
1772 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001773 * You <em>cannot</em> receive this through components declared in
1774 * manifests, only by explicitly registering for it with
1775 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1776 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001777 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001778 * <p class="note">This is a protected intent that can only be sent
1779 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001780 */
1781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1782 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001784 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001785 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1786 * <p>
1787 * For historical reasons, the name of this broadcast action refers to the power
1788 * state of the screen but it is actually sent in response to changes in the
1789 * overall interactive state of the device.
1790 * </p><p>
1791 * This broadcast is sent when the device becomes interactive which may have
1792 * nothing to do with the screen turning on. To determine the
1793 * actual state of the screen, use {@link android.view.Display#getState}.
1794 * </p><p>
1795 * See {@link android.os.PowerManager#isInteractive} for details.
1796 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001797 * You <em>cannot</em> receive this through components declared in
1798 * manifests, only by explicitly registering for it with
1799 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1800 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001801 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001802 * <p class="note">This is a protected intent that can only be sent
1803 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001804 */
1805 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1806 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001807
1808 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001809 * Broadcast Action: Sent after the system stops dreaming.
1810 *
1811 * <p class="note">This is a protected intent that can only be sent by the system.
1812 * It is only sent to registered receivers.</p>
1813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1816
1817 /**
1818 * Broadcast Action: Sent after the system starts dreaming.
1819 *
1820 * <p class="note">This is a protected intent that can only be sent by the system.
1821 * It is only sent to registered receivers.</p>
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1825
1826 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001827 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001828 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001829 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001830 * <p class="note">This is a protected intent that can only be sent
1831 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001834 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001835
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 /**
1837 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001838 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001839 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1841 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1848 /**
1849 * Broadcast Action: The time was set.
1850 */
1851 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1852 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1853 /**
1854 * Broadcast Action: The date has changed.
1855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1858 /**
1859 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1860 * <ul>
1861 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1862 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001863 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001864 * <p class="note">This is a protected intent that can only be sent
1865 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1869 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001870 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1871 * DNS entries should be tossed.
1872 * @hide
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1876 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001877 * Alarm Changed Action: This is broadcast when the AlarmClock
1878 * application's alarm is set or unset. It is used by the
1879 * AlarmClock application and the StatusBar service.
1880 * @hide
1881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001884
1885 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001886 * Broadcast Action: This is broadcast once, after the user has finished
1887 * booting, but while still in the "locked" state. It can be used to perform
1888 * application-specific initialization, such as installing alarms. You must
1889 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1890 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001891 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001892 * This broadcast is sent immediately at boot by all devices (regardless of
1893 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1894 * higher. Upon receipt of this broadcast, the user is still locked and only
1895 * device-protected storage can be accessed safely. If you want to access
1896 * credential-protected storage, you need to wait for the user to be
1897 * unlocked (typically by entering their lock pattern or PIN for the first
1898 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1899 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1900 * <p>
1901 * To receive this broadcast, your receiver component must be marked as
1902 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001903 * <p class="note">
1904 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001905 *
1906 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1910
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001912 * Broadcast Action: This is broadcast once, after the user has finished
1913 * booting. It can be used to perform application-specific initialization,
1914 * such as installing alarms. You must hold the
1915 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1916 * order to receive this broadcast.
1917 * <p>
1918 * This broadcast is sent at boot by all devices (both with and without
1919 * direct boot support). Upon receipt of this broadcast, the user is
1920 * unlocked and both device-protected and credential-protected storage can
1921 * accessed safely.
1922 * <p>
1923 * If you need to run while the user is still locked (before they've entered
1924 * their lock pattern or PIN for the first time), you can listen for the
1925 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1926 * <p class="note">
1927 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001931
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 /**
1933 * Broadcast Action: This is broadcast when a user action should request a
1934 * temporary system dialog to dismiss. Some examples of temporary system
1935 * dialogs are the notification window-shade and the recent tasks dialog.
1936 */
1937 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1938 /**
1939 * Broadcast Action: Trigger the download and eventual installation
1940 * of a package.
1941 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001942 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001943 * <p class="note">This is a protected intent that can only be sent
1944 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001945 *
1946 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001948 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1951 /**
1952 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001953 * device. The data contains the name of the package. Note that the
1954 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001955 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001956 * <ul>
1957 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1958 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1959 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1960 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001961 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001962 * <p class="note">This is a protected intent that can only be sent
1963 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1967 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001968 * Broadcast Action: A new version of an application package has been
1969 * installed, replacing an existing version that was previously installed.
1970 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001971 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001972 * <ul>
1973 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1974 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001975 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001976 * <p class="note">This is a protected intent that can only be sent
1977 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001978 */
1979 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1980 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1981 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001982 * Broadcast Action: A new version of your application has been installed
1983 * over an existing one. This is only sent to the application that was
1984 * replaced. It does not contain any additional data; to receive it, just
1985 * use an intent filter for this action.
1986 *
1987 * <p class="note">This is a protected intent that can only be sent
1988 * by the system.
1989 */
1990 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1991 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 * Broadcast Action: An existing application package has been removed from
1994 * the device. The data contains the name of the package. The package
Trevor Johns682c24e2016-04-12 10:13:47 -07001995 * that is being removed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001996 * <ul>
1997 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1998 * to the package.
1999 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2000 * application -- data and code -- is being removed.
2001 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2002 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2003 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002004 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002005 * <p class="note">This is a protected intent that can only be sent
2006 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2010 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002011 * Broadcast Action: An existing application package has been completely
2012 * removed from the device. The data contains the name of the package.
2013 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2014 * {@link #EXTRA_DATA_REMOVED} is true and
2015 * {@link #EXTRA_REPLACING} is false of that broadcast.
2016 *
2017 * <ul>
2018 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2019 * to the package.
2020 * </ul>
2021 *
2022 * <p class="note">This is a protected intent that can only be sent
2023 * by the system.
2024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_PACKAGE_FULLY_REMOVED
2027 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2028 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002029 * Broadcast Action: An existing application package has been changed (for
2030 * example, a component has been enabled or disabled). The data contains
2031 * the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002032 * <ul>
2033 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002034 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002035 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002036 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2037 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002039 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002040 * <p class="note">This is a protected intent that can only be sent
2041 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002042 */
2043 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2044 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2045 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002046 * @hide
2047 * Broadcast Action: Ask system services if there is any reason to
2048 * restart the given package. The data contains the name of the
2049 * package.
2050 * <ul>
2051 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2052 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2053 * </ul>
2054 *
2055 * <p class="note">This is a protected intent that can only be sent
2056 * by the system.
2057 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002058 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2061 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002062 * Broadcast Action: The user has restarted a package, and all of its
2063 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002065 * be removed. Note that the restarted package does <em>not</em>
2066 * receive this broadcast.
2067 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002068 * <ul>
2069 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2070 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002071 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002072 * <p class="note">This is a protected intent that can only be sent
2073 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2077 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002078 * Broadcast Action: The user has cleared the data of a package. This should
2079 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002080 * its persistent data is erased and this broadcast sent.
2081 * Note that the cleared package does <em>not</em>
2082 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 * <ul>
2084 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2085 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002086 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2092 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002093 * Broadcast Action: Packages have been suspended.
2094 * <p>Includes the following extras:
2095 * <ul>
2096 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2097 * </ul>
2098 *
2099 * <p class="note">This is a protected intent that can only be sent
2100 * by the system. It is only sent to registered receivers.
2101 */
2102 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2103 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2104 /**
2105 * Broadcast Action: Packages have been unsuspended.
2106 * <p>Includes the following extras:
2107 * <ul>
2108 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2109 * </ul>
2110 *
2111 * <p class="note">This is a protected intent that can only be sent
2112 * by the system. It is only sent to registered receivers.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2116 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002117 * Broadcast Action: A user ID has been removed from the system. The user
2118 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002119 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002122 */
2123 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2124 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002125
2126 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002127 * Broadcast Action: Sent to the installer package of an application when
2128 * that application is first launched (that is the first time it is moved
2129 * out of the stopped state). The data contains the name of the package.
Dianne Hackborne7f97212011-02-24 14:40:20 -08002130 *
2131 * <p class="note">This is a protected intent that can only be sent
2132 * by the system.
2133 */
2134 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2135 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2136
2137 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002138 * Broadcast Action: Sent to the system package verifier when a package
2139 * needs to be verified. The data contains the package URI.
2140 * <p class="note">
2141 * This is a protected intent that can only be sent by the system.
2142 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2146
2147 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002148 * Broadcast Action: Sent to the system package verifier when a package is
2149 * verified. The data contains the package URI.
2150 * <p class="note">
2151 * This is a protected intent that can only be sent by the system.
2152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2155
2156 /**
Trevor Johns682c24e2016-04-12 10:13:47 -07002157 * Broadcast Action: Sent to the system intent filter verifier when an
2158 * intent filter needs to be verified. The data contains the filter data
2159 * hosts to be verified against.
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002160 * <p class="note">
2161 * This is a protected intent that can only be sent by the system.
2162 * </p>
2163 *
2164 * @hide
2165 */
2166 @SystemApi
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2169
2170 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002171 * Broadcast Action: Resources for a set of packages (which were
2172 * previously unavailable) are currently
2173 * available since the media on which they exist is available.
2174 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2175 * list of packages whose availability changed.
2176 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2177 * list of uids of packages whose availability changed.
2178 * Note that the
2179 * packages in this list do <em>not</em> receive this broadcast.
2180 * The specified set of packages are now available on the system.
2181 * <p>Includes the following extras:
2182 * <ul>
2183 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2184 * whose resources(were previously unavailable) are currently available.
2185 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2186 * packages whose resources(were previously unavailable)
2187 * are currently available.
2188 * </ul>
2189 *
2190 * <p class="note">This is a protected intent that can only be sent
2191 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002192 */
2193 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002194 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2195 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002196
2197 /**
2198 * Broadcast Action: Resources for a set of packages are currently
2199 * unavailable since the media on which they exist is unavailable.
2200 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2201 * list of packages whose availability changed.
2202 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2203 * list of uids of packages whose availability changed.
2204 * The specified set of packages can no longer be
2205 * launched and are practically unavailable on the system.
2206 * <p>Inclues the following extras:
2207 * <ul>
2208 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2209 * whose resources are no longer available.
2210 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2211 * whose resources are no longer available.
2212 * </ul>
2213 *
2214 * <p class="note">This is a protected intent that can only be sent
2215 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002216 */
2217 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002218 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002219 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002220
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002221 /**
2222 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002223 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002224 * This should <em>only</em> be used to determine when the wallpaper
2225 * has changed to show the new wallpaper to the user. You should certainly
2226 * never, in response to this, change the wallpaper or other attributes of
2227 * it such as the suggested size. That would be crazy, right? You'd cause
2228 * all kinds of loops, especially if other apps are doing similar things,
2229 * right? Of course. So please don't do this.
2230 *
2231 * @deprecated Modern applications should use
2232 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2233 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2234 * shown behind their UI, rather than watching for this broadcast and
2235 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002236 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002237 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002238 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2239 /**
2240 * Broadcast Action: The current device {@link android.content.res.Configuration}
2241 * (orientation, locale, etc) has changed. When such a change happens, the
2242 * UIs (view hierarchy) will need to be rebuilt based on this new
2243 * information; for the most part, applications don't need to worry about
2244 * this, because the system will take care of stopping and restarting the
2245 * application to make sure it sees the new changes. Some system code that
2246 * can not be restarted will need to watch for this action and handle it
2247 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002248 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002249 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002250 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002251 * in manifests, only by explicitly registering for it with
2252 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2253 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002254 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002255 * <p class="note">This is a protected intent that can only be sent
2256 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002257 *
2258 * @see android.content.res.Configuration
2259 */
2260 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2261 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2262 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002263 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002264 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002265 * <p class="note">This is a protected intent that can only be sent
2266 * by the system.
2267 */
2268 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2269 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2270 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002271 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2272 * charging state, level, and other information about the battery.
2273 * See {@link android.os.BatteryManager} for documentation on the
2274 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002275 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002276 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002277 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002278 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002279 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002280 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2281 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2282 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2283 * broadcasts that are sent and can be received through manifest
2284 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002285 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002286 * <p class="note">This is a protected intent that can only be sent
2287 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 */
2289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2290 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2291 /**
2292 * Broadcast Action: Indicates low battery condition on the device.
2293 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002294 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002295 * <p class="note">This is a protected intent that can only be sent
2296 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 */
2298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2299 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2300 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002301 * Broadcast Action: Indicates the battery is now okay after being low.
2302 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2303 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002304 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002305 * <p class="note">This is a protected intent that can only be sent
2306 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002307 */
2308 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2309 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2310 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002311 * Broadcast Action: External power has been connected to the device.
2312 * This is intended for applications that wish to register specifically to this notification.
2313 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2314 * stay active to receive this notification. This action can be used to implement actions
2315 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002316 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002317 * <p class="note">This is a protected intent that can only be sent
2318 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002319 */
2320 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002321 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002322 /**
2323 * Broadcast Action: External power has been removed from the device.
2324 * This is intended for applications that wish to register specifically to this notification.
2325 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2326 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002327 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002328 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002329 * <p class="note">This is a protected intent that can only be sent
2330 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002331 */
2332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002333 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002334 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002335 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002336 * Broadcast Action: Device is shutting down.
2337 * This is broadcast when the device is being shut down (completely turned
2338 * off, not sleeping). Once the broadcast is complete, the final shutdown
2339 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002340 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002341 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002342 * <p class="note">This is a protected intent that can only be sent
2343 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002344 * <p>May include the following extras:
2345 * <ul>
2346 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2347 * shutdown is only for userspace processes. If not set, assumed to be false.
2348 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002349 */
2350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002351 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002352 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002353 * Activity Action: Start this activity to request system shutdown.
2354 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002355 * to request confirmation from the user before shutting down. The optional boolean
2356 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2357 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002358 *
2359 * <p class="note">This is a protected intent that can only be sent
2360 * by the system.
2361 *
2362 * {@hide}
2363 */
2364 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2365 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002366 * Broadcast Action: A sticky broadcast that indicates low memory
2367 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002369 * <p class="note">This is a protected intent that can only be sent
2370 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002371 */
2372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2373 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2374 /**
2375 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002376 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002377 * <p class="note">This is a protected intent that can only be sent
2378 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2381 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2382 /**
Jake Hambybb371632010-08-23 18:16:48 -07002383 * Broadcast Action: A sticky broadcast that indicates a memory full
2384 * condition on the device. This is intended for activities that want
2385 * to be able to fill the data partition completely, leaving only
2386 * enough free space to prevent system-wide SQLite failures.
2387 *
2388 * <p class="note">This is a protected intent that can only be sent
2389 * by the system.
2390 *
2391 * {@hide}
2392 */
2393 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2394 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2395 /**
2396 * Broadcast Action: Indicates memory full condition on the device
2397 * no longer exists.
2398 *
2399 * <p class="note">This is a protected intent that can only be sent
2400 * by the system.
2401 *
2402 * {@hide}
2403 */
2404 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2405 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2406 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002407 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2408 * and package management should be started.
2409 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2410 * notification.
2411 */
2412 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2413 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2414 /**
2415 * Broadcast Action: The device has entered USB Mass Storage mode.
2416 * This is used mainly for the USB Settings panel.
2417 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2418 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002419 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002420 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002421 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002422 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2423
2424 /**
2425 * Broadcast Action: The device has exited USB Mass Storage mode.
2426 * This is used mainly for the USB Settings panel.
2427 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2428 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002429 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002430 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002431 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002432 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2433
2434 /**
2435 * Broadcast Action: External media has been removed.
2436 * The path to the mount point for the removed media is contained in the Intent.mData field.
2437 */
2438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2439 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2440
2441 /**
2442 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002443 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002444 */
2445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2446 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2447
2448 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002449 * Broadcast Action: External media is present, and being disk-checked
2450 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002451 */
2452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2453 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2454
2455 /**
2456 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2457 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2461
2462 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002464 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002465 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2466 * media was mounted read only.
2467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2470
2471 /**
2472 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002473 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002474 */
2475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2476 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2477
2478 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002479 * Broadcast Action: External media is no longer being shared via USB mass storage.
2480 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2481 *
2482 * @hide
2483 */
2484 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2485
2486 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002487 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2488 * The path to the mount point for the removed media is contained in the Intent.mData field.
2489 */
2490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2491 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2492
2493 /**
2494 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002495 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 */
2497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2498 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2499
2500 /**
2501 * Broadcast Action: User has expressed the desire to remove the external storage media.
2502 * Applications should close all files they have open within the mount point when they receive this intent.
2503 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2504 */
2505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2506 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2507
2508 /**
2509 * Broadcast Action: The media scanner has started scanning a directory.
2510 * The path to the directory being scanned is contained in the Intent.mData field.
2511 */
2512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2513 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2514
2515 /**
2516 * Broadcast Action: The media scanner has finished scanning a directory.
2517 * The path to the scanned directory is contained in the Intent.mData field.
2518 */
2519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2520 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2521
2522 /**
2523 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2524 * The path to the file is contained in the Intent.mData field.
2525 */
2526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2527 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2528
2529 /**
2530 * Broadcast Action: The "Media Button" was pressed. Includes a single
2531 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2532 * caused the broadcast.
2533 */
2534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2535 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2536
2537 /**
2538 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2539 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2540 * caused the broadcast.
2541 */
2542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2543 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2544
2545 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2546 // location; they are not general-purpose actions.
2547
2548 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002549 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002550 */
2551 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2552 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2553 "android.intent.action.GTALK_CONNECTED";
2554
2555 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002556 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002557 */
2558 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2559 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2560 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002561
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002562 /**
2563 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002564 */
2565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2566 public static final String ACTION_INPUT_METHOD_CHANGED =
2567 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002568
2569 /**
2570 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2571 * more radios have been turned off or on. The intent will have the following extra value:</p>
2572 * <ul>
2573 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2574 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2575 * turned off</li>
2576 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002577 *
Peng Xua35b5532016-01-20 00:05:45 -08002578 * <p class="note">This is a protected intent that can only be sent by the system.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002579 */
2580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2581 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2582
2583 /**
2584 * Broadcast Action: Some content providers have parts of their namespace
2585 * where they publish new events or items that the user may be especially
2586 * interested in. For these things, they may broadcast this action when the
2587 * set of interesting items change.
2588 *
2589 * For example, GmailProvider sends this notification when the set of unread
2590 * mail in the inbox changes.
2591 *
2592 * <p>The data of the intent identifies which part of which provider
2593 * changed. When queried through the content resolver, the data URI will
2594 * return the data set in question.
2595 *
2596 * <p>The intent will have the following extra values:
2597 * <ul>
2598 * <li><em>count</em> - The number of items in the data set. This is the
2599 * same as the number of items in the cursor returned by querying the
2600 * data URI. </li>
2601 * </ul>
2602 *
2603 * This intent will be sent at boot (if the count is non-zero) and when the
2604 * data set changes. It is possible for the data set to change without the
2605 * count changing (for example, if a new unread message arrives in the same
2606 * sync operation in which a message is archived). The phone should still
2607 * ring/vibrate/etc as normal in this case.
2608 */
2609 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2610 public static final String ACTION_PROVIDER_CHANGED =
2611 "android.intent.action.PROVIDER_CHANGED";
2612
2613 /**
2614 * Broadcast Action: Wired Headset plugged in or unplugged.
2615 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002616 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2617 * and documentation.
2618 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002619 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002620 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002623 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002624
2625 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002626 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2627 * <ul>
2628 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2629 * </ul>
2630 *
2631 * <p class="note">This is a protected intent that can only be sent
2632 * by the system.
2633 *
2634 * @hide
2635 */
2636 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2637 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2638 = "android.intent.action.ADVANCED_SETTINGS";
2639
2640 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002641 * Broadcast Action: Sent after application restrictions are changed.
2642 *
2643 * <p class="note">This is a protected intent that can only be sent
2644 * by the system.</p>
2645 */
2646 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2647 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2648 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2649
2650 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002651 * Broadcast Action: An outgoing call is about to be placed.
2652 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002653 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002654 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002655 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002656 * the phone number originally intended to be dialed.</li>
2657 * </ul>
2658 * <p>Once the broadcast is finished, the resultData is used as the actual
2659 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002660 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002661 * outgoing call in turn: for example, a parental control application
2662 * might verify that the user is authorized to place the call at that
2663 * time, then a number-rewriting application might add an area code if
2664 * one was not specified.</p>
2665 * <p>For consistency, any receiver whose purpose is to prohibit phone
2666 * calls should have a priority of 0, to ensure it will see the final
2667 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002668 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002669 * should have a positive priority.
2670 * Negative priorities are reserved for the system for this broadcast;
2671 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002672 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2673 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002674 * <p>Emergency calls cannot be intercepted using this mechanism, and
2675 * other calls cannot be modified to call emergency numbers using this
2676 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002677 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2678 * call to use their own service instead. Those apps should first prevent
2679 * the call from being placed by setting resultData to <code>null</code>
2680 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002681 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002682 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2683 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002684 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002685 * <p class="note">This is a protected intent that can only be sent
2686 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002687 */
2688 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2689 public static final String ACTION_NEW_OUTGOING_CALL =
2690 "android.intent.action.NEW_OUTGOING_CALL";
2691
2692 /**
2693 * Broadcast Action: Have the device reboot. This is only for use by
2694 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002695 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002696 * <p class="note">This is a protected intent that can only be sent
2697 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 */
2699 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2700 public static final String ACTION_REBOOT =
2701 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002702
Wei Huang97ecc9c2009-05-11 17:44:20 -07002703 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002704 * Broadcast Action: A sticky broadcast for changes in the physical
2705 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002706 *
2707 * <p>The intent will have the following extra values:
2708 * <ul>
2709 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002710 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002711 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002712 * <p>This is intended for monitoring the current physical dock state.
2713 * See {@link android.app.UiModeManager} for the normal API dealing with
2714 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002715 */
2716 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2717 public static final String ACTION_DOCK_EVENT =
2718 "android.intent.action.DOCK_EVENT";
2719
2720 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002721 * Broadcast Action: A broadcast when idle maintenance can be started.
2722 * This means that the user is not interacting with the device and is
2723 * not expected to do so soon. Typical use of the idle maintenance is
2724 * to perform somehow expensive tasks that can be postponed at a moment
2725 * when they will not degrade user experience.
2726 * <p>
2727 * <p class="note">In order to keep the device responsive in case of an
2728 * unexpected user interaction, implementations of a maintenance task
2729 * should be interruptible. In such a scenario a broadcast with action
2730 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2731 * should not do the maintenance work in
2732 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2733 * maintenance service by {@link Context#startService(Intent)}. Also
2734 * you should hold a wake lock while your maintenance service is running
2735 * to prevent the device going to sleep.
2736 * </p>
2737 * <p>
2738 * <p class="note">This is a protected intent that can only be sent by
2739 * the system.
2740 * </p>
2741 *
2742 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002743 *
2744 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002745 */
2746 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2747 public static final String ACTION_IDLE_MAINTENANCE_START =
2748 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2749
2750 /**
2751 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2752 * This means that the user was not interacting with the device as a result
2753 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2754 * was sent and now the user started interacting with the device. Typical
2755 * use of the idle maintenance is to perform somehow expensive tasks that
2756 * can be postponed at a moment when they will not degrade user experience.
2757 * <p>
2758 * <p class="note">In order to keep the device responsive in case of an
2759 * unexpected user interaction, implementations of a maintenance task
2760 * should be interruptible. Hence, on receiving a broadcast with this
2761 * action, the maintenance task should be interrupted as soon as possible.
2762 * In other words, you should not do the maintenance work in
2763 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2764 * maintenance service that was started on receiving of
2765 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2766 * lock you acquired when your maintenance service started.
2767 * </p>
2768 * <p class="note">This is a protected intent that can only be sent
2769 * by the system.
2770 *
2771 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002772 *
2773 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002774 */
2775 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2776 public static final String ACTION_IDLE_MAINTENANCE_END =
2777 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2778
2779 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002780 * Broadcast Action: a remote intent is to be broadcasted.
2781 *
2782 * A remote intent is used for remote RPC between devices. The remote intent
2783 * is serialized and sent from one device to another device. The receiving
2784 * device parses the remote intent and broadcasts it. Note that anyone can
2785 * broadcast a remote intent. However, if the intent receiver of the remote intent
2786 * does not trust intent broadcasts from arbitrary intent senders, it should require
2787 * the sender to hold certain permissions so only trusted sender's broadcast will be
2788 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002789 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002790 */
2791 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002792 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002793
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002794 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002795 * Broadcast Action: This is broadcast once when the user is booting after a
2796 * system update. It can be used to perform cleanup or upgrades after a
2797 * system update.
2798 * <p>
2799 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2800 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2801 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2802 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002803 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002804 * @hide
2805 */
2806 public static final String ACTION_PRE_BOOT_COMPLETED =
2807 "android.intent.action.PRE_BOOT_COMPLETED";
2808
Amith Yamasani13593602012-03-22 16:16:17 -07002809 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002810 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002811 * on restricted users. The broadcast intent contains an extra
2812 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2813 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2814 * String[] depending on the restriction type.<p/>
2815 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002816 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2817 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2818 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002819 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2820 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002821 * @see RestrictionEntry
2822 */
2823 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2824 "android.intent.action.GET_RESTRICTION_ENTRIES";
2825
2826 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002827 * Sent the first time a user is starting, to allow system apps to
2828 * perform one time initialization. (This will not be seen by third
2829 * party applications because a newly initialized user does not have any
2830 * third party applications installed for it.) This is sent early in
2831 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002832 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2833 * broadcast, since it is part of a visible user interaction; be as quick
2834 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002835 */
2836 public static final String ACTION_USER_INITIALIZE =
2837 "android.intent.action.USER_INITIALIZE";
2838
2839 /**
2840 * Sent when a user switch is happening, causing the process's user to be
2841 * brought to the foreground. This is only sent to receivers registered
2842 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2843 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002844 * foreground. This is sent as a foreground
2845 * broadcast, since it is part of a visible user interaction; be as quick
2846 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002847 */
2848 public static final String ACTION_USER_FOREGROUND =
2849 "android.intent.action.USER_FOREGROUND";
2850
2851 /**
2852 * Sent when a user switch is happening, causing the process's user to be
2853 * sent to the background. This is only sent to receivers registered
2854 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2855 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002856 * background. This is sent as a foreground
2857 * broadcast, since it is part of a visible user interaction; be as quick
2858 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002859 */
2860 public static final String ACTION_USER_BACKGROUND =
2861 "android.intent.action.USER_BACKGROUND";
2862
2863 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002864 * Broadcast sent to the system when a user is added. Carries an extra
2865 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2866 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002867 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002868 * @hide
2869 */
2870 public static final String ACTION_USER_ADDED =
2871 "android.intent.action.USER_ADDED";
2872
2873 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002874 * Broadcast sent by the system when a user is started. Carries an extra
2875 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002876 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002877 * that has been started. This is sent as a foreground
2878 * broadcast, since it is part of a visible user interaction; be as quick
2879 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002880 * @hide
2881 */
2882 public static final String ACTION_USER_STARTED =
2883 "android.intent.action.USER_STARTED";
2884
2885 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002886 * Broadcast sent when a user is in the process of starting. Carries an extra
2887 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2888 * sent to registered receivers, not manifest receivers. It is sent to all
2889 * users (including the one that is being started). You must hold
2890 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2891 * this broadcast. This is sent as a background broadcast, since
2892 * its result is not part of the primary UX flow; to safely keep track of
2893 * started/stopped state of a user you can use this in conjunction with
2894 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2895 * other user state broadcasts since those are foreground broadcasts so can
2896 * execute in a different order.
2897 * @hide
2898 */
2899 public static final String ACTION_USER_STARTING =
2900 "android.intent.action.USER_STARTING";
2901
2902 /**
2903 * Broadcast sent when a user is going to be stopped. Carries an extra
2904 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2905 * sent to registered receivers, not manifest receivers. It is sent to all
2906 * users (including the one that is being stopped). You must hold
2907 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2908 * this broadcast. The user will not stop until all receivers have
2909 * handled the broadcast. This is sent as a background broadcast, since
2910 * its result is not part of the primary UX flow; to safely keep track of
2911 * started/stopped state of a user you can use this in conjunction with
2912 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2913 * other user state broadcasts since those are foreground broadcasts so can
2914 * execute in a different order.
2915 * @hide
2916 */
2917 public static final String ACTION_USER_STOPPING =
2918 "android.intent.action.USER_STOPPING";
2919
2920 /**
2921 * Broadcast sent to the system when a user is stopped. Carries an extra
2922 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2923 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2924 * specific package. This is only sent to registered receivers, not manifest
2925 * receivers. It is sent to all running users <em>except</em> the one that
2926 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002927 * @hide
2928 */
2929 public static final String ACTION_USER_STOPPED =
2930 "android.intent.action.USER_STOPPED";
2931
2932 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002933 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002934 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002935 * one that has been removed. The user will not be completely removed until all receivers have
2936 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002937 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002938 * @hide
2939 */
2940 public static final String ACTION_USER_REMOVED =
2941 "android.intent.action.USER_REMOVED";
2942
2943 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002944 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002945 * the userHandle of the user to become the current one. This is only sent to
2946 * registered receivers, not manifest receivers. It is sent to all running users.
2947 * You must hold
2948 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002949 * @hide
2950 */
2951 public static final String ACTION_USER_SWITCHED =
2952 "android.intent.action.USER_SWITCHED";
2953
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002954 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07002955 * Broadcast Action: Sent when the credential-encrypted private storage has
2956 * become unlocked for the target user. This is only sent to registered
2957 * receivers, not manifest receivers.
2958 */
2959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2960 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
2961
2962 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002963 * Broadcast sent to the system when a user's information changes. Carries an extra
2964 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002965 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002966 * @hide
2967 */
2968 public static final String ACTION_USER_INFO_CHANGED =
2969 "android.intent.action.USER_INFO_CHANGED";
2970
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002971 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002972 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2973 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002974 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2975 * that need to display merged content across both primary and managed profiles need to
2976 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002977 * not manifest receivers.
2978 */
2979 public static final String ACTION_MANAGED_PROFILE_ADDED =
2980 "android.intent.action.MANAGED_PROFILE_ADDED";
2981
2982 /**
2983 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002984 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2985 * Only applications (for example Launchers) that need to display merged content across both
2986 * primary and managed profiles need to worry about this broadcast. This is only sent to
2987 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002988 */
2989 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2990 "android.intent.action.MANAGED_PROFILE_REMOVED";
2991
2992 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00002993 * Broadcast sent to the primary user when the credential-encrypted private storage for
2994 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
2995 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
2996 * Launchers) that need to display merged content across both primary and managed profiles
2997 * need to worry about this broadcast. This is only sent to registered receivers,
2998 * not manifest receivers.
2999 */
3000 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3001 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3002
3003 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003004 * Broadcast sent to the primary user when an associated managed profile has become available.
3005 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003006 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3007 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3008 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003009 */
Rubin Xue95057a2016-04-01 16:49:25 +01003010 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3011 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3012
3013 /**
3014 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3015 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3016 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3017 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3018 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3019 */
3020 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3021 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003022
3023 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003024 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3025 */
3026 public static final String ACTION_QUICK_CLOCK =
3027 "android.intent.action.QUICK_CLOCK";
3028
Michael Wright0087a142013-02-05 16:29:39 -08003029 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003030 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003031 * @hide
3032 */
3033 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3034 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3035
Justin Kohd378ad72013-04-01 12:18:26 -07003036 /**
3037 * Broadcast Action: A global button was pressed. Includes a single
3038 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3039 * caused the broadcast.
3040 * @hide
3041 */
3042 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3043
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003044 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003045 * Broadcast Action: Sent when media resource is granted.
3046 * <p>
3047 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3048 * granted.
3049 * </p>
3050 * <p class="note">
3051 * This is a protected intent that can only be sent by the system.
3052 * </p>
3053 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003054 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003055 * </p>
3056 *
3057 * @hide
3058 */
3059 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3060 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3061
3062 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003063 * Activity Action: Allow the user to select and return one or more existing
3064 * documents. When invoked, the system will display the various
3065 * {@link DocumentsProvider} instances installed on the device, letting the
3066 * user interactively navigate through them. These documents include local
3067 * media, such as photos and video, and documents provided by installed
3068 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003069 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003070 * Each document is represented as a {@code content://} URI backed by a
3071 * {@link DocumentsProvider}, which can be opened as a stream with
3072 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3073 * {@link android.provider.DocumentsContract.Document} metadata.
3074 * <p>
3075 * All selected documents are returned to the calling application with
3076 * persistable read and write permission grants. If you want to maintain
3077 * access to the documents across device reboots, you need to explicitly
3078 * take the persistable permissions using
3079 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3080 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003081 * Callers must indicate the acceptable document MIME types through
3082 * {@link #setType(String)}. For example, to select photos, use
3083 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3084 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3085 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003086 * <p>
3087 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003088 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3089 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003090 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003091 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3092 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003093 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003094 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003095 * Output: The URI of the item that was picked, returned in
3096 * {@link #getData()}. This must be a {@code content://} URI so that any
3097 * receiver can access it. If multiple documents were selected, they are
3098 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003099 *
3100 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003101 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003102 * @see #ACTION_CREATE_DOCUMENT
3103 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003104 */
3105 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3106 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3107
3108 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003109 * Activity Action: Allow the user to create a new document. When invoked,
3110 * the system will display the various {@link DocumentsProvider} instances
3111 * installed on the device, letting the user navigate through them. The
3112 * returned document may be a newly created document with no content, or it
3113 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003114 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003115 * Each document is represented as a {@code content://} URI backed by a
3116 * {@link DocumentsProvider}, which can be opened as a stream with
3117 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3118 * {@link android.provider.DocumentsContract.Document} metadata.
3119 * <p>
3120 * Callers must indicate the concrete MIME type of the document being
3121 * created by setting {@link #setType(String)}. This MIME type cannot be
3122 * changed after the document is created.
3123 * <p>
3124 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3125 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003126 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003127 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3128 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003129 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003130 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003131 * Output: The URI of the item that was created. This must be a
3132 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003133 *
3134 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003135 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003136 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003137 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003138 */
3139 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3140 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3141
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003142 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003143 * Activity Action: Allow the user to pick a directory subtree. When
3144 * invoked, the system will display the various {@link DocumentsProvider}
3145 * instances installed on the device, letting the user navigate through
3146 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003147 * <p>
3148 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003149 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3150 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3151 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003152 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003153 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003154 *
3155 * @see DocumentsContract
3156 */
3157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003158 public static final String
3159 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003160
Felipe Lemec7b1f892016-01-15 15:02:31 -08003161 /**
Peng Xua35b5532016-01-20 00:05:45 -08003162 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3163 * exisiting sensor being disconnected.
3164 *
3165 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3166 *
3167 * {@hide}
3168 */
3169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3170 public static final String
3171 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3172
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003173 /** {@hide} */
3174 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3175
Christopher Tate6597e342015-02-17 12:15:25 -08003176 /**
3177 * Broadcast action: report that a settings element is being restored from backup. The intent
3178 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3179 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3180 * is the value of that settings entry prior to the restore operation. All of these values are
3181 * represented as strings.
3182 *
3183 * <p>This broadcast is sent only for settings provider entries known to require special handling
3184 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3185 * the provider's backup agent implementation.
3186 *
3187 * @see #EXTRA_SETTING_NAME
3188 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3189 * @see #EXTRA_SETTING_NEW_VALUE
3190 * {@hide}
3191 */
3192 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3193
3194 /** {@hide} */
3195 public static final String EXTRA_SETTING_NAME = "setting_name";
3196 /** {@hide} */
3197 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3198 /** {@hide} */
3199 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3200
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003201 /**
3202 * Activity Action: Process a piece of text.
3203 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3204 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3205 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3206 */
3207 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3208 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3209 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003210 * The name of the extra used to define the text to be processed, as a
3211 * CharSequence. Note that this may be a styled CharSequence, so you must use
3212 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003213 */
3214 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3215 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003216 * 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 +00003217 */
3218 public static final String EXTRA_PROCESS_TEXT_READONLY =
3219 "android.intent.extra.PROCESS_TEXT_READONLY";
3220
Bryce Leebc58f592015-09-25 16:43:01 -07003221 /**
3222 * Broadcast action: reports when a new thermal event has been reached. When the device
3223 * is reaching its maximum temperatue, the thermal level reported
3224 * {@hide}
3225 */
3226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3227 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3228
3229 /** {@hide} */
3230 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3231
3232 /**
3233 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003234 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003235 * {@hide}
3236 */
3237 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3238
3239 /**
3240 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003241 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003242 * {@hide}
3243 */
3244 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3245
3246 /**
3247 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003248 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003249 * {@hide}
3250 */
3251 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3252
3253
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003254 // ---------------------------------------------------------------------
3255 // ---------------------------------------------------------------------
3256 // Standard intent categories (see addCategory()).
3257
3258 /**
3259 * Set if the activity should be an option for the default action
3260 * (center press) to perform on a piece of data. Setting this will
3261 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003262 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003263 * Intent when initiating an action -- it is for use in intent filters
3264 * specified in packages.
3265 */
3266 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3267 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3268 /**
3269 * Activities that can be safely invoked from a browser must support this
3270 * category. For example, if the user is viewing a web page or an e-mail
3271 * and clicks on a link in the text, the Intent generated execute that
3272 * link will require the BROWSABLE category, so that only activities
3273 * supporting this category will be considered as possible actions. By
3274 * supporting this category, you are promising that there is nothing
3275 * damaging (without user intervention) that can happen by invoking any
3276 * matching Intent.
3277 */
3278 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3279 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3280 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003281 * Categories for activities that can participate in voice interaction.
3282 * An activity that supports this category must be prepared to run with
3283 * no UI shown at all (though in some case it may have a UI shown), and
3284 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3285 */
3286 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3287 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3288 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003289 * Set if the activity should be considered as an alternative action to
3290 * the data the user is currently viewing. See also
3291 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3292 * applies to the selection in a list of items.
3293 *
3294 * <p>Supporting this category means that you would like your activity to be
3295 * displayed in the set of alternative things the user can do, usually as
3296 * part of the current activity's options menu. You will usually want to
3297 * include a specific label in the &lt;intent-filter&gt; of this action
3298 * describing to the user what it does.
3299 *
3300 * <p>The action of IntentFilter with this category is important in that it
3301 * describes the specific action the target will perform. This generally
3302 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3303 * a specific name such as "com.android.camera.action.CROP. Only one
3304 * alternative of any particular action will be shown to the user, so using
3305 * a specific action like this makes sure that your alternative will be
3306 * displayed while also allowing other applications to provide their own
3307 * overrides of that particular action.
3308 */
3309 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3310 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3311 /**
3312 * Set if the activity should be considered as an alternative selection
3313 * action to the data the user has currently selected. This is like
3314 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3315 * of items from which the user can select, giving them alternatives to the
3316 * default action that will be performed on it.
3317 */
3318 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3319 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3320 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003321 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003322 */
3323 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3324 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3325 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003326 * Should be displayed in the top-level launcher.
3327 */
3328 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3329 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3330 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003331 * Indicates an activity optimized for Leanback mode, and that should
3332 * be displayed in the Leanback launcher.
3333 */
3334 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3335 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3336 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003337 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3338 * @hide
3339 */
3340 @SystemApi
3341 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3342 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003343 * Provides information about the package it is in; typically used if
3344 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3345 * a front-door to the user without having to be shown in the all apps list.
3346 */
3347 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3348 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3349 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003350 * This is the home activity, that is the first activity that is displayed
3351 * when the device boots.
3352 */
3353 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3354 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3355 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003356 * This is the home activity that is displayed when the device is finished setting up and ready
3357 * for use.
3358 * @hide
3359 */
3360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3361 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3362 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003363 * This is the setup wizard activity, that is the first activity that is displayed
3364 * when the user sets up the device for the first time.
3365 * @hide
3366 */
3367 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3368 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3369 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 * This activity is a preference panel.
3371 */
3372 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3373 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3374 /**
3375 * This activity is a development preference panel.
3376 */
3377 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3378 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3379 /**
3380 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003381 */
3382 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3383 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3384 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003385 * This activity allows the user to browse and download new applications.
3386 */
3387 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3388 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3389 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003390 * This activity may be exercised by the monkey or other automated test tools.
3391 */
3392 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3393 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3394 /**
3395 * To be used as a test (not part of the normal user experience).
3396 */
3397 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3398 /**
3399 * To be used as a unit test (run through the Test Harness).
3400 */
3401 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3402 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003403 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003404 * experience).
3405 */
3406 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003407
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003408 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003409 * Used to indicate that an intent only wants URIs that can be opened with
3410 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3411 * must support at least the columns defined in {@link OpenableColumns} when
3412 * queried.
3413 *
3414 * @see #ACTION_GET_CONTENT
3415 * @see #ACTION_OPEN_DOCUMENT
3416 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417 */
3418 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3419 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3420
3421 /**
3422 * To be used as code under test for framework instrumentation tests.
3423 */
3424 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3425 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003426 /**
3427 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003428 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3429 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003430 */
3431 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3432 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3433 /**
3434 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003435 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3436 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003437 */
3438 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3439 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003440 /**
3441 * An activity to run when device is inserted into a analog (low end) dock.
3442 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3443 * information, see {@link android.app.UiModeManager}.
3444 */
3445 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3446 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3447
3448 /**
3449 * An activity to run when device is inserted into a digital (high end) dock.
3450 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3451 * information, see {@link android.app.UiModeManager}.
3452 */
3453 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3454 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003455
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003456 /**
3457 * Used to indicate that the activity can be used in a car environment.
3458 */
3459 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3460 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3461
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003462 // ---------------------------------------------------------------------
3463 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003464 // Application launch intent categories (see addCategory()).
3465
3466 /**
3467 * Used with {@link #ACTION_MAIN} to launch the browser application.
3468 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003469 * <p>NOTE: This should not be used as the primary key of an Intent,
3470 * since it will not result in the app launching with the correct
3471 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003472 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003473 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003474 */
3475 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3476 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3477
3478 /**
3479 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3480 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003481 * <p>NOTE: This should not be used as the primary key of an Intent,
3482 * since it will not result in the app launching with the correct
3483 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003484 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003485 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003486 */
3487 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3488 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3489
3490 /**
3491 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3492 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003493 * <p>NOTE: This should not be used as the primary key of an Intent,
3494 * since it will not result in the app launching with the correct
3495 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003496 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003497 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003498 */
3499 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3500 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3501
3502 /**
3503 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3504 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003505 * <p>NOTE: This should not be used as the primary key of an Intent,
3506 * since it will not result in the app launching with the correct
3507 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003508 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003509 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003510 */
3511 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3512 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3513
3514 /**
3515 * Used with {@link #ACTION_MAIN} to launch the email application.
3516 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003517 * <p>NOTE: This should not be used as the primary key of an Intent,
3518 * since it will not result in the app launching with the correct
3519 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003520 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003521 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003522 */
3523 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3524 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3525
3526 /**
3527 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3528 * The activity should be able to view and manipulate image and video files
3529 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003530 * <p>NOTE: This should not be used as the primary key of an Intent,
3531 * since it will not result in the app launching with the correct
3532 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003533 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003534 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003535 */
3536 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3537 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3538
3539 /**
3540 * Used with {@link #ACTION_MAIN} to launch the maps application.
3541 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003542 * <p>NOTE: This should not be used as the primary key of an Intent,
3543 * since it will not result in the app launching with the correct
3544 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003545 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003546 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003547 */
3548 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3549 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3550
3551 /**
3552 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3553 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003554 * <p>NOTE: This should not be used as the primary key of an Intent,
3555 * since it will not result in the app launching with the correct
3556 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003557 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003558 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003559 */
3560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3561 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3562
3563 /**
3564 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003565 * The activity should be able to play, browse, or manipulate music files
3566 * stored on the device.
3567 * <p>NOTE: This should not be used as the primary key of an Intent,
3568 * since it will not result in the app launching with the correct
3569 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003570 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003571 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003572 */
3573 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3574 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3575
3576 // ---------------------------------------------------------------------
3577 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003578 // Standard extra data keys.
3579
3580 /**
3581 * The initial data to place in a newly created record. Use with
3582 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3583 * fields as would be given to the underlying ContentProvider.insert()
3584 * call.
3585 */
3586 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3587
3588 /**
3589 * A constant CharSequence that is associated with the Intent, used with
3590 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3591 * this may be a styled CharSequence, so you must use
3592 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3593 * retrieve it.
3594 */
3595 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3596
3597 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003598 * A constant String that is associated with the Intent, used with
3599 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3600 * as HTML formatted text. Note that you <em>must</em> also supply
3601 * {@link #EXTRA_TEXT}.
3602 */
3603 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3604
3605 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003606 * A content: URI holding a stream of data associated with the Intent,
3607 * used with {@link #ACTION_SEND} to supply the data being sent.
3608 */
3609 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3610
3611 /**
3612 * A String[] holding e-mail addresses that should be delivered to.
3613 */
3614 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3615
3616 /**
3617 * A String[] holding e-mail addresses that should be carbon copied.
3618 */
3619 public static final String EXTRA_CC = "android.intent.extra.CC";
3620
3621 /**
3622 * A String[] holding e-mail addresses that should be blind carbon copied.
3623 */
3624 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3625
3626 /**
3627 * A constant string holding the desired subject line of a message.
3628 */
3629 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3630
3631 /**
3632 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003633 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 */
3635 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3636
3637 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003638 * An int representing the user id to be used.
3639 *
3640 * @hide
3641 */
3642 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3643
3644 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003645 * An int representing the task id to be retrieved. This is used when a launch from recents is
3646 * intercepted by another action such as credentials confirmation to remember which task should
3647 * be resumed when complete.
3648 *
3649 * @hide
3650 */
3651 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3652
3653 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003654 * An Intent[] describing additional, alternate choices you would like shown with
3655 * {@link #ACTION_CHOOSER}.
3656 *
3657 * <p>An app may be capable of providing several different payload types to complete a
3658 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3659 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3660 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3661 * photo data or a hosted link where the photos can be viewed.</p>
3662 *
3663 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3664 * first/primary/preferred intent in the set. Additional intents specified in
3665 * this extra are ordered; by default intents that appear earlier in the array will be
3666 * preferred over intents that appear later in the array as matches for the same
3667 * target component. To alter this preference, a calling app may also supply
3668 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3669 */
3670 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3671
3672 /**
Adam Powell52c39212016-04-07 15:14:18 -07003673 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3674 * and omitted from a list of components presented to the user.
3675 *
3676 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3677 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3678 * from your own package or other apps from your organization if the idea of sending to those
3679 * targets would be redundant with other app functionality. Filtered components will not
3680 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3681 */
3682 public static final String EXTRA_EXCLUDE_COMPONENTS
3683 = "android.intent.extra.EXCLUDE_COMPONENTS";
3684
3685 /**
3686 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3687 * describing additional high-priority deep-link targets for the chooser to present to the user.
3688 *
3689 * <p>Targets provided in this way will be presented inline with all other targets provided
3690 * by services from other apps. They will be prioritized before other service targets, but
3691 * after those targets provided by sources that the user has manually pinned to the front.</p>
3692 *
3693 * @see #ACTION_CHOOSER
3694 */
3695 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3696
3697 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003698 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3699 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3700 *
3701 * <p>An app preparing an action for another app to complete may wish to allow the user to
3702 * disambiguate between several options for completing the action based on the chosen target
3703 * or otherwise refine the action before it is invoked.
3704 * </p>
3705 *
3706 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3707 * <ul>
3708 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3709 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3710 * chosen target beyond the first</li>
3711 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3712 * should fill in and send once the disambiguation is complete</li>
3713 * </ul>
3714 */
3715 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3716 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3717
3718 /**
3719 * A {@link ResultReceiver} used to return data back to the sender.
3720 *
3721 * <p>Used to complete an app-specific
3722 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3723 *
3724 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3725 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3726 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3727 * when the user selects a target component from the chooser. It is up to the recipient
3728 * to send a result to this ResultReceiver to signal that disambiguation is complete
3729 * and that the chooser should invoke the user's choice.</p>
3730 *
3731 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3732 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3733 * to match and fill in the final Intent or ChooserTarget before starting it.
3734 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3735 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3736 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3737 *
3738 * <p>The result code passed to the ResultReceiver should be
3739 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3740 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3741 * the chooser should finish without starting a target.</p>
3742 */
3743 public static final String EXTRA_RESULT_RECEIVER
3744 = "android.intent.extra.RESULT_RECEIVER";
3745
3746 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003747 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003748 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003749 */
3750 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3751
3752 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003753 * A Parcelable[] of {@link Intent} or
3754 * {@link android.content.pm.LabeledIntent} objects as set with
3755 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3756 * a the front of the list of choices, when shown to the user with a
3757 * {@link #ACTION_CHOOSER}.
3758 */
3759 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3760
3761 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003762 * A {@link IntentSender} to start after ephemeral installation success.
3763 * @hide
3764 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003765 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3766
3767 /**
3768 * A {@link IntentSender} to start after ephemeral installation failure.
3769 * @hide
3770 */
Todd Kennedy7440f172015-12-09 14:31:22 -08003771 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3772
3773 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003774 * A Bundle forming a mapping of potential target package names to different extras Bundles
3775 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3776 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3777 * be currently installed on the device.
3778 *
3779 * <p>An application may choose to provide alternate extras for the case where a user
3780 * selects an activity from a predetermined set of target packages. If the activity
3781 * the user selects from the chooser belongs to a package with its package name as
3782 * a key in this bundle, the corresponding extras for that package will be merged with
3783 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3784 * extra has the same key as an extra already present in the intent it will overwrite
3785 * the extra from the intent.</p>
3786 *
3787 * <p><em>Examples:</em>
3788 * <ul>
3789 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3790 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3791 * parameters for that target.</li>
3792 * <li>An application may offer additional metadata for known targets of a given intent
3793 * to pass along information only relevant to that target such as account or content
3794 * identifiers already known to that application.</li>
3795 * </ul></p>
3796 */
3797 public static final String EXTRA_REPLACEMENT_EXTRAS =
3798 "android.intent.extra.REPLACEMENT_EXTRAS";
3799
3800 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003801 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3802 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3803 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3804 * {@link ComponentName} of the chosen component.
3805 *
3806 * <p>In some situations this callback may never come, for example if the user abandons
3807 * the chooser, switches to another task or any number of other reasons. Apps should not
3808 * be written assuming that this callback will always occur.</p>
3809 */
3810 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3811 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3812
3813 /**
3814 * The {@link ComponentName} chosen by the user to complete an action.
3815 *
3816 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3817 */
3818 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3819
3820 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003821 * A {@link android.view.KeyEvent} object containing the event that
3822 * triggered the creation of the Intent it is in.
3823 */
3824 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3825
3826 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003827 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3828 * before shutting down.
3829 *
3830 * {@hide}
3831 */
3832 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3833
3834 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003835 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3836 * requested by the user.
3837 *
3838 * {@hide}
3839 */
3840 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3841 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3842
3843 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003844 * 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 -07003845 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3846 * of restarting the application.
3847 */
3848 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3849
3850 /**
3851 * A String holding the phone number originally entered in
3852 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3853 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3854 */
3855 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003856
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003857 /**
3858 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3859 * intents to supply the uid the package had been assigned. Also an optional
3860 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3861 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3862 * purpose.
3863 */
3864 public static final String EXTRA_UID = "android.intent.extra.UID";
3865
3866 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003867 * @hide String array of package names.
3868 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003869 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003870 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3871
3872 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003873 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3874 * intents to indicate whether this represents a full uninstall (removing
3875 * both the code and its data) or a partial uninstall (leaving its data,
3876 * implying that this is an update).
3877 */
3878 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003879
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003880 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003881 * @hide
3882 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3883 * intents to indicate that at this point the package has been removed for
3884 * all users on the device.
3885 */
3886 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3887 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3888
3889 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003890 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3891 * intents to indicate that this is a replacement of the package, so this
3892 * broadcast will immediately be followed by an add broadcast for a
3893 * different version of the same package.
3894 */
3895 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003896
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003897 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003898 * Used as an int extra field in {@link android.app.AlarmManager} intents
3899 * to tell the application being invoked how many pending alarms are being
3900 * delievered with the intent. For one-shot alarms this will always be 1.
3901 * For recurring alarms, this might be greater than 1 if the device was
3902 * asleep or powered off at the time an earlier alarm would have been
3903 * delivered.
3904 */
3905 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003906
Jacek Surazski86b6c532009-05-13 14:38:28 +02003907 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003908 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3909 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003910 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3911 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003912 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3913 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3914 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003915 */
3916 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3917
3918 /**
3919 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3920 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003921 */
3922 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3923
3924 /**
3925 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3926 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003927 */
3928 public static final int EXTRA_DOCK_STATE_DESK = 1;
3929
3930 /**
3931 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3932 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003933 */
3934 public static final int EXTRA_DOCK_STATE_CAR = 2;
3935
3936 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003937 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3938 * to represent that the phone is in a analog (low end) dock.
3939 */
3940 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3941
3942 /**
3943 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3944 * to represent that the phone is in a digital (high end) dock.
3945 */
3946 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3947
3948 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003949 * Boolean that can be supplied as meta-data with a dock activity, to
3950 * indicate that the dock should take over the home key when it is active.
3951 */
3952 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003953
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003954 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003955 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3956 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003957 */
3958 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3959
3960 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003961 * Used in the extra field in the remote intent. It's astring token passed with the
3962 * remote intent.
3963 */
3964 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3965 "android.intent.extra.remote_intent_token";
3966
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003967 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003968 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003969 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003970 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003971 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003972 "android.intent.extra.changed_component_name";
3973
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003974 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003975 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003976 * and contains a string array of all of the components that have changed. If
3977 * the state of the overall package has changed, then it will contain an entry
3978 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003979 */
3980 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3981 "android.intent.extra.changed_component_name_list";
3982
3983 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003984 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003985 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00003986 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
3987 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
3988 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003989 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003990 */
3991 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3992 "android.intent.extra.changed_package_list";
3993
3994 /**
3995 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003996 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3997 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003998 * and contains an integer array of uids of all of the components
3999 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004000 */
4001 public static final String EXTRA_CHANGED_UID_LIST =
4002 "android.intent.extra.changed_uid_list";
4003
4004 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004005 * @hide
4006 * Magic extra system code can use when binding, to give a label for
4007 * who it is that has bound to a service. This is an integer giving
4008 * a framework string resource that can be displayed to the user.
4009 */
4010 public static final String EXTRA_CLIENT_LABEL =
4011 "android.intent.extra.client_label";
4012
4013 /**
4014 * @hide
4015 * Magic extra system code can use when binding, to give a PendingIntent object
4016 * that can be launched for the user to disable the system's use of this
4017 * service.
4018 */
4019 public static final String EXTRA_CLIENT_INTENT =
4020 "android.intent.extra.client_intent";
4021
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004022 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004023 * Extra used to indicate that an intent should only return data that is on
4024 * the local device. This is a boolean extra; the default is false. If true,
4025 * an implementation should only allow the user to select data that is
4026 * already on the device, not requiring it be downloaded from a remote
4027 * service when opened.
4028 *
4029 * @see #ACTION_GET_CONTENT
4030 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004031 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004032 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004033 */
4034 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004035 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004036
Amith Yamasani13593602012-03-22 16:16:17 -07004037 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004038 * Extra used to indicate that an intent can allow the user to select and
4039 * return multiple items. This is a boolean extra; the default is false. If
4040 * true, an implementation is allowed to present the user with a UI where
4041 * they can pick multiple items that are all returned to the caller. When
4042 * this happens, they should be returned as the {@link #getClipData()} part
4043 * of the result Intent.
4044 *
4045 * @see #ACTION_GET_CONTENT
4046 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004047 */
4048 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004049 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004050
4051 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004052 * The integer userHandle carried with broadcast intents related to addition, removal and
4053 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4054 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4055 *
Amith Yamasani13593602012-03-22 16:16:17 -07004056 * @hide
4057 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004058 public static final String EXTRA_USER_HANDLE =
4059 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004060
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004061 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004062 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4063 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4064 */
4065 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004066 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004067
4068 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004069 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004070 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4071 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004072 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004073 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4074
4075 /**
4076 * Extra sent in the intent to the BroadcastReceiver that handles
4077 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4078 * the restrictions as key/value pairs.
4079 */
4080 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4081 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004082
Amith Yamasani86118ba2013-03-28 14:33:16 -07004083 /**
4084 * Extra used in the response from a BroadcastReceiver that handles
4085 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4086 */
4087 public static final String EXTRA_RESTRICTIONS_INTENT =
4088 "android.intent.extra.restrictions_intent";
4089
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004090 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004091 * Extra used to communicate a set of acceptable MIME types. The type of the
4092 * extra is {@code String[]}. Values may be a combination of concrete MIME
4093 * types (such as "image/png") and/or partial MIME types (such as
4094 * "audio/*").
4095 *
4096 * @see #ACTION_GET_CONTENT
4097 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004098 */
4099 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4100
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004101 /**
4102 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4103 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004104 * When this is true, hardware devices can use this information to determine that
4105 * they shouldn't do a complete shutdown of their device since this is not a
4106 * complete shutdown down to the kernel, but only user space restarting.
4107 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004108 */
4109 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4110 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4111
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004112 /**
4113 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4114 * user has set their time format preferences to the 24 hour format.
4115 *
4116 * @hide for internal use only.
4117 */
4118 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4119 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4120
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004121 /** {@hide} */
4122 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4123
Rubin Xue8490f12015-06-25 12:17:48 +01004124 /** {@hide} */
4125 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4126
Santos Cordon15a13782015-03-31 18:32:31 -07004127 /**
4128 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4129 * activation request.
4130 * TODO: Add information about the structure and response data used with the pending intent.
4131 * @hide
4132 */
4133 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4134 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4135
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004136 /**
4137 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004138 *
4139 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004140 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004141 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4142
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004143 /**
4144 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004145 * When a profile goes into quiet mode, all apps in the profile are killed and the
4146 * profile user is stopped. Widgets originating from the profile are masked, and app
4147 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004148 */
4149 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004150
4151 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004152 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004153 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004154 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4155 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004156 *
4157 * @hide
4158 */
4159 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4160 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4161
4162 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004163 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004164 * to represent that a video codec is allowed to use.
4165 *
4166 * @hide
4167 */
4168 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4169
4170 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004171 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004172 * to represent that a audio codec is allowed to use.
4173 *
4174 * @hide
4175 */
4176 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4177
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004178 // ---------------------------------------------------------------------
4179 // ---------------------------------------------------------------------
4180 // Intent flags (see mFlags variable).
4181
Tor Norbyed9273d62013-05-30 15:59:53 -07004182 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004183 @IntDef(flag = true, value = {
4184 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4185 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004186 @Retention(RetentionPolicy.SOURCE)
4187 public @interface GrantUriMode {}
4188
Jeff Sharkey846318a2014-04-04 12:12:41 -07004189 /** @hide */
4190 @IntDef(flag = true, value = {
4191 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4192 @Retention(RetentionPolicy.SOURCE)
4193 public @interface AccessUriMode {}
4194
4195 /**
4196 * Test if given mode flags specify an access mode, which must be at least
4197 * read and/or write.
4198 *
4199 * @hide
4200 */
4201 public static boolean isAccessUriMode(int modeFlags) {
4202 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4203 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4204 }
4205
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004206 /**
4207 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004208 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004209 * specified in its ClipData. When applying to an Intent's ClipData,
4210 * all URIs as well as recursive traversals through data or other ClipData
4211 * in Intent items will be granted; only the grant flags of the top-level
4212 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004213 */
4214 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4215 /**
4216 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004217 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004218 * specified in its ClipData. When applying to an Intent's ClipData,
4219 * all URIs as well as recursive traversals through data or other ClipData
4220 * in Intent items will be granted; only the grant flags of the top-level
4221 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004222 */
4223 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4224 /**
4225 * Can be set by the caller to indicate that this Intent is coming from
4226 * a background operation, not from direct user interaction.
4227 */
4228 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4229 /**
4230 * A flag you can enable for debugging: when set, log messages will be
4231 * printed during the resolution of this intent to show you what has
4232 * been found to create the final resolved list.
4233 */
4234 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004235 /**
4236 * If set, this intent will not match any components in packages that
4237 * are currently stopped. If this is not set, then the default behavior
4238 * is to include such applications in the result.
4239 */
4240 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4241 /**
4242 * If set, this intent will always match any components in packages that
4243 * are currently stopped. This is the default behavior when
4244 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4245 * flags are set, this one wins (it allows overriding of exclude for
4246 * places where the framework may automatically set the exclude flag).
4247 */
4248 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004249
4250 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004251 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004252 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004253 * persisted across device reboots until explicitly revoked with
4254 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4255 * grant for possible persisting; the receiving application must call
4256 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4257 * actually persist.
4258 *
4259 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4260 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4261 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004262 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004263 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004264 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004265
4266 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004267 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4268 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4269 * applies to any URI that is a prefix match against the original granted
4270 * URI. (Without this flag, the URI must match exactly for access to be
4271 * granted.) Another URI is considered a prefix match only when scheme,
4272 * authority, and all path segments defined by the prefix are an exact
4273 * match.
4274 */
4275 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4276
4277 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004278 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004279 * homework and verified that they correctly handle packages and components
4280 * that come and go over time. In particular:
4281 * <ul>
4282 * <li>Apps installed on external storage, which will appear to be
4283 * uninstalled while the the device is ejected.
4284 * <li>Apps with encryption unaware components, which will appear to not
4285 * exist while the device is locked.
4286 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004287 *
4288 * @hide
4289 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004290 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004291
4292 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004293 * If set, the new activity is not kept in the history stack. As soon as
4294 * the user navigates away from it, the activity is finished. This may also
4295 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4296 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004297 *
4298 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4299 * is never invoked when the current activity starts a new activity which
4300 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004301 */
4302 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4303 /**
4304 * If set, the activity will not be launched if it is already running
4305 * at the top of the history stack.
4306 */
4307 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4308 /**
4309 * If set, this activity will become the start of a new task on this
4310 * history stack. A task (from the activity that started it to the
4311 * next task activity) defines an atomic group of activities that the
4312 * user can move to. Tasks can be moved to the foreground and background;
4313 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004314 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004315 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4316 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004317 *
4318 * <p>This flag is generally used by activities that want
4319 * to present a "launcher" style behavior: they give the user a list of
4320 * separate things that can be done, which otherwise run completely
4321 * independently of the activity launching them.
4322 *
4323 * <p>When using this flag, if a task is already running for the activity
4324 * you are now starting, then a new activity will not be started; instead,
4325 * the current task will simply be brought to the front of the screen with
4326 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4327 * to disable this behavior.
4328 *
4329 * <p>This flag can not be used when the caller is requesting a result from
4330 * the activity being launched.
4331 */
4332 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4333 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004334 * This flag is used to create a new task and launch an activity into it.
4335 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4336 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4337 * search through existing tasks for ones matching this Intent. Only if no such
4338 * task is found would a new task be created. When paired with
4339 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4340 * the search for a matching task and unconditionally start a new task.
4341 *
4342 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4343 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004344 * top-level application launcher.</strong> Used in conjunction with
4345 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4346 * behavior of bringing an existing task to the foreground. When set,
4347 * a new task is <em>always</em> started to host the Activity for the
4348 * Intent, regardless of whether there is already an existing task running
4349 * the same thing.
4350 *
4351 * <p><strong>Because the default system does not include graphical task management,
4352 * you should not use this flag unless you provide some way for a user to
4353 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004354 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004355 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4356 * creating new document tasks.
4357 *
4358 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004359 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004360 *
Scott Main7aee61f2011-02-08 11:25:01 -08004361 * <p>See
4362 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4363 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004364 *
4365 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4366 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004367 */
4368 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4369 /**
4370 * If set, and the activity being launched is already running in the
4371 * current task, then instead of launching a new instance of that activity,
4372 * all of the other activities on top of it will be closed and this Intent
4373 * will be delivered to the (now on top) old activity as a new Intent.
4374 *
4375 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4376 * If D calls startActivity() with an Intent that resolves to the component
4377 * of activity B, then C and D will be finished and B receive the given
4378 * Intent, resulting in the stack now being: A, B.
4379 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004380 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004381 * either receive the new intent you are starting here in its
4382 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004383 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004384 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4385 * the same intent, then it will be finished and re-created; for all other
4386 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4387 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004388 *
4389 * <p>This launch mode can also be used to good effect in conjunction with
4390 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4391 * of a task, it will bring any currently running instance of that task
4392 * to the foreground, and then clear it to its root state. This is
4393 * especially useful, for example, when launching an activity from the
4394 * notification manager.
4395 *
Scott Main7aee61f2011-02-08 11:25:01 -08004396 * <p>See
4397 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4398 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004399 */
4400 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4401 /**
4402 * If set and this intent is being used to launch a new activity from an
4403 * existing one, then the reply target of the existing activity will be
4404 * transfered to the new activity. This way the new activity can call
4405 * {@link android.app.Activity#setResult} and have that result sent back to
4406 * the reply target of the original activity.
4407 */
4408 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4409 /**
4410 * If set and this intent is being used to launch a new activity from an
4411 * existing one, the current activity will not be counted as the top
4412 * activity for deciding whether the new intent should be delivered to
4413 * the top instead of starting a new one. The previous activity will
4414 * be used as the top, with the assumption being that the current activity
4415 * will finish itself immediately.
4416 */
4417 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4418 /**
4419 * If set, the new activity is not kept in the list of recently launched
4420 * activities.
4421 */
4422 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4423 /**
4424 * This flag is not normally set by application code, but set for you by
4425 * the system as described in the
4426 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4427 * launchMode} documentation for the singleTask mode.
4428 */
4429 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4430 /**
4431 * If set, and this activity is either being started in a new task or
4432 * bringing to the top an existing task, then it will be launched as
4433 * the front door of the task. This will result in the application of
4434 * any affinities needed to have that task in the proper state (either
4435 * moving activities to or from it), or simply resetting that task to
4436 * its initial state if needed.
4437 */
4438 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4439 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004440 * This flag is not normally set by application code, but set for you by
4441 * the system if this activity is being launched from history
4442 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004443 */
4444 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004445 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004446 * @deprecated As of API 21 this performs identically to
4447 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004448 */
4449 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004450 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004451 * This flag is used to open a document into a new task rooted at the activity launched
4452 * by this Intent. Through the use of this flag, or its equivalent attribute,
4453 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004454 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004455 *
Craig Mautner026596b2014-05-21 15:35:44 -07004456 * <p>The use of the activity attribute form of this,
4457 * {@link android.R.attr#documentLaunchMode}, is
4458 * preferred over the Intent flag described here. The attribute form allows the
4459 * Activity to specify multiple document behavior for all launchers of the Activity
4460 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004461 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004462 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4463 * it is kept after the activity is finished is different than the use of
4464 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4465 * this flag is being used to create a new recents entry, then by default that entry
4466 * will be removed once the activity is finished. You can modify this behavior with
4467 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4468 *
Craig Mautner026596b2014-05-21 15:35:44 -07004469 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4470 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4471 * equivalent of the Activity manifest specifying {@link
4472 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4473 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4474 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004475 *
Craig Mautner026596b2014-05-21 15:35:44 -07004476 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004477 *
Craig Mautner026596b2014-05-21 15:35:44 -07004478 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004479 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4480 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004481 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004482 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004483 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004484 * callback from occurring on the current frontmost activity before it is
4485 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004486 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004487 * <p>Typically, an activity can rely on that callback to indicate that an
4488 * explicit user action has caused their activity to be moved out of the
4489 * foreground. The callback marks an appropriate point in the activity's
4490 * lifecycle for it to dismiss any notifications that it intends to display
4491 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004492 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004493 * <p>If an activity is ever started via any non-user-driven events such as
4494 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4495 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004496 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004497 */
4498 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004499 /**
4500 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4501 * this flag will cause the launched activity to be brought to the front of its
4502 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004503 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004504 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4505 * If D calls startActivity() with an Intent that resolves to the component
4506 * of activity B, then B will be brought to the front of the history stack,
4507 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004508 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004509 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004510 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004511 */
4512 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004513 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004514 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4515 * this flag will prevent the system from applying an activity transition
4516 * animation to go to the next activity state. This doesn't mean an
4517 * animation will never run -- if another activity change happens that doesn't
4518 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004519 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004520 * when you are going to do a series of activity operations but the
4521 * animation seen by the user shouldn't be driven by the first activity
4522 * change but rather a later one.
4523 */
4524 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4525 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004526 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4527 * this flag will cause any existing task that would be associated with the
4528 * activity to be cleared before the activity is started. That is, the activity
4529 * becomes the new root of an otherwise empty task, and any old activities
4530 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4531 */
4532 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4533 /**
4534 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4535 * this flag will cause a newly launching task to be placed on top of the current
4536 * home activity task (if there is one). That is, pressing back from the task
4537 * will always return the user to home even if that was not the last activity they
4538 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4539 */
4540 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4541 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004542 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4543 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004544 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004545 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004546 * this flag. When set and the task's activity is finished, the recents
4547 * entry will remain in the interface for the user to re-launch it, like a
4548 * recents entry for a top-level application.
4549 * <p>
4550 * The receiving activity can override this request with
4551 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4552 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004553 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004554 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004555 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004556
4557 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004558 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4559 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004560 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4561 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004562 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004563 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004564
4565 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004566 * If set, when sending a broadcast only registered receivers will be
4567 * called -- no BroadcastReceiver components will be launched.
4568 */
4569 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004570 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004571 * If set, when sending a broadcast the new broadcast will replace
4572 * any existing pending broadcast that matches it. Matching is defined
4573 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4574 * true for the intents of the two broadcasts. When a match is found,
4575 * the new broadcast (and receivers associated with it) will replace the
4576 * existing one in the pending broadcast list, remaining at the same
4577 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004578 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004579 * <p>This flag is most typically used with sticky broadcasts, which
4580 * only care about delivering the most recent values of the broadcast
4581 * to their receivers.
4582 */
4583 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4584 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004585 * If set, when sending a broadcast the recipient is allowed to run at
4586 * foreground priority, with a shorter timeout interval. During normal
4587 * broadcasts the receivers are not automatically hoisted out of the
4588 * background priority class.
4589 */
4590 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4591 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004592 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4593 * They can still propagate results through to later receivers, but they can not prevent
4594 * later receivers from seeing the broadcast.
4595 */
4596 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4597 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004598 * If set, when sending a broadcast <i>before boot has completed</i> only
4599 * registered receivers will be called -- no BroadcastReceiver components
4600 * will be launched. Sticky intent state will be recorded properly even
4601 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4602 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004603 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004604 * <p>This flag is only for use by system sevices as a convenience to
4605 * avoid having to implement a more complex mechanism around detection
4606 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004607 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004608 * @hide
4609 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004610 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004611 /**
4612 * Set when this broadcast is for a boot upgrade, a special mode that
4613 * allows the broadcast to be sent before the system is ready and launches
4614 * the app process with no providers running in it.
4615 * @hide
4616 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004617 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004618 /**
4619 * If set, the broadcast will always go to manifest receivers in background (cached
4620 * or not running) apps, regardless of whether that would be done by default. By
4621 * default they will only receive broadcasts if the broadcast has specified an
4622 * explicit component or package name.
4623 * @hide
4624 */
4625 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4626 /**
4627 * If set, the broadcast will never go to manifest receivers in background (cached
4628 * or not running) apps, regardless of whether that would be done by default. By
4629 * default they will receive broadcasts if the broadcast has specified an
4630 * explicit component or package name.
4631 * @hide
4632 */
4633 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004634
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004635 /**
4636 * @hide Flags that can't be changed with PendingIntent.
4637 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004638 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4639 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4640 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004643 // ---------------------------------------------------------------------
4644 // toUri() and parseUri() options.
4645
4646 /**
4647 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4648 * always has the "intent:" scheme. This syntax can be used when you want
4649 * to later disambiguate between URIs that are intended to describe an
4650 * Intent vs. all others that should be treated as raw URIs. When used
4651 * with {@link #parseUri}, any other scheme will result in a generic
4652 * VIEW action for that raw URI.
4653 */
4654 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004655
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004656 /**
4657 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4658 * always has the "android-app:" scheme. This is a variation of
4659 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4660 * http/https URI being delivered to a specific package name. The format
4661 * is:
4662 *
4663 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004664 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004665 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004666 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4667 * you must also include a scheme; including a path also requires both a host and a scheme.
4668 * The final #Intent; fragment can be used without a scheme, host, or path.
4669 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004670 * used with intents that have a {@link #setSelector}, since the base intent
4671 * will always have an explicit package name.</p>
4672 *
4673 * <p>Some examples of how this scheme maps to Intent objects:</p>
4674 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4675 * <colgroup align="left" />
4676 * <colgroup align="left" />
4677 * <thead>
4678 * <tr><th>URI</th> <th>Intent</th></tr>
4679 * </thead>
4680 *
4681 * <tbody>
4682 * <tr><td><code>android-app://com.example.app</code></td>
4683 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4684 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4685 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4686 * </table></td>
4687 * </tr>
4688 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4689 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4690 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4691 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4692 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4693 * </table></td>
4694 * </tr>
4695 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4696 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4697 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4698 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4699 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4700 * </table></td>
4701 * </tr>
4702 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4703 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4704 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4705 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4706 * </table></td>
4707 * </tr>
4708 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4709 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4710 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4711 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4712 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4713 * </table></td>
4714 * </tr>
4715 * <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>
4716 * <td><table border="" style="margin:0" >
4717 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4718 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4719 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4720 * </table></td>
4721 * </tr>
4722 * </tbody>
4723 * </table>
4724 */
4725 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4726
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004727 /**
4728 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4729 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4730 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4731 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4732 * generated Intent can not cause unexpected data access to happen.
4733 *
4734 * <p>If you do not trust the source of the URI being parsed, you should still do further
4735 * processing to protect yourself from it. In particular, when using it to start an
4736 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4737 * that can handle it.</p>
4738 */
4739 public static final int URI_ALLOW_UNSAFE = 1<<2;
4740
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004741 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004742
4743 private String mAction;
4744 private Uri mData;
4745 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004746 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004747 private ComponentName mComponent;
4748 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004749 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004750 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004751 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004752 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004753 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004754 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004755
4756 // ---------------------------------------------------------------------
4757
4758 /**
4759 * Create an empty intent.
4760 */
4761 public Intent() {
4762 }
4763
4764 /**
4765 * Copy constructor.
4766 */
4767 public Intent(Intent o) {
4768 this.mAction = o.mAction;
4769 this.mData = o.mData;
4770 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004771 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004772 this.mComponent = o.mComponent;
4773 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004774 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004775 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004776 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004777 }
4778 if (o.mExtras != null) {
4779 this.mExtras = new Bundle(o.mExtras);
4780 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004781 if (o.mSourceBounds != null) {
4782 this.mSourceBounds = new Rect(o.mSourceBounds);
4783 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004784 if (o.mSelector != null) {
4785 this.mSelector = new Intent(o.mSelector);
4786 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004787 if (o.mClipData != null) {
4788 this.mClipData = new ClipData(o.mClipData);
4789 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004790 }
4791
4792 @Override
4793 public Object clone() {
4794 return new Intent(this);
4795 }
4796
4797 private Intent(Intent o, boolean all) {
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 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004804 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004805 }
4806 }
4807
4808 /**
4809 * Make a clone of only the parts of the Intent that are relevant for
4810 * filter matching: the action, data, type, component, and categories.
4811 */
4812 public Intent cloneFilter() {
4813 return new Intent(this, false);
4814 }
4815
4816 /**
4817 * Create an intent with a given action. All other fields (data, type,
4818 * class) are null. Note that the action <em>must</em> be in a
4819 * namespace because Intents are used globally in the system -- for
4820 * example the system VIEW action is android.intent.action.VIEW; an
4821 * application's custom action would be something like
4822 * com.google.app.myapp.CUSTOM_ACTION.
4823 *
4824 * @param action The Intent action, such as ACTION_VIEW.
4825 */
4826 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004827 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004828 }
4829
4830 /**
4831 * Create an intent with a given action and for a given data url. Note
4832 * that the action <em>must</em> be in a namespace because Intents are
4833 * used globally in the system -- for example the system VIEW action is
4834 * android.intent.action.VIEW; an application's custom action would be
4835 * something like com.google.app.myapp.CUSTOM_ACTION.
4836 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004837 * <p><em>Note: scheme and host name matching in the Android framework is
4838 * case-sensitive, unlike the formal RFC. As a result,
4839 * you should always ensure that you write your Uri with these elements
4840 * using lower case letters, and normalize any Uris you receive from
4841 * outside of Android to ensure the scheme and host is lower case.</em></p>
4842 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004843 * @param action The Intent action, such as ACTION_VIEW.
4844 * @param uri The Intent data URI.
4845 */
4846 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004847 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004848 mData = uri;
4849 }
4850
4851 /**
4852 * Create an intent for a specific component. All other fields (action, data,
4853 * type, class) are null, though they can be modified later with explicit
4854 * calls. This provides a convenient way to create an intent that is
4855 * intended to execute a hard-coded class name, rather than relying on the
4856 * system to find an appropriate class for you; see {@link #setComponent}
4857 * for more information on the repercussions of this.
4858 *
4859 * @param packageContext A Context of the application package implementing
4860 * this class.
4861 * @param cls The component class that is to be used for the intent.
4862 *
4863 * @see #setClass
4864 * @see #setComponent
4865 * @see #Intent(String, android.net.Uri , Context, Class)
4866 */
4867 public Intent(Context packageContext, Class<?> cls) {
4868 mComponent = new ComponentName(packageContext, cls);
4869 }
4870
4871 /**
4872 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004873 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 * construct the Intent and then calling {@link #setClass} to set its
4875 * class.
4876 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004877 * <p><em>Note: scheme and host name matching in the Android framework is
4878 * case-sensitive, unlike the formal RFC. As a result,
4879 * you should always ensure that you write your Uri with these elements
4880 * using lower case letters, and normalize any Uris you receive from
4881 * outside of Android to ensure the scheme and host is lower case.</em></p>
4882 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004883 * @param action The Intent action, such as ACTION_VIEW.
4884 * @param uri The Intent data URI.
4885 * @param packageContext A Context of the application package implementing
4886 * this class.
4887 * @param cls The component class that is to be used for the intent.
4888 *
4889 * @see #Intent(String, android.net.Uri)
4890 * @see #Intent(Context, Class)
4891 * @see #setClass
4892 * @see #setComponent
4893 */
4894 public Intent(String action, Uri uri,
4895 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004896 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004897 mData = uri;
4898 mComponent = new ComponentName(packageContext, cls);
4899 }
4900
4901 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004902 * Create an intent to launch the main (root) activity of a task. This
4903 * is the Intent that is started when the application's is launched from
4904 * Home. For anything else that wants to launch an application in the
4905 * same way, it is important that they use an Intent structured the same
4906 * way, and can use this function to ensure this is the case.
4907 *
4908 * <p>The returned Intent has the given Activity component as its explicit
4909 * component, {@link #ACTION_MAIN} as its action, and includes the
4910 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4911 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4912 * to do that through {@link #addFlags(int)} on the returned Intent.
4913 *
4914 * @param mainActivity The main activity component that this Intent will
4915 * launch.
4916 * @return Returns a newly created Intent that can be used to launch the
4917 * activity as a main application entry.
4918 *
4919 * @see #setClass
4920 * @see #setComponent
4921 */
4922 public static Intent makeMainActivity(ComponentName mainActivity) {
4923 Intent intent = new Intent(ACTION_MAIN);
4924 intent.setComponent(mainActivity);
4925 intent.addCategory(CATEGORY_LAUNCHER);
4926 return intent;
4927 }
4928
4929 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004930 * Make an Intent for the main activity of an application, without
4931 * specifying a specific activity to run but giving a selector to find
4932 * the activity. This results in a final Intent that is structured
4933 * the same as when the application 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 {@link #ACTION_MAIN} as its action, and includes the
4939 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4940 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4941 * to do that through {@link #addFlags(int)} on the returned Intent.
4942 *
4943 * @param selectorAction The action name of the Intent's selector.
4944 * @param selectorCategory The name of a category to add to the Intent's
4945 * selector.
4946 * @return Returns a newly created Intent that can be used to launch the
4947 * activity as a main application entry.
4948 *
4949 * @see #setSelector(Intent)
4950 */
4951 public static Intent makeMainSelectorActivity(String selectorAction,
4952 String selectorCategory) {
4953 Intent intent = new Intent(ACTION_MAIN);
4954 intent.addCategory(CATEGORY_LAUNCHER);
4955 Intent selector = new Intent();
4956 selector.setAction(selectorAction);
4957 selector.addCategory(selectorCategory);
4958 intent.setSelector(selector);
4959 return intent;
4960 }
4961
4962 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004963 * Make an Intent that can be used to re-launch an application's task
4964 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4965 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4966 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4967 *
4968 * @param mainActivity The activity component that is the root of the
4969 * task; this is the activity that has been published in the application's
4970 * manifest as the main launcher icon.
4971 *
4972 * @return Returns a newly created Intent that can be used to relaunch the
4973 * activity's task in its root state.
4974 */
4975 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4976 Intent intent = makeMainActivity(mainActivity);
4977 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4978 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4979 return intent;
4980 }
4981
4982 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004983 * Call {@link #parseUri} with 0 flags.
4984 * @deprecated Use {@link #parseUri} instead.
4985 */
4986 @Deprecated
4987 public static Intent getIntent(String uri) throws URISyntaxException {
4988 return parseUri(uri, 0);
4989 }
Tom Taylord4a47292009-12-21 13:59:18 -08004990
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004991 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004992 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004993 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004994 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004995 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004996 *
4997 * <p>The URI given here must not be relative -- that is, it must include
4998 * the scheme and full path.
4999 *
5000 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005001 * @param flags Additional processing flags. Either 0,
5002 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005003 *
5004 * @return Intent The newly created Intent object.
5005 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005006 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5007 * it bad (as parsed by the Uri class) or the Intent data within the
5008 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005009 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005010 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005011 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005012 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005013 int i = 0;
5014 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005015 final boolean androidApp = uri.startsWith("android-app:");
5016
5017 // Validate intent scheme if requested.
5018 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5019 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005020 Intent intent = new Intent(ACTION_VIEW);
5021 try {
5022 intent.setData(Uri.parse(uri));
5023 } catch (IllegalArgumentException e) {
5024 throw new URISyntaxException(uri, e.getMessage());
5025 }
5026 return intent;
5027 }
5028 }
Tom Taylord4a47292009-12-21 13:59:18 -08005029
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005030 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005031 // simple case
5032 if (i == -1) {
5033 if (!androidApp) {
5034 return new Intent(ACTION_VIEW, Uri.parse(uri));
5035 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005036
5037 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005038 } else if (!uri.startsWith("#Intent;", i)) {
5039 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005040 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005041 } else {
5042 i = -1;
5043 }
5044 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005045
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005046 // new format
5047 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005048 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005049 boolean explicitAction = false;
5050 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005051
5052 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005053 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005054 String data;
5055 if (i >= 0) {
5056 data = uri.substring(0, i);
5057 i += 8; // length of "#Intent;"
5058 } else {
5059 data = uri;
5060 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005061
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005062 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005063 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005064 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005065 if (eq < 0) eq = i-1;
5066 int semi = uri.indexOf(';', i);
5067 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005068
5069 // action
5070 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005071 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005072 if (!inSelector) {
5073 explicitAction = true;
5074 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005075 }
5076
5077 // categories
5078 else if (uri.startsWith("category=", i)) {
5079 intent.addCategory(value);
5080 }
5081
5082 // type
5083 else if (uri.startsWith("type=", i)) {
5084 intent.mType = value;
5085 }
5086
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005087 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005088 else if (uri.startsWith("launchFlags=", i)) {
5089 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005090 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5091 intent.mFlags &= ~IMMUTABLE_FLAGS;
5092 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093 }
5094
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005095 // package
5096 else if (uri.startsWith("package=", i)) {
5097 intent.mPackage = value;
5098 }
5099
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005100 // component
5101 else if (uri.startsWith("component=", i)) {
5102 intent.mComponent = ComponentName.unflattenFromString(value);
5103 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005104
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005105 // scheme
5106 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005107 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005108 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005109 } else {
5110 scheme = value;
5111 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005112 }
5113
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005114 // source bounds
5115 else if (uri.startsWith("sourceBounds=", i)) {
5116 intent.mSourceBounds = Rect.unflattenFromString(value);
5117 }
5118
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005119 // selector
5120 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5121 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005122 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005123 }
5124
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005125 // extra
5126 else {
5127 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005128 // create Bundle if it doesn't already exist
5129 if (intent.mExtras == null) intent.mExtras = new Bundle();
5130 Bundle b = intent.mExtras;
5131 // add EXTRA
5132 if (uri.startsWith("S.", i)) b.putString(key, value);
5133 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5134 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5135 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5136 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5137 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5138 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5139 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5140 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5141 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5142 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005143
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005144 // move to the next item
5145 i = semi + 1;
5146 }
5147
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005148 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005149 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005150 if (baseIntent.mPackage == null) {
5151 baseIntent.setSelector(intent);
5152 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005153 intent = baseIntent;
5154 }
5155
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005156 if (data != null) {
5157 if (data.startsWith("intent:")) {
5158 data = data.substring(7);
5159 if (scheme != null) {
5160 data = scheme + ':' + data;
5161 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005162 } else if (data.startsWith("android-app:")) {
5163 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5164 // Correctly formed android-app, first part is package name.
5165 int end = data.indexOf('/', 14);
5166 if (end < 0) {
5167 // All we have is a package name.
5168 intent.mPackage = data.substring(14);
5169 if (!explicitAction) {
5170 intent.setAction(ACTION_MAIN);
5171 }
5172 data = "";
5173 } else {
5174 // Target the Intent at the given package name always.
5175 String authority = null;
5176 intent.mPackage = data.substring(14, end);
5177 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005178 if ((end+1) < data.length()) {
5179 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5180 // Found a scheme, remember it.
5181 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005182 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005183 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5184 // Found a authority, remember it.
5185 authority = data.substring(end+1, newEnd);
5186 end = newEnd;
5187 }
5188 } else {
5189 // All we have is a scheme.
5190 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005191 }
5192 }
5193 if (scheme == null) {
5194 // If there was no scheme, then this just targets the package.
5195 if (!explicitAction) {
5196 intent.setAction(ACTION_MAIN);
5197 }
5198 data = "";
5199 } else if (authority == null) {
5200 data = scheme + ":";
5201 } else {
5202 data = scheme + "://" + authority + data.substring(end);
5203 }
5204 }
5205 } else {
5206 data = "";
5207 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005208 }
Tom Taylord4a47292009-12-21 13:59:18 -08005209
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005210 if (data.length() > 0) {
5211 try {
5212 intent.mData = Uri.parse(data);
5213 } catch (IllegalArgumentException e) {
5214 throw new URISyntaxException(uri, e.getMessage());
5215 }
5216 }
5217 }
Tom Taylord4a47292009-12-21 13:59:18 -08005218
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005219 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005220
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005221 } catch (IndexOutOfBoundsException e) {
5222 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5223 }
5224 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005225
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005226 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005227 return getIntentOld(uri, 0);
5228 }
5229
5230 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005231 Intent intent;
5232
5233 int i = uri.lastIndexOf('#');
5234 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005235 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005236 final int intentFragmentStart = i;
5237 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005238
5239 i++;
5240
5241 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005242 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005243 i += 7;
5244 int j = uri.indexOf(')', i);
5245 action = uri.substring(i, j);
5246 i = j + 1;
5247 }
5248
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005249 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005250
5251 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005252 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005253 i += 11;
5254 int j = uri.indexOf(')', i);
5255 while (i < j) {
5256 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005257 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005258 if (i < sep) {
5259 intent.addCategory(uri.substring(i, sep));
5260 }
5261 i = sep + 1;
5262 }
5263 i = j + 1;
5264 }
5265
5266 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005267 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268 i += 5;
5269 int j = uri.indexOf(')', i);
5270 intent.mType = uri.substring(i, j);
5271 i = j + 1;
5272 }
5273
5274 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005275 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005276 i += 12;
5277 int j = uri.indexOf(')', i);
5278 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005279 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5280 intent.mFlags &= ~IMMUTABLE_FLAGS;
5281 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005282 i = j + 1;
5283 }
5284
5285 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005286 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005287 i += 10;
5288 int j = uri.indexOf(')', i);
5289 int sep = uri.indexOf('!', i);
5290 if (sep >= 0 && sep < j) {
5291 String pkg = uri.substring(i, sep);
5292 String cls = uri.substring(sep + 1, j);
5293 intent.mComponent = new ComponentName(pkg, cls);
5294 }
5295 i = j + 1;
5296 }
5297
5298 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005299 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005300 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005301
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005302 final int closeParen = uri.indexOf(')', i);
5303 if (closeParen == -1) throw new URISyntaxException(uri,
5304 "EXTRA missing trailing ')'", i);
5305
5306 while (i < closeParen) {
5307 // fetch the key value
5308 int j = uri.indexOf('=', i);
5309 if (j <= i + 1 || i >= closeParen) {
5310 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5311 }
5312 char type = uri.charAt(i);
5313 i++;
5314 String key = uri.substring(i, j);
5315 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005316
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005317 // get type-value
5318 j = uri.indexOf('!', i);
5319 if (j == -1 || j >= closeParen) j = closeParen;
5320 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5321 String value = uri.substring(i, j);
5322 i = j;
5323
5324 // create Bundle if it doesn't already exist
5325 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005326
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005327 // add item to bundle
5328 try {
5329 switch (type) {
5330 case 'S':
5331 intent.mExtras.putString(key, Uri.decode(value));
5332 break;
5333 case 'B':
5334 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5335 break;
5336 case 'b':
5337 intent.mExtras.putByte(key, Byte.parseByte(value));
5338 break;
5339 case 'c':
5340 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5341 break;
5342 case 'd':
5343 intent.mExtras.putDouble(key, Double.parseDouble(value));
5344 break;
5345 case 'f':
5346 intent.mExtras.putFloat(key, Float.parseFloat(value));
5347 break;
5348 case 'i':
5349 intent.mExtras.putInt(key, Integer.parseInt(value));
5350 break;
5351 case 'l':
5352 intent.mExtras.putLong(key, Long.parseLong(value));
5353 break;
5354 case 's':
5355 intent.mExtras.putShort(key, Short.parseShort(value));
5356 break;
5357 default:
5358 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5359 }
5360 } catch (NumberFormatException e) {
5361 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5362 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005363
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005364 char ch = uri.charAt(i);
5365 if (ch == ')') break;
5366 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5367 i++;
5368 }
5369 }
5370
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005371 if (isIntentFragment) {
5372 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5373 } else {
5374 intent.mData = Uri.parse(uri);
5375 }
Tom Taylord4a47292009-12-21 13:59:18 -08005376
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005377 if (intent.mAction == null) {
5378 // By default, if no action is specified, then use VIEW.
5379 intent.mAction = ACTION_VIEW;
5380 }
5381
5382 } else {
5383 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5384 }
5385
5386 return intent;
5387 }
5388
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005389 /** @hide */
5390 public interface CommandOptionHandler {
5391 boolean handleOption(String opt, ShellCommand cmd);
5392 }
5393
5394 /** @hide */
5395 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5396 throws URISyntaxException {
5397 Intent intent = new Intent();
5398 Intent baseIntent = intent;
5399 boolean hasIntentInfo = false;
5400
5401 Uri data = null;
5402 String type = null;
5403
5404 String opt;
5405 while ((opt=cmd.getNextOption()) != null) {
5406 switch (opt) {
5407 case "-a":
5408 intent.setAction(cmd.getNextArgRequired());
5409 if (intent == baseIntent) {
5410 hasIntentInfo = true;
5411 }
5412 break;
5413 case "-d":
5414 data = Uri.parse(cmd.getNextArgRequired());
5415 if (intent == baseIntent) {
5416 hasIntentInfo = true;
5417 }
5418 break;
5419 case "-t":
5420 type = cmd.getNextArgRequired();
5421 if (intent == baseIntent) {
5422 hasIntentInfo = true;
5423 }
5424 break;
5425 case "-c":
5426 intent.addCategory(cmd.getNextArgRequired());
5427 if (intent == baseIntent) {
5428 hasIntentInfo = true;
5429 }
5430 break;
5431 case "-e":
5432 case "--es": {
5433 String key = cmd.getNextArgRequired();
5434 String value = cmd.getNextArgRequired();
5435 intent.putExtra(key, value);
5436 }
5437 break;
5438 case "--esn": {
5439 String key = cmd.getNextArgRequired();
5440 intent.putExtra(key, (String) null);
5441 }
5442 break;
5443 case "--ei": {
5444 String key = cmd.getNextArgRequired();
5445 String value = cmd.getNextArgRequired();
5446 intent.putExtra(key, Integer.decode(value));
5447 }
5448 break;
5449 case "--eu": {
5450 String key = cmd.getNextArgRequired();
5451 String value = cmd.getNextArgRequired();
5452 intent.putExtra(key, Uri.parse(value));
5453 }
5454 break;
5455 case "--ecn": {
5456 String key = cmd.getNextArgRequired();
5457 String value = cmd.getNextArgRequired();
5458 ComponentName cn = ComponentName.unflattenFromString(value);
5459 if (cn == null)
5460 throw new IllegalArgumentException("Bad component name: " + value);
5461 intent.putExtra(key, cn);
5462 }
5463 break;
5464 case "--eia": {
5465 String key = cmd.getNextArgRequired();
5466 String value = cmd.getNextArgRequired();
5467 String[] strings = value.split(",");
5468 int[] list = new int[strings.length];
5469 for (int i = 0; i < strings.length; i++) {
5470 list[i] = Integer.decode(strings[i]);
5471 }
5472 intent.putExtra(key, list);
5473 }
5474 break;
5475 case "--eial": {
5476 String key = cmd.getNextArgRequired();
5477 String value = cmd.getNextArgRequired();
5478 String[] strings = value.split(",");
5479 ArrayList<Integer> list = new ArrayList<>(strings.length);
5480 for (int i = 0; i < strings.length; i++) {
5481 list.add(Integer.decode(strings[i]));
5482 }
5483 intent.putExtra(key, list);
5484 }
5485 break;
5486 case "--el": {
5487 String key = cmd.getNextArgRequired();
5488 String value = cmd.getNextArgRequired();
5489 intent.putExtra(key, Long.valueOf(value));
5490 }
5491 break;
5492 case "--ela": {
5493 String key = cmd.getNextArgRequired();
5494 String value = cmd.getNextArgRequired();
5495 String[] strings = value.split(",");
5496 long[] list = new long[strings.length];
5497 for (int i = 0; i < strings.length; i++) {
5498 list[i] = Long.valueOf(strings[i]);
5499 }
5500 intent.putExtra(key, list);
5501 hasIntentInfo = true;
5502 }
5503 break;
5504 case "--elal": {
5505 String key = cmd.getNextArgRequired();
5506 String value = cmd.getNextArgRequired();
5507 String[] strings = value.split(",");
5508 ArrayList<Long> list = new ArrayList<>(strings.length);
5509 for (int i = 0; i < strings.length; i++) {
5510 list.add(Long.valueOf(strings[i]));
5511 }
5512 intent.putExtra(key, list);
5513 hasIntentInfo = true;
5514 }
5515 break;
5516 case "--ef": {
5517 String key = cmd.getNextArgRequired();
5518 String value = cmd.getNextArgRequired();
5519 intent.putExtra(key, Float.valueOf(value));
5520 hasIntentInfo = true;
5521 }
5522 break;
5523 case "--efa": {
5524 String key = cmd.getNextArgRequired();
5525 String value = cmd.getNextArgRequired();
5526 String[] strings = value.split(",");
5527 float[] list = new float[strings.length];
5528 for (int i = 0; i < strings.length; i++) {
5529 list[i] = Float.valueOf(strings[i]);
5530 }
5531 intent.putExtra(key, list);
5532 hasIntentInfo = true;
5533 }
5534 break;
5535 case "--efal": {
5536 String key = cmd.getNextArgRequired();
5537 String value = cmd.getNextArgRequired();
5538 String[] strings = value.split(",");
5539 ArrayList<Float> list = new ArrayList<>(strings.length);
5540 for (int i = 0; i < strings.length; i++) {
5541 list.add(Float.valueOf(strings[i]));
5542 }
5543 intent.putExtra(key, list);
5544 hasIntentInfo = true;
5545 }
5546 break;
5547 case "--esa": {
5548 String key = cmd.getNextArgRequired();
5549 String value = cmd.getNextArgRequired();
5550 // Split on commas unless they are preceeded by an escape.
5551 // The escape character must be escaped for the string and
5552 // again for the regex, thus four escape characters become one.
5553 String[] strings = value.split("(?<!\\\\),");
5554 intent.putExtra(key, strings);
5555 hasIntentInfo = true;
5556 }
5557 break;
5558 case "--esal": {
5559 String key = cmd.getNextArgRequired();
5560 String value = cmd.getNextArgRequired();
5561 // Split on commas unless they are preceeded by an escape.
5562 // The escape character must be escaped for the string and
5563 // again for the regex, thus four escape characters become one.
5564 String[] strings = value.split("(?<!\\\\),");
5565 ArrayList<String> list = new ArrayList<>(strings.length);
5566 for (int i = 0; i < strings.length; i++) {
5567 list.add(strings[i]);
5568 }
5569 intent.putExtra(key, list);
5570 hasIntentInfo = true;
5571 }
5572 break;
5573 case "--ez": {
5574 String key = cmd.getNextArgRequired();
5575 String value = cmd.getNextArgRequired().toLowerCase();
5576 // Boolean.valueOf() results in false for anything that is not "true", which is
5577 // error-prone in shell commands
5578 boolean arg;
5579 if ("true".equals(value) || "t".equals(value)) {
5580 arg = true;
5581 } else if ("false".equals(value) || "f".equals(value)) {
5582 arg = false;
5583 } else {
5584 try {
5585 arg = Integer.decode(value) != 0;
5586 } catch (NumberFormatException ex) {
5587 throw new IllegalArgumentException("Invalid boolean value: " + value);
5588 }
5589 }
5590
5591 intent.putExtra(key, arg);
5592 }
5593 break;
5594 case "-n": {
5595 String str = cmd.getNextArgRequired();
5596 ComponentName cn = ComponentName.unflattenFromString(str);
5597 if (cn == null)
5598 throw new IllegalArgumentException("Bad component name: " + str);
5599 intent.setComponent(cn);
5600 if (intent == baseIntent) {
5601 hasIntentInfo = true;
5602 }
5603 }
5604 break;
5605 case "-p": {
5606 String str = cmd.getNextArgRequired();
5607 intent.setPackage(str);
5608 if (intent == baseIntent) {
5609 hasIntentInfo = true;
5610 }
5611 }
5612 break;
5613 case "-f":
5614 String str = cmd.getNextArgRequired();
5615 intent.setFlags(Integer.decode(str).intValue());
5616 break;
5617 case "--grant-read-uri-permission":
5618 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5619 break;
5620 case "--grant-write-uri-permission":
5621 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5622 break;
5623 case "--grant-persistable-uri-permission":
5624 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5625 break;
5626 case "--grant-prefix-uri-permission":
5627 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5628 break;
5629 case "--exclude-stopped-packages":
5630 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5631 break;
5632 case "--include-stopped-packages":
5633 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5634 break;
5635 case "--debug-log-resolution":
5636 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5637 break;
5638 case "--activity-brought-to-front":
5639 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5640 break;
5641 case "--activity-clear-top":
5642 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5643 break;
5644 case "--activity-clear-when-task-reset":
5645 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5646 break;
5647 case "--activity-exclude-from-recents":
5648 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5649 break;
5650 case "--activity-launched-from-history":
5651 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5652 break;
5653 case "--activity-multiple-task":
5654 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5655 break;
5656 case "--activity-no-animation":
5657 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5658 break;
5659 case "--activity-no-history":
5660 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5661 break;
5662 case "--activity-no-user-action":
5663 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5664 break;
5665 case "--activity-previous-is-top":
5666 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5667 break;
5668 case "--activity-reorder-to-front":
5669 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5670 break;
5671 case "--activity-reset-task-if-needed":
5672 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5673 break;
5674 case "--activity-single-top":
5675 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5676 break;
5677 case "--activity-clear-task":
5678 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5679 break;
5680 case "--activity-task-on-home":
5681 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5682 break;
5683 case "--receiver-registered-only":
5684 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5685 break;
5686 case "--receiver-replace-pending":
5687 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5688 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005689 case "--receiver-foreground":
5690 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5691 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005692 case "--selector":
5693 intent.setDataAndType(data, type);
5694 intent = new Intent();
5695 break;
5696 default:
5697 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5698 // Okay, caller handled this option.
5699 } else {
5700 throw new IllegalArgumentException("Unknown option: " + opt);
5701 }
5702 break;
5703 }
5704 }
5705 intent.setDataAndType(data, type);
5706
5707 final boolean hasSelector = intent != baseIntent;
5708 if (hasSelector) {
5709 // A selector was specified; fix up.
5710 baseIntent.setSelector(intent);
5711 intent = baseIntent;
5712 }
5713
5714 String arg = cmd.getNextArg();
5715 baseIntent = null;
5716 if (arg == null) {
5717 if (hasSelector) {
5718 // If a selector has been specified, and no arguments
5719 // have been supplied for the main Intent, then we can
5720 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5721 // need to have a component name specified yet, the
5722 // selector will take care of that.
5723 baseIntent = new Intent(Intent.ACTION_MAIN);
5724 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5725 }
5726 } else if (arg.indexOf(':') >= 0) {
5727 // The argument is a URI. Fully parse it, and use that result
5728 // to fill in any data not specified so far.
5729 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5730 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5731 } else if (arg.indexOf('/') >= 0) {
5732 // The argument is a component name. Build an Intent to launch
5733 // it.
5734 baseIntent = new Intent(Intent.ACTION_MAIN);
5735 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5736 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5737 } else {
5738 // Assume the argument is a package name.
5739 baseIntent = new Intent(Intent.ACTION_MAIN);
5740 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5741 baseIntent.setPackage(arg);
5742 }
5743 if (baseIntent != null) {
5744 Bundle extras = intent.getExtras();
5745 intent.replaceExtras((Bundle)null);
5746 Bundle uriExtras = baseIntent.getExtras();
5747 baseIntent.replaceExtras((Bundle)null);
5748 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5749 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5750 for (String c : cats) {
5751 baseIntent.removeCategory(c);
5752 }
5753 }
5754 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5755 if (extras == null) {
5756 extras = uriExtras;
5757 } else if (uriExtras != null) {
5758 uriExtras.putAll(extras);
5759 extras = uriExtras;
5760 }
5761 intent.replaceExtras(extras);
5762 hasIntentInfo = true;
5763 }
5764
5765 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5766 return intent;
5767 }
5768
5769 /** @hide */
5770 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5771 final String[] lines = new String[] {
5772 "<INTENT> specifications include these flags and arguments:",
5773 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5774 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5775 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5776 " [--esn <EXTRA_KEY> ...]",
5777 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5778 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5779 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5780 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5781 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5782 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5783 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5784 " (mutiple extras passed as Integer[])",
5785 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5786 " (mutiple extras passed as List<Integer>)",
5787 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5788 " (mutiple extras passed as Long[])",
5789 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5790 " (mutiple extras passed as List<Long>)",
5791 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5792 " (mutiple extras passed as Float[])",
5793 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5794 " (mutiple extras passed as List<Float>)",
5795 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5796 " (mutiple extras passed as String[]; to embed a comma into a string,",
5797 " escape it using \"\\,\")",
5798 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5799 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5800 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005801 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005802 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5803 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5804 " [--debug-log-resolution] [--exclude-stopped-packages]",
5805 " [--include-stopped-packages]",
5806 " [--activity-brought-to-front] [--activity-clear-top]",
5807 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5808 " [--activity-launched-from-history] [--activity-multiple-task]",
5809 " [--activity-no-animation] [--activity-no-history]",
5810 " [--activity-no-user-action] [--activity-previous-is-top]",
5811 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5812 " [--activity-single-top] [--activity-clear-task]",
5813 " [--activity-task-on-home]",
5814 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005815 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005816 " [--selector]",
5817 " [<URI> | <PACKAGE> | <COMPONENT>]"
5818 };
5819 for (String line : lines) {
5820 pw.print(prefix);
5821 pw.println(line);
5822 }
5823 }
5824
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005825 /**
5826 * Retrieve the general action to be performed, such as
5827 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5828 * the information in the intent should be interpreted -- most importantly,
5829 * what to do with the data returned by {@link #getData}.
5830 *
5831 * @return The action of this intent or null if none is specified.
5832 *
5833 * @see #setAction
5834 */
5835 public String getAction() {
5836 return mAction;
5837 }
5838
5839 /**
5840 * Retrieve data this intent is operating on. This URI specifies the name
5841 * of the data; often it uses the content: scheme, specifying data in a
5842 * content provider. Other schemes may be handled by specific activities,
5843 * such as http: by the web browser.
5844 *
5845 * @return The URI of the data this intent is targeting or null.
5846 *
5847 * @see #getScheme
5848 * @see #setData
5849 */
5850 public Uri getData() {
5851 return mData;
5852 }
5853
5854 /**
5855 * The same as {@link #getData()}, but returns the URI as an encoded
5856 * String.
5857 */
5858 public String getDataString() {
5859 return mData != null ? mData.toString() : null;
5860 }
5861
5862 /**
5863 * Return the scheme portion of the intent's data. If the data is null or
5864 * does not include a scheme, null is returned. Otherwise, the scheme
5865 * prefix without the final ':' is returned, i.e. "http".
5866 *
5867 * <p>This is the same as calling getData().getScheme() (and checking for
5868 * null data).
5869 *
5870 * @return The scheme of this intent.
5871 *
5872 * @see #getData
5873 */
5874 public String getScheme() {
5875 return mData != null ? mData.getScheme() : null;
5876 }
5877
5878 /**
5879 * Retrieve any explicit MIME type included in the intent. This is usually
5880 * null, as the type is determined by the intent data.
5881 *
5882 * @return If a type was manually set, it is returned; else null is
5883 * returned.
5884 *
5885 * @see #resolveType(ContentResolver)
5886 * @see #setType
5887 */
5888 public String getType() {
5889 return mType;
5890 }
5891
5892 /**
5893 * Return the MIME data type of this intent. If the type field is
5894 * explicitly set, that is simply returned. Otherwise, if the data is set,
5895 * the type of that data is returned. If neither fields are set, a null is
5896 * returned.
5897 *
5898 * @return The MIME type of this intent.
5899 *
5900 * @see #getType
5901 * @see #resolveType(ContentResolver)
5902 */
5903 public String resolveType(Context context) {
5904 return resolveType(context.getContentResolver());
5905 }
5906
5907 /**
5908 * Return the MIME data type of this intent. If the type field is
5909 * explicitly set, that is simply returned. Otherwise, if the data is set,
5910 * the type of that data is returned. If neither fields are set, a null is
5911 * returned.
5912 *
5913 * @param resolver A ContentResolver that can be used to determine the MIME
5914 * type of the intent's data.
5915 *
5916 * @return The MIME type of this intent.
5917 *
5918 * @see #getType
5919 * @see #resolveType(Context)
5920 */
5921 public String resolveType(ContentResolver resolver) {
5922 if (mType != null) {
5923 return mType;
5924 }
5925 if (mData != null) {
5926 if ("content".equals(mData.getScheme())) {
5927 return resolver.getType(mData);
5928 }
5929 }
5930 return null;
5931 }
5932
5933 /**
5934 * Return the MIME data type of this intent, only if it will be needed for
5935 * intent resolution. This is not generally useful for application code;
5936 * it is used by the frameworks for communicating with back-end system
5937 * services.
5938 *
5939 * @param resolver A ContentResolver that can be used to determine the MIME
5940 * type of the intent's data.
5941 *
5942 * @return The MIME type of this intent, or null if it is unknown or not
5943 * needed.
5944 */
5945 public String resolveTypeIfNeeded(ContentResolver resolver) {
5946 if (mComponent != null) {
5947 return mType;
5948 }
5949 return resolveType(resolver);
5950 }
5951
5952 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005953 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005954 *
5955 * @param category The category to check.
5956 *
5957 * @return boolean True if the intent contains the category, else false.
5958 *
5959 * @see #getCategories
5960 * @see #addCategory
5961 */
5962 public boolean hasCategory(String category) {
5963 return mCategories != null && mCategories.contains(category);
5964 }
5965
5966 /**
5967 * Return the set of all categories in the intent. If there are no categories,
5968 * returns NULL.
5969 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005970 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005971 *
5972 * @see #hasCategory
5973 * @see #addCategory
5974 */
5975 public Set<String> getCategories() {
5976 return mCategories;
5977 }
5978
5979 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005980 * Return the specific selector associated with this Intent. If there is
5981 * none, returns null. See {@link #setSelector} for more information.
5982 *
5983 * @see #setSelector
5984 */
5985 public Intent getSelector() {
5986 return mSelector;
5987 }
5988
5989 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005990 * Return the {@link ClipData} associated with this Intent. If there is
5991 * none, returns null. See {@link #setClipData} for more information.
5992 *
John Spurlock125d1332013-11-25 11:58:37 -05005993 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005994 */
5995 public ClipData getClipData() {
5996 return mClipData;
5997 }
5998
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005999 /** @hide */
6000 public int getContentUserHint() {
6001 return mContentUserHint;
6002 }
6003
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006004 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006005 * Sets the ClassLoader that will be used when unmarshalling
6006 * any Parcelable values from the extras of this Intent.
6007 *
6008 * @param loader a ClassLoader, or null to use the default loader
6009 * at the time of unmarshalling.
6010 */
6011 public void setExtrasClassLoader(ClassLoader loader) {
6012 if (mExtras != null) {
6013 mExtras.setClassLoader(loader);
6014 }
6015 }
6016
6017 /**
6018 * Returns true if an extra value is associated with the given name.
6019 * @param name the extra's name
6020 * @return true if the given extra is present.
6021 */
6022 public boolean hasExtra(String name) {
6023 return mExtras != null && mExtras.containsKey(name);
6024 }
6025
6026 /**
6027 * Returns true if the Intent's extras contain a parcelled file descriptor.
6028 * @return true if the Intent contains a parcelled file descriptor.
6029 */
6030 public boolean hasFileDescriptors() {
6031 return mExtras != null && mExtras.hasFileDescriptors();
6032 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006033
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006034 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006035 public void setAllowFds(boolean allowFds) {
6036 if (mExtras != null) {
6037 mExtras.setAllowFds(allowFds);
6038 }
6039 }
6040
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006041 /** {@hide} */
6042 public void setDefusable(boolean defusable) {
6043 if (mExtras != null) {
6044 mExtras.setDefusable(defusable);
6045 }
6046 }
6047
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006048 /**
6049 * Retrieve extended data from the intent.
6050 *
6051 * @param name The name of the desired item.
6052 *
6053 * @return the value of an item that previously added with putExtra()
6054 * or null if none was found.
6055 *
6056 * @deprecated
6057 * @hide
6058 */
6059 @Deprecated
6060 public Object getExtra(String name) {
6061 return getExtra(name, null);
6062 }
6063
6064 /**
6065 * Retrieve extended data from the intent.
6066 *
6067 * @param name The name of the desired item.
6068 * @param defaultValue the value to be returned if no value of the desired
6069 * type is stored with the given name.
6070 *
6071 * @return the value of an item that previously added with putExtra()
6072 * or the default value if none was found.
6073 *
6074 * @see #putExtra(String, boolean)
6075 */
6076 public boolean getBooleanExtra(String name, boolean defaultValue) {
6077 return mExtras == null ? defaultValue :
6078 mExtras.getBoolean(name, defaultValue);
6079 }
6080
6081 /**
6082 * Retrieve extended data from the intent.
6083 *
6084 * @param name The name of the desired item.
6085 * @param defaultValue the value to be returned if no value of the desired
6086 * type is stored with the given name.
6087 *
6088 * @return the value of an item that previously added with putExtra()
6089 * or the default value if none was found.
6090 *
6091 * @see #putExtra(String, byte)
6092 */
6093 public byte getByteExtra(String name, byte defaultValue) {
6094 return mExtras == null ? defaultValue :
6095 mExtras.getByte(name, defaultValue);
6096 }
6097
6098 /**
6099 * Retrieve extended data from the intent.
6100 *
6101 * @param name The name of the desired item.
6102 * @param defaultValue the value to be returned if no value of the desired
6103 * type is stored with the given name.
6104 *
6105 * @return the value of an item that previously added with putExtra()
6106 * or the default value if none was found.
6107 *
6108 * @see #putExtra(String, short)
6109 */
6110 public short getShortExtra(String name, short defaultValue) {
6111 return mExtras == null ? defaultValue :
6112 mExtras.getShort(name, defaultValue);
6113 }
6114
6115 /**
6116 * Retrieve extended data from the intent.
6117 *
6118 * @param name The name of the desired item.
6119 * @param defaultValue the value to be returned if no value of the desired
6120 * type is stored with the given name.
6121 *
6122 * @return the value of an item that previously added with putExtra()
6123 * or the default value if none was found.
6124 *
6125 * @see #putExtra(String, char)
6126 */
6127 public char getCharExtra(String name, char defaultValue) {
6128 return mExtras == null ? defaultValue :
6129 mExtras.getChar(name, defaultValue);
6130 }
6131
6132 /**
6133 * Retrieve extended data from the intent.
6134 *
6135 * @param name The name of the desired item.
6136 * @param defaultValue the value to be returned if no value of the desired
6137 * type is stored with the given name.
6138 *
6139 * @return the value of an item that previously added with putExtra()
6140 * or the default value if none was found.
6141 *
6142 * @see #putExtra(String, int)
6143 */
6144 public int getIntExtra(String name, int defaultValue) {
6145 return mExtras == null ? defaultValue :
6146 mExtras.getInt(name, defaultValue);
6147 }
6148
6149 /**
6150 * Retrieve extended data from the intent.
6151 *
6152 * @param name The name of the desired item.
6153 * @param defaultValue the value to be returned if no value of the desired
6154 * type is stored with the given name.
6155 *
6156 * @return the value of an item that previously added with putExtra()
6157 * or the default value if none was found.
6158 *
6159 * @see #putExtra(String, long)
6160 */
6161 public long getLongExtra(String name, long defaultValue) {
6162 return mExtras == null ? defaultValue :
6163 mExtras.getLong(name, defaultValue);
6164 }
6165
6166 /**
6167 * Retrieve extended data from the intent.
6168 *
6169 * @param name The name of the desired item.
6170 * @param defaultValue the value to be returned if no value of the desired
6171 * type is stored with the given name.
6172 *
6173 * @return the value of an item that previously added with putExtra(),
6174 * or the default value if no such item is present
6175 *
6176 * @see #putExtra(String, float)
6177 */
6178 public float getFloatExtra(String name, float defaultValue) {
6179 return mExtras == null ? defaultValue :
6180 mExtras.getFloat(name, defaultValue);
6181 }
6182
6183 /**
6184 * Retrieve extended data from the intent.
6185 *
6186 * @param name The name of the desired item.
6187 * @param defaultValue the value to be returned if no value of the desired
6188 * type is stored with the given name.
6189 *
6190 * @return the value of an item that previously added with putExtra()
6191 * or the default value if none was found.
6192 *
6193 * @see #putExtra(String, double)
6194 */
6195 public double getDoubleExtra(String name, double defaultValue) {
6196 return mExtras == null ? defaultValue :
6197 mExtras.getDouble(name, defaultValue);
6198 }
6199
6200 /**
6201 * Retrieve extended data from the intent.
6202 *
6203 * @param name The name of the desired item.
6204 *
6205 * @return the value of an item that previously added with putExtra()
6206 * or null if no String value was found.
6207 *
6208 * @see #putExtra(String, String)
6209 */
6210 public String getStringExtra(String name) {
6211 return mExtras == null ? null : mExtras.getString(name);
6212 }
6213
6214 /**
6215 * Retrieve extended data from the intent.
6216 *
6217 * @param name The name of the desired item.
6218 *
6219 * @return the value of an item that previously added with putExtra()
6220 * or null if no CharSequence value was found.
6221 *
6222 * @see #putExtra(String, CharSequence)
6223 */
6224 public CharSequence getCharSequenceExtra(String name) {
6225 return mExtras == null ? null : mExtras.getCharSequence(name);
6226 }
6227
6228 /**
6229 * Retrieve extended data from the intent.
6230 *
6231 * @param name The name of the desired item.
6232 *
6233 * @return the value of an item that previously added with putExtra()
6234 * or null if no Parcelable value was found.
6235 *
6236 * @see #putExtra(String, Parcelable)
6237 */
6238 public <T extends Parcelable> T getParcelableExtra(String name) {
6239 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6240 }
6241
6242 /**
6243 * Retrieve extended data from the intent.
6244 *
6245 * @param name The name of the desired item.
6246 *
6247 * @return the value of an item that previously added with putExtra()
6248 * or null if no Parcelable[] value was found.
6249 *
6250 * @see #putExtra(String, Parcelable[])
6251 */
6252 public Parcelable[] getParcelableArrayExtra(String name) {
6253 return mExtras == null ? null : mExtras.getParcelableArray(name);
6254 }
6255
6256 /**
6257 * Retrieve extended data from the intent.
6258 *
6259 * @param name The name of the desired item.
6260 *
6261 * @return the value of an item that previously added with putExtra()
6262 * or null if no ArrayList<Parcelable> value was found.
6263 *
6264 * @see #putParcelableArrayListExtra(String, ArrayList)
6265 */
6266 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6267 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6268 }
6269
6270 /**
6271 * Retrieve extended data from the intent.
6272 *
6273 * @param name The name of the desired item.
6274 *
6275 * @return the value of an item that previously added with putExtra()
6276 * or null if no Serializable value was found.
6277 *
6278 * @see #putExtra(String, Serializable)
6279 */
6280 public Serializable getSerializableExtra(String name) {
6281 return mExtras == null ? null : mExtras.getSerializable(name);
6282 }
6283
6284 /**
6285 * Retrieve extended data from the intent.
6286 *
6287 * @param name The name of the desired item.
6288 *
6289 * @return the value of an item that previously added with putExtra()
6290 * or null if no ArrayList<Integer> value was found.
6291 *
6292 * @see #putIntegerArrayListExtra(String, ArrayList)
6293 */
6294 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6295 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6296 }
6297
6298 /**
6299 * Retrieve extended data from the intent.
6300 *
6301 * @param name The name of the desired item.
6302 *
6303 * @return the value of an item that previously added with putExtra()
6304 * or null if no ArrayList<String> value was found.
6305 *
6306 * @see #putStringArrayListExtra(String, ArrayList)
6307 */
6308 public ArrayList<String> getStringArrayListExtra(String name) {
6309 return mExtras == null ? null : mExtras.getStringArrayList(name);
6310 }
6311
6312 /**
6313 * Retrieve extended data from the intent.
6314 *
6315 * @param name The name of the desired item.
6316 *
6317 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006318 * or null if no ArrayList<CharSequence> value was found.
6319 *
6320 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6321 */
6322 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6323 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6324 }
6325
6326 /**
6327 * Retrieve extended data from the intent.
6328 *
6329 * @param name The name of the desired item.
6330 *
6331 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006332 * or null if no boolean array value was found.
6333 *
6334 * @see #putExtra(String, boolean[])
6335 */
6336 public boolean[] getBooleanArrayExtra(String name) {
6337 return mExtras == null ? null : mExtras.getBooleanArray(name);
6338 }
6339
6340 /**
6341 * Retrieve extended data from the intent.
6342 *
6343 * @param name The name of the desired item.
6344 *
6345 * @return the value of an item that previously added with putExtra()
6346 * or null if no byte array value was found.
6347 *
6348 * @see #putExtra(String, byte[])
6349 */
6350 public byte[] getByteArrayExtra(String name) {
6351 return mExtras == null ? null : mExtras.getByteArray(name);
6352 }
6353
6354 /**
6355 * Retrieve extended data from the intent.
6356 *
6357 * @param name The name of the desired item.
6358 *
6359 * @return the value of an item that previously added with putExtra()
6360 * or null if no short array value was found.
6361 *
6362 * @see #putExtra(String, short[])
6363 */
6364 public short[] getShortArrayExtra(String name) {
6365 return mExtras == null ? null : mExtras.getShortArray(name);
6366 }
6367
6368 /**
6369 * Retrieve extended data from the intent.
6370 *
6371 * @param name The name of the desired item.
6372 *
6373 * @return the value of an item that previously added with putExtra()
6374 * or null if no char array value was found.
6375 *
6376 * @see #putExtra(String, char[])
6377 */
6378 public char[] getCharArrayExtra(String name) {
6379 return mExtras == null ? null : mExtras.getCharArray(name);
6380 }
6381
6382 /**
6383 * Retrieve extended data from the intent.
6384 *
6385 * @param name The name of the desired item.
6386 *
6387 * @return the value of an item that previously added with putExtra()
6388 * or null if no int array value was found.
6389 *
6390 * @see #putExtra(String, int[])
6391 */
6392 public int[] getIntArrayExtra(String name) {
6393 return mExtras == null ? null : mExtras.getIntArray(name);
6394 }
6395
6396 /**
6397 * Retrieve extended data from the intent.
6398 *
6399 * @param name The name of the desired item.
6400 *
6401 * @return the value of an item that previously added with putExtra()
6402 * or null if no long array value was found.
6403 *
6404 * @see #putExtra(String, long[])
6405 */
6406 public long[] getLongArrayExtra(String name) {
6407 return mExtras == null ? null : mExtras.getLongArray(name);
6408 }
6409
6410 /**
6411 * Retrieve extended data from the intent.
6412 *
6413 * @param name The name of the desired item.
6414 *
6415 * @return the value of an item that previously added with putExtra()
6416 * or null if no float array value was found.
6417 *
6418 * @see #putExtra(String, float[])
6419 */
6420 public float[] getFloatArrayExtra(String name) {
6421 return mExtras == null ? null : mExtras.getFloatArray(name);
6422 }
6423
6424 /**
6425 * Retrieve extended data from the intent.
6426 *
6427 * @param name The name of the desired item.
6428 *
6429 * @return the value of an item that previously added with putExtra()
6430 * or null if no double array value was found.
6431 *
6432 * @see #putExtra(String, double[])
6433 */
6434 public double[] getDoubleArrayExtra(String name) {
6435 return mExtras == null ? null : mExtras.getDoubleArray(name);
6436 }
6437
6438 /**
6439 * Retrieve extended data from the intent.
6440 *
6441 * @param name The name of the desired item.
6442 *
6443 * @return the value of an item that previously added with putExtra()
6444 * or null if no String array value was found.
6445 *
6446 * @see #putExtra(String, String[])
6447 */
6448 public String[] getStringArrayExtra(String name) {
6449 return mExtras == null ? null : mExtras.getStringArray(name);
6450 }
6451
6452 /**
6453 * Retrieve extended data from the intent.
6454 *
6455 * @param name The name of the desired item.
6456 *
6457 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006458 * or null if no CharSequence array value was found.
6459 *
6460 * @see #putExtra(String, CharSequence[])
6461 */
6462 public CharSequence[] getCharSequenceArrayExtra(String name) {
6463 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6464 }
6465
6466 /**
6467 * Retrieve extended data from the intent.
6468 *
6469 * @param name The name of the desired item.
6470 *
6471 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006472 * or null if no Bundle value was found.
6473 *
6474 * @see #putExtra(String, Bundle)
6475 */
6476 public Bundle getBundleExtra(String name) {
6477 return mExtras == null ? null : mExtras.getBundle(name);
6478 }
6479
6480 /**
6481 * Retrieve extended data from the intent.
6482 *
6483 * @param name The name of the desired item.
6484 *
6485 * @return the value of an item that previously added with putExtra()
6486 * or null if no IBinder value was found.
6487 *
6488 * @see #putExtra(String, IBinder)
6489 *
6490 * @deprecated
6491 * @hide
6492 */
6493 @Deprecated
6494 public IBinder getIBinderExtra(String name) {
6495 return mExtras == null ? null : mExtras.getIBinder(name);
6496 }
6497
6498 /**
6499 * Retrieve extended data from the intent.
6500 *
6501 * @param name The name of the desired item.
6502 * @param defaultValue The default value to return in case no item is
6503 * associated with the key 'name'
6504 *
6505 * @return the value of an item that previously added with putExtra()
6506 * or defaultValue if none was found.
6507 *
6508 * @see #putExtra
6509 *
6510 * @deprecated
6511 * @hide
6512 */
6513 @Deprecated
6514 public Object getExtra(String name, Object defaultValue) {
6515 Object result = defaultValue;
6516 if (mExtras != null) {
6517 Object result2 = mExtras.get(name);
6518 if (result2 != null) {
6519 result = result2;
6520 }
6521 }
6522
6523 return result;
6524 }
6525
6526 /**
6527 * Retrieves a map of extended data from the intent.
6528 *
6529 * @return the map of all extras previously added with putExtra(),
6530 * or null if none have been added.
6531 */
6532 public Bundle getExtras() {
6533 return (mExtras != null)
6534 ? new Bundle(mExtras)
6535 : null;
6536 }
6537
6538 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006539 * Filter extras to only basic types.
6540 * @hide
6541 */
6542 public void removeUnsafeExtras() {
6543 if (mExtras != null) {
6544 mExtras.filterValues();
6545 }
6546 }
6547
6548 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006549 * Retrieve any special flags associated with this intent. You will
6550 * normally just set them with {@link #setFlags} and let the system
6551 * take the appropriate action with them.
6552 *
6553 * @return int The currently set flags.
6554 *
6555 * @see #setFlags
6556 */
6557 public int getFlags() {
6558 return mFlags;
6559 }
6560
Dianne Hackborne7f97212011-02-24 14:40:20 -08006561 /** @hide */
6562 public boolean isExcludingStopped() {
6563 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6564 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6565 }
6566
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006567 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006568 * Retrieve the application package name this Intent is limited to. When
6569 * resolving an Intent, if non-null this limits the resolution to only
6570 * components in the given application package.
6571 *
6572 * @return The name of the application package for the Intent.
6573 *
6574 * @see #resolveActivity
6575 * @see #setPackage
6576 */
6577 public String getPackage() {
6578 return mPackage;
6579 }
6580
6581 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006582 * Retrieve the concrete component associated with the intent. When receiving
6583 * an intent, this is the component that was found to best handle it (that is,
6584 * yourself) and will always be non-null; in all other cases it will be
6585 * null unless explicitly set.
6586 *
6587 * @return The name of the application component to handle the intent.
6588 *
6589 * @see #resolveActivity
6590 * @see #setComponent
6591 */
6592 public ComponentName getComponent() {
6593 return mComponent;
6594 }
6595
6596 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006597 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6598 * used as a hint to the receiver for animations and the like. Null means that there
6599 * is no source bounds.
6600 */
6601 public Rect getSourceBounds() {
6602 return mSourceBounds;
6603 }
6604
6605 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006606 * Return the Activity component that should be used to handle this intent.
6607 * The appropriate component is determined based on the information in the
6608 * intent, evaluated as follows:
6609 *
6610 * <p>If {@link #getComponent} returns an explicit class, that is returned
6611 * without any further consideration.
6612 *
6613 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6614 * category to be considered.
6615 *
6616 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6617 * action.
6618 *
6619 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6620 * this type.
6621 *
6622 * <p>If {@link #addCategory} has added any categories, the activity must
6623 * handle ALL of the categories specified.
6624 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006625 * <p>If {@link #getPackage} is non-NULL, only activity components in
6626 * that application package will be considered.
6627 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006628 * <p>If there are no activities that satisfy all of these conditions, a
6629 * null string is returned.
6630 *
6631 * <p>If multiple activities are found to satisfy the intent, the one with
6632 * the highest priority will be used. If there are multiple activities
6633 * with the same priority, the system will either pick the best activity
6634 * based on user preference, or resolve to a system class that will allow
6635 * the user to pick an activity and forward from there.
6636 *
6637 * <p>This method is implemented simply by calling
6638 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6639 * true.</p>
6640 * <p> This API is called for you as part of starting an activity from an
6641 * intent. You do not normally need to call it yourself.</p>
6642 *
6643 * @param pm The package manager with which to resolve the Intent.
6644 *
6645 * @return Name of the component implementing an activity that can
6646 * display the intent.
6647 *
6648 * @see #setComponent
6649 * @see #getComponent
6650 * @see #resolveActivityInfo
6651 */
6652 public ComponentName resolveActivity(PackageManager pm) {
6653 if (mComponent != null) {
6654 return mComponent;
6655 }
6656
6657 ResolveInfo info = pm.resolveActivity(
6658 this, PackageManager.MATCH_DEFAULT_ONLY);
6659 if (info != null) {
6660 return new ComponentName(
6661 info.activityInfo.applicationInfo.packageName,
6662 info.activityInfo.name);
6663 }
6664
6665 return null;
6666 }
6667
6668 /**
6669 * Resolve the Intent into an {@link ActivityInfo}
6670 * describing the activity that should execute the intent. Resolution
6671 * follows the same rules as described for {@link #resolveActivity}, but
6672 * you get back the completely information about the resolved activity
6673 * instead of just its class name.
6674 *
6675 * @param pm The package manager with which to resolve the Intent.
6676 * @param flags Addition information to retrieve as per
6677 * {@link PackageManager#getActivityInfo(ComponentName, int)
6678 * PackageManager.getActivityInfo()}.
6679 *
6680 * @return PackageManager.ActivityInfo
6681 *
6682 * @see #resolveActivity
6683 */
6684 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6685 ActivityInfo ai = null;
6686 if (mComponent != null) {
6687 try {
6688 ai = pm.getActivityInfo(mComponent, flags);
6689 } catch (PackageManager.NameNotFoundException e) {
6690 // ignore
6691 }
6692 } else {
6693 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006694 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006695 if (info != null) {
6696 ai = info.activityInfo;
6697 }
6698 }
6699
6700 return ai;
6701 }
6702
6703 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006704 * Special function for use by the system to resolve service
6705 * intents to system apps. Throws an exception if there are
6706 * multiple potential matches to the Intent. Returns null if
6707 * there are no matches.
6708 * @hide
6709 */
6710 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6711 if (mComponent != null) {
6712 return mComponent;
6713 }
6714
6715 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6716 if (results == null) {
6717 return null;
6718 }
6719 ComponentName comp = null;
6720 for (int i=0; i<results.size(); i++) {
6721 ResolveInfo ri = results.get(i);
6722 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6723 continue;
6724 }
6725 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6726 ri.serviceInfo.name);
6727 if (comp != null) {
6728 throw new IllegalStateException("Multiple system services handle " + this
6729 + ": " + comp + ", " + foundComp);
6730 }
6731 comp = foundComp;
6732 }
6733 return comp;
6734 }
6735
6736 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006737 * Set the general action to be performed.
6738 *
6739 * @param action An action name, such as ACTION_VIEW. Application-specific
6740 * actions should be prefixed with the vendor's package name.
6741 *
6742 * @return Returns the same Intent object, for chaining multiple calls
6743 * into a single statement.
6744 *
6745 * @see #getAction
6746 */
6747 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006748 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006749 return this;
6750 }
6751
6752 /**
6753 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006754 * clears any type that was previously set by {@link #setType} or
6755 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006756 *
Nick Pellyccae4122012-01-09 14:12:58 -08006757 * <p><em>Note: scheme matching in the Android framework is
6758 * case-sensitive, unlike the formal RFC. As a result,
6759 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006760 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006761 * {@link #setDataAndNormalize}
6762 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006763 *
Nick Pellyccae4122012-01-09 14:12:58 -08006764 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006765 *
6766 * @return Returns the same Intent object, for chaining multiple calls
6767 * into a single statement.
6768 *
6769 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006770 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006771 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006772 */
6773 public Intent setData(Uri data) {
6774 mData = data;
6775 mType = null;
6776 return this;
6777 }
6778
6779 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006780 * Normalize and set the data this intent is operating on.
6781 *
6782 * <p>This method automatically clears any type that was
6783 * previously set (for example, by {@link #setType}).
6784 *
6785 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006786 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006787 * so really this is just a convenience method for
6788 * <pre>
6789 * setData(data.normalize())
6790 * </pre>
6791 *
6792 * @param data The Uri of the data this intent is now targeting.
6793 *
6794 * @return Returns the same Intent object, for chaining multiple calls
6795 * into a single statement.
6796 *
6797 * @see #getData
6798 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006799 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006800 */
6801 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006802 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006803 }
6804
6805 /**
6806 * Set an explicit MIME data type.
6807 *
6808 * <p>This is used to create intents that only specify a type and not data,
6809 * for example to indicate the type of data to return.
6810 *
6811 * <p>This method automatically clears any data that was
6812 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006813 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006814 * <p><em>Note: MIME type matching in the Android framework is
6815 * case-sensitive, unlike formal RFC MIME types. As a result,
6816 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006817 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6818 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006819 *
6820 * @param type The MIME type of the data being handled by this intent.
6821 *
6822 * @return Returns the same Intent object, for chaining multiple calls
6823 * into a single statement.
6824 *
6825 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006826 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006827 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006828 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006829 */
6830 public Intent setType(String type) {
6831 mData = null;
6832 mType = type;
6833 return this;
6834 }
6835
6836 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006837 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006838 *
Nick Pellyccae4122012-01-09 14:12:58 -08006839 * <p>This is used to create intents that only specify a type and not data,
6840 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006841 *
Nick Pellyccae4122012-01-09 14:12:58 -08006842 * <p>This method automatically clears any data that was
6843 * previously set (for example by {@link #setData}).
6844 *
6845 * <p>The MIME type is normalized using
6846 * {@link #normalizeMimeType} before it is set,
6847 * so really this is just a convenience method for
6848 * <pre>
6849 * setType(Intent.normalizeMimeType(type))
6850 * </pre>
6851 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006852 * @param type The MIME type of the data being handled by this intent.
6853 *
6854 * @return Returns the same Intent object, for chaining multiple calls
6855 * into a single statement.
6856 *
Nick Pellyccae4122012-01-09 14:12:58 -08006857 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006858 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006859 * @see #normalizeMimeType
6860 */
6861 public Intent setTypeAndNormalize(String type) {
6862 return setType(normalizeMimeType(type));
6863 }
6864
6865 /**
6866 * (Usually optional) Set the data for the intent along with an explicit
6867 * MIME data type. This method should very rarely be used -- it allows you
6868 * to override the MIME type that would ordinarily be inferred from the
6869 * data with your own type given here.
6870 *
6871 * <p><em>Note: MIME type and Uri scheme matching in the
6872 * Android framework is case-sensitive, unlike the formal RFC definitions.
6873 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006874 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006875 * {@link #setDataAndTypeAndNormalize}
6876 * to ensure that they are converted to lower case.</em>
6877 *
6878 * @param data The Uri of the data this intent is now targeting.
6879 * @param type The MIME type of the data being handled by this intent.
6880 *
6881 * @return Returns the same Intent object, for chaining multiple calls
6882 * into a single statement.
6883 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006884 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006885 * @see #setData
6886 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006887 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006888 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006889 */
6890 public Intent setDataAndType(Uri data, String type) {
6891 mData = data;
6892 mType = type;
6893 return this;
6894 }
6895
6896 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006897 * (Usually optional) Normalize and set both the data Uri and an explicit
6898 * MIME data type. This method should very rarely be used -- it allows you
6899 * to override the MIME type that would ordinarily be inferred from the
6900 * data with your own type given here.
6901 *
6902 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006903 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006904 * before they are set, so really this is just a convenience method for
6905 * <pre>
6906 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6907 * </pre>
6908 *
6909 * @param data The Uri of the data this intent is now targeting.
6910 * @param type The MIME type of the data being handled by this intent.
6911 *
6912 * @return Returns the same Intent object, for chaining multiple calls
6913 * into a single statement.
6914 *
6915 * @see #setType
6916 * @see #setData
6917 * @see #setDataAndType
6918 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006919 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006920 */
6921 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006922 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006923 }
6924
6925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006926 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006927 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006928 * activities that provide <em>all</em> of the requested categories will be
6929 * used.
6930 *
6931 * @param category The desired category. This can be either one of the
6932 * predefined Intent categories, or a custom category in your own
6933 * namespace.
6934 *
6935 * @return Returns the same Intent object, for chaining multiple calls
6936 * into a single statement.
6937 *
6938 * @see #hasCategory
6939 * @see #removeCategory
6940 */
6941 public Intent addCategory(String category) {
6942 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006943 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006944 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006945 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006946 return this;
6947 }
6948
6949 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006950 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 *
6952 * @param category The category to remove.
6953 *
6954 * @see #addCategory
6955 */
6956 public void removeCategory(String category) {
6957 if (mCategories != null) {
6958 mCategories.remove(category);
6959 if (mCategories.size() == 0) {
6960 mCategories = null;
6961 }
6962 }
6963 }
6964
6965 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006966 * Set a selector for this Intent. This is a modification to the kinds of
6967 * things the Intent will match. If the selector is set, it will be used
6968 * when trying to find entities that can handle the Intent, instead of the
6969 * main contents of the Intent. This allows you build an Intent containing
6970 * a generic protocol while targeting it more specifically.
6971 *
6972 * <p>An example of where this may be used is with things like
6973 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6974 * Intent that will launch the Browser application. However, the correct
6975 * main entry point of an application is actually {@link #ACTION_MAIN}
6976 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
6977 * used to specify the actual Activity to launch. If you launch the browser
6978 * with something different, undesired behavior may happen if the user has
6979 * previously or later launches it the normal way, since they do not match.
6980 * Instead, you can build an Intent with the MAIN action (but no ComponentName
6981 * yet specified) and set a selector with {@link #ACTION_MAIN} and
6982 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
6983 *
6984 * <p>Setting a selector does not impact the behavior of
6985 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
6986 * desired behavior of a selector -- it does not impact the base meaning
6987 * of the Intent, just what kinds of things will be matched against it
6988 * when determining who can handle it.</p>
6989 *
6990 * <p>You can not use both a selector and {@link #setPackage(String)} on
6991 * the same base Intent.</p>
6992 *
6993 * @param selector The desired selector Intent; set to null to not use
6994 * a special selector.
6995 */
6996 public void setSelector(Intent selector) {
6997 if (selector == this) {
6998 throw new IllegalArgumentException(
6999 "Intent being set as a selector of itself");
7000 }
7001 if (selector != null && mPackage != null) {
7002 throw new IllegalArgumentException(
7003 "Can't set selector when package name is already set");
7004 }
7005 mSelector = selector;
7006 }
7007
7008 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007009 * Set a {@link ClipData} associated with this Intent. This replaces any
7010 * previously set ClipData.
7011 *
7012 * <p>The ClipData in an intent is not used for Intent matching or other
7013 * such operations. Semantically it is like extras, used to transmit
7014 * additional data with the Intent. The main feature of using this over
7015 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7016 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7017 * items included in the clip data. This is useful, in particular, if
7018 * you want to transmit an Intent containing multiple <code>content:</code>
7019 * URIs for which the recipient may not have global permission to access the
7020 * content provider.
7021 *
7022 * <p>If the ClipData contains items that are themselves Intents, any
7023 * grant flags in those Intents will be ignored. Only the top-level flags
7024 * of the main Intent are respected, and will be applied to all Uri or
7025 * Intent items in the clip (or sub-items of the clip).
7026 *
7027 * <p>The MIME type, label, and icon in the ClipData object are not
7028 * directly used by Intent. Applications should generally rely on the
7029 * MIME type of the Intent itself, not what it may find in the ClipData.
7030 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007031 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007032 *
7033 * @param clip The new clip to set. May be null to clear the current clip.
7034 */
7035 public void setClipData(ClipData clip) {
7036 mClipData = clip;
7037 }
7038
7039 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007040 * This is NOT a secure mechanism to identify the user who sent the intent.
7041 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7042 * who sent the intent.
7043 * @hide
7044 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007045 public void prepareToLeaveUser(int userId) {
7046 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7047 // We want mContentUserHint to refer to the original user, so don't do anything.
7048 if (mContentUserHint == UserHandle.USER_CURRENT) {
7049 mContentUserHint = userId;
7050 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007051 }
7052
7053 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007054 * Add extended data to the intent. The name must include a package
7055 * prefix, for example the app com.android.contacts would use names
7056 * like "com.android.contacts.ShowAll".
7057 *
7058 * @param name The name of the extra data, with package prefix.
7059 * @param value The boolean data value.
7060 *
7061 * @return Returns the same Intent object, for chaining multiple calls
7062 * into a single statement.
7063 *
7064 * @see #putExtras
7065 * @see #removeExtra
7066 * @see #getBooleanExtra(String, boolean)
7067 */
7068 public Intent putExtra(String name, boolean value) {
7069 if (mExtras == null) {
7070 mExtras = new Bundle();
7071 }
7072 mExtras.putBoolean(name, value);
7073 return this;
7074 }
7075
7076 /**
7077 * Add extended data to the intent. The name must include a package
7078 * prefix, for example the app com.android.contacts would use names
7079 * like "com.android.contacts.ShowAll".
7080 *
7081 * @param name The name of the extra data, with package prefix.
7082 * @param value The byte data value.
7083 *
7084 * @return Returns the same Intent object, for chaining multiple calls
7085 * into a single statement.
7086 *
7087 * @see #putExtras
7088 * @see #removeExtra
7089 * @see #getByteExtra(String, byte)
7090 */
7091 public Intent putExtra(String name, byte value) {
7092 if (mExtras == null) {
7093 mExtras = new Bundle();
7094 }
7095 mExtras.putByte(name, value);
7096 return this;
7097 }
7098
7099 /**
7100 * Add extended data to the intent. The name must include a package
7101 * prefix, for example the app com.android.contacts would use names
7102 * like "com.android.contacts.ShowAll".
7103 *
7104 * @param name The name of the extra data, with package prefix.
7105 * @param value The char data value.
7106 *
7107 * @return Returns the same Intent object, for chaining multiple calls
7108 * into a single statement.
7109 *
7110 * @see #putExtras
7111 * @see #removeExtra
7112 * @see #getCharExtra(String, char)
7113 */
7114 public Intent putExtra(String name, char value) {
7115 if (mExtras == null) {
7116 mExtras = new Bundle();
7117 }
7118 mExtras.putChar(name, value);
7119 return this;
7120 }
7121
7122 /**
7123 * Add extended data to the intent. The name must include a package
7124 * prefix, for example the app com.android.contacts would use names
7125 * like "com.android.contacts.ShowAll".
7126 *
7127 * @param name The name of the extra data, with package prefix.
7128 * @param value The short data value.
7129 *
7130 * @return Returns the same Intent object, for chaining multiple calls
7131 * into a single statement.
7132 *
7133 * @see #putExtras
7134 * @see #removeExtra
7135 * @see #getShortExtra(String, short)
7136 */
7137 public Intent putExtra(String name, short value) {
7138 if (mExtras == null) {
7139 mExtras = new Bundle();
7140 }
7141 mExtras.putShort(name, value);
7142 return this;
7143 }
7144
7145 /**
7146 * Add extended data to the intent. The name must include a package
7147 * prefix, for example the app com.android.contacts would use names
7148 * like "com.android.contacts.ShowAll".
7149 *
7150 * @param name The name of the extra data, with package prefix.
7151 * @param value The integer data value.
7152 *
7153 * @return Returns the same Intent object, for chaining multiple calls
7154 * into a single statement.
7155 *
7156 * @see #putExtras
7157 * @see #removeExtra
7158 * @see #getIntExtra(String, int)
7159 */
7160 public Intent putExtra(String name, int value) {
7161 if (mExtras == null) {
7162 mExtras = new Bundle();
7163 }
7164 mExtras.putInt(name, value);
7165 return this;
7166 }
7167
7168 /**
7169 * Add extended data to the intent. The name must include a package
7170 * prefix, for example the app com.android.contacts would use names
7171 * like "com.android.contacts.ShowAll".
7172 *
7173 * @param name The name of the extra data, with package prefix.
7174 * @param value The long data value.
7175 *
7176 * @return Returns the same Intent object, for chaining multiple calls
7177 * into a single statement.
7178 *
7179 * @see #putExtras
7180 * @see #removeExtra
7181 * @see #getLongExtra(String, long)
7182 */
7183 public Intent putExtra(String name, long value) {
7184 if (mExtras == null) {
7185 mExtras = new Bundle();
7186 }
7187 mExtras.putLong(name, value);
7188 return this;
7189 }
7190
7191 /**
7192 * Add extended data to the intent. The name must include a package
7193 * prefix, for example the app com.android.contacts would use names
7194 * like "com.android.contacts.ShowAll".
7195 *
7196 * @param name The name of the extra data, with package prefix.
7197 * @param value The float data value.
7198 *
7199 * @return Returns the same Intent object, for chaining multiple calls
7200 * into a single statement.
7201 *
7202 * @see #putExtras
7203 * @see #removeExtra
7204 * @see #getFloatExtra(String, float)
7205 */
7206 public Intent putExtra(String name, float value) {
7207 if (mExtras == null) {
7208 mExtras = new Bundle();
7209 }
7210 mExtras.putFloat(name, value);
7211 return this;
7212 }
7213
7214 /**
7215 * Add extended data to the intent. The name must include a package
7216 * prefix, for example the app com.android.contacts would use names
7217 * like "com.android.contacts.ShowAll".
7218 *
7219 * @param name The name of the extra data, with package prefix.
7220 * @param value The double data value.
7221 *
7222 * @return Returns the same Intent object, for chaining multiple calls
7223 * into a single statement.
7224 *
7225 * @see #putExtras
7226 * @see #removeExtra
7227 * @see #getDoubleExtra(String, double)
7228 */
7229 public Intent putExtra(String name, double value) {
7230 if (mExtras == null) {
7231 mExtras = new Bundle();
7232 }
7233 mExtras.putDouble(name, value);
7234 return this;
7235 }
7236
7237 /**
7238 * Add extended data to the intent. The name must include a package
7239 * prefix, for example the app com.android.contacts would use names
7240 * like "com.android.contacts.ShowAll".
7241 *
7242 * @param name The name of the extra data, with package prefix.
7243 * @param value The String data value.
7244 *
7245 * @return Returns the same Intent object, for chaining multiple calls
7246 * into a single statement.
7247 *
7248 * @see #putExtras
7249 * @see #removeExtra
7250 * @see #getStringExtra(String)
7251 */
7252 public Intent putExtra(String name, String value) {
7253 if (mExtras == null) {
7254 mExtras = new Bundle();
7255 }
7256 mExtras.putString(name, value);
7257 return this;
7258 }
7259
7260 /**
7261 * Add extended data to the intent. The name must include a package
7262 * prefix, for example the app com.android.contacts would use names
7263 * like "com.android.contacts.ShowAll".
7264 *
7265 * @param name The name of the extra data, with package prefix.
7266 * @param value The CharSequence data value.
7267 *
7268 * @return Returns the same Intent object, for chaining multiple calls
7269 * into a single statement.
7270 *
7271 * @see #putExtras
7272 * @see #removeExtra
7273 * @see #getCharSequenceExtra(String)
7274 */
7275 public Intent putExtra(String name, CharSequence value) {
7276 if (mExtras == null) {
7277 mExtras = new Bundle();
7278 }
7279 mExtras.putCharSequence(name, value);
7280 return this;
7281 }
7282
7283 /**
7284 * Add extended data to the intent. The name must include a package
7285 * prefix, for example the app com.android.contacts would use names
7286 * like "com.android.contacts.ShowAll".
7287 *
7288 * @param name The name of the extra data, with package prefix.
7289 * @param value The Parcelable data value.
7290 *
7291 * @return Returns the same Intent object, for chaining multiple calls
7292 * into a single statement.
7293 *
7294 * @see #putExtras
7295 * @see #removeExtra
7296 * @see #getParcelableExtra(String)
7297 */
7298 public Intent putExtra(String name, Parcelable value) {
7299 if (mExtras == null) {
7300 mExtras = new Bundle();
7301 }
7302 mExtras.putParcelable(name, value);
7303 return this;
7304 }
7305
7306 /**
7307 * Add extended data to the intent. The name must include a package
7308 * prefix, for example the app com.android.contacts would use names
7309 * like "com.android.contacts.ShowAll".
7310 *
7311 * @param name The name of the extra data, with package prefix.
7312 * @param value The Parcelable[] data value.
7313 *
7314 * @return Returns the same Intent object, for chaining multiple calls
7315 * into a single statement.
7316 *
7317 * @see #putExtras
7318 * @see #removeExtra
7319 * @see #getParcelableArrayExtra(String)
7320 */
7321 public Intent putExtra(String name, Parcelable[] value) {
7322 if (mExtras == null) {
7323 mExtras = new Bundle();
7324 }
7325 mExtras.putParcelableArray(name, value);
7326 return this;
7327 }
7328
7329 /**
7330 * Add extended data to the intent. The name must include a package
7331 * prefix, for example the app com.android.contacts would use names
7332 * like "com.android.contacts.ShowAll".
7333 *
7334 * @param name The name of the extra data, with package prefix.
7335 * @param value The ArrayList<Parcelable> data value.
7336 *
7337 * @return Returns the same Intent object, for chaining multiple calls
7338 * into a single statement.
7339 *
7340 * @see #putExtras
7341 * @see #removeExtra
7342 * @see #getParcelableArrayListExtra(String)
7343 */
7344 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7345 if (mExtras == null) {
7346 mExtras = new Bundle();
7347 }
7348 mExtras.putParcelableArrayList(name, value);
7349 return this;
7350 }
7351
7352 /**
7353 * Add extended data to the intent. The name must include a package
7354 * prefix, for example the app com.android.contacts would use names
7355 * like "com.android.contacts.ShowAll".
7356 *
7357 * @param name The name of the extra data, with package prefix.
7358 * @param value The ArrayList<Integer> data value.
7359 *
7360 * @return Returns the same Intent object, for chaining multiple calls
7361 * into a single statement.
7362 *
7363 * @see #putExtras
7364 * @see #removeExtra
7365 * @see #getIntegerArrayListExtra(String)
7366 */
7367 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7368 if (mExtras == null) {
7369 mExtras = new Bundle();
7370 }
7371 mExtras.putIntegerArrayList(name, value);
7372 return this;
7373 }
7374
7375 /**
7376 * Add extended data to the intent. The name must include a package
7377 * prefix, for example the app com.android.contacts would use names
7378 * like "com.android.contacts.ShowAll".
7379 *
7380 * @param name The name of the extra data, with package prefix.
7381 * @param value The ArrayList<String> data value.
7382 *
7383 * @return Returns the same Intent object, for chaining multiple calls
7384 * into a single statement.
7385 *
7386 * @see #putExtras
7387 * @see #removeExtra
7388 * @see #getStringArrayListExtra(String)
7389 */
7390 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7391 if (mExtras == null) {
7392 mExtras = new Bundle();
7393 }
7394 mExtras.putStringArrayList(name, value);
7395 return this;
7396 }
7397
7398 /**
7399 * Add extended data to the intent. The name must include a package
7400 * prefix, for example the app com.android.contacts would use names
7401 * like "com.android.contacts.ShowAll".
7402 *
7403 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007404 * @param value The ArrayList<CharSequence> data value.
7405 *
7406 * @return Returns the same Intent object, for chaining multiple calls
7407 * into a single statement.
7408 *
7409 * @see #putExtras
7410 * @see #removeExtra
7411 * @see #getCharSequenceArrayListExtra(String)
7412 */
7413 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7414 if (mExtras == null) {
7415 mExtras = new Bundle();
7416 }
7417 mExtras.putCharSequenceArrayList(name, value);
7418 return this;
7419 }
7420
7421 /**
7422 * Add extended data to the intent. The name must include a package
7423 * prefix, for example the app com.android.contacts would use names
7424 * like "com.android.contacts.ShowAll".
7425 *
7426 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007427 * @param value The Serializable data value.
7428 *
7429 * @return Returns the same Intent object, for chaining multiple calls
7430 * into a single statement.
7431 *
7432 * @see #putExtras
7433 * @see #removeExtra
7434 * @see #getSerializableExtra(String)
7435 */
7436 public Intent putExtra(String name, Serializable value) {
7437 if (mExtras == null) {
7438 mExtras = new Bundle();
7439 }
7440 mExtras.putSerializable(name, value);
7441 return this;
7442 }
7443
7444 /**
7445 * Add extended data to the intent. The name must include a package
7446 * prefix, for example the app com.android.contacts would use names
7447 * like "com.android.contacts.ShowAll".
7448 *
7449 * @param name The name of the extra data, with package prefix.
7450 * @param value The boolean array data value.
7451 *
7452 * @return Returns the same Intent object, for chaining multiple calls
7453 * into a single statement.
7454 *
7455 * @see #putExtras
7456 * @see #removeExtra
7457 * @see #getBooleanArrayExtra(String)
7458 */
7459 public Intent putExtra(String name, boolean[] value) {
7460 if (mExtras == null) {
7461 mExtras = new Bundle();
7462 }
7463 mExtras.putBooleanArray(name, value);
7464 return this;
7465 }
7466
7467 /**
7468 * Add extended data to the intent. The name must include a package
7469 * prefix, for example the app com.android.contacts would use names
7470 * like "com.android.contacts.ShowAll".
7471 *
7472 * @param name The name of the extra data, with package prefix.
7473 * @param value The byte array data value.
7474 *
7475 * @return Returns the same Intent object, for chaining multiple calls
7476 * into a single statement.
7477 *
7478 * @see #putExtras
7479 * @see #removeExtra
7480 * @see #getByteArrayExtra(String)
7481 */
7482 public Intent putExtra(String name, byte[] value) {
7483 if (mExtras == null) {
7484 mExtras = new Bundle();
7485 }
7486 mExtras.putByteArray(name, value);
7487 return this;
7488 }
7489
7490 /**
7491 * Add extended data to the intent. The name must include a package
7492 * prefix, for example the app com.android.contacts would use names
7493 * like "com.android.contacts.ShowAll".
7494 *
7495 * @param name The name of the extra data, with package prefix.
7496 * @param value The short array data value.
7497 *
7498 * @return Returns the same Intent object, for chaining multiple calls
7499 * into a single statement.
7500 *
7501 * @see #putExtras
7502 * @see #removeExtra
7503 * @see #getShortArrayExtra(String)
7504 */
7505 public Intent putExtra(String name, short[] value) {
7506 if (mExtras == null) {
7507 mExtras = new Bundle();
7508 }
7509 mExtras.putShortArray(name, value);
7510 return this;
7511 }
7512
7513 /**
7514 * Add extended data to the intent. The name must include a package
7515 * prefix, for example the app com.android.contacts would use names
7516 * like "com.android.contacts.ShowAll".
7517 *
7518 * @param name The name of the extra data, with package prefix.
7519 * @param value The char array data value.
7520 *
7521 * @return Returns the same Intent object, for chaining multiple calls
7522 * into a single statement.
7523 *
7524 * @see #putExtras
7525 * @see #removeExtra
7526 * @see #getCharArrayExtra(String)
7527 */
7528 public Intent putExtra(String name, char[] value) {
7529 if (mExtras == null) {
7530 mExtras = new Bundle();
7531 }
7532 mExtras.putCharArray(name, value);
7533 return this;
7534 }
7535
7536 /**
7537 * Add extended data to the intent. The name must include a package
7538 * prefix, for example the app com.android.contacts would use names
7539 * like "com.android.contacts.ShowAll".
7540 *
7541 * @param name The name of the extra data, with package prefix.
7542 * @param value The int array data value.
7543 *
7544 * @return Returns the same Intent object, for chaining multiple calls
7545 * into a single statement.
7546 *
7547 * @see #putExtras
7548 * @see #removeExtra
7549 * @see #getIntArrayExtra(String)
7550 */
7551 public Intent putExtra(String name, int[] value) {
7552 if (mExtras == null) {
7553 mExtras = new Bundle();
7554 }
7555 mExtras.putIntArray(name, value);
7556 return this;
7557 }
7558
7559 /**
7560 * Add extended data to the intent. The name must include a package
7561 * prefix, for example the app com.android.contacts would use names
7562 * like "com.android.contacts.ShowAll".
7563 *
7564 * @param name The name of the extra data, with package prefix.
7565 * @param value The byte array data value.
7566 *
7567 * @return Returns the same Intent object, for chaining multiple calls
7568 * into a single statement.
7569 *
7570 * @see #putExtras
7571 * @see #removeExtra
7572 * @see #getLongArrayExtra(String)
7573 */
7574 public Intent putExtra(String name, long[] value) {
7575 if (mExtras == null) {
7576 mExtras = new Bundle();
7577 }
7578 mExtras.putLongArray(name, value);
7579 return this;
7580 }
7581
7582 /**
7583 * Add extended data to the intent. The name must include a package
7584 * prefix, for example the app com.android.contacts would use names
7585 * like "com.android.contacts.ShowAll".
7586 *
7587 * @param name The name of the extra data, with package prefix.
7588 * @param value The float array data value.
7589 *
7590 * @return Returns the same Intent object, for chaining multiple calls
7591 * into a single statement.
7592 *
7593 * @see #putExtras
7594 * @see #removeExtra
7595 * @see #getFloatArrayExtra(String)
7596 */
7597 public Intent putExtra(String name, float[] value) {
7598 if (mExtras == null) {
7599 mExtras = new Bundle();
7600 }
7601 mExtras.putFloatArray(name, value);
7602 return this;
7603 }
7604
7605 /**
7606 * Add extended data to the intent. The name must include a package
7607 * prefix, for example the app com.android.contacts would use names
7608 * like "com.android.contacts.ShowAll".
7609 *
7610 * @param name The name of the extra data, with package prefix.
7611 * @param value The double array data value.
7612 *
7613 * @return Returns the same Intent object, for chaining multiple calls
7614 * into a single statement.
7615 *
7616 * @see #putExtras
7617 * @see #removeExtra
7618 * @see #getDoubleArrayExtra(String)
7619 */
7620 public Intent putExtra(String name, double[] value) {
7621 if (mExtras == null) {
7622 mExtras = new Bundle();
7623 }
7624 mExtras.putDoubleArray(name, value);
7625 return this;
7626 }
7627
7628 /**
7629 * Add extended data to the intent. The name must include a package
7630 * prefix, for example the app com.android.contacts would use names
7631 * like "com.android.contacts.ShowAll".
7632 *
7633 * @param name The name of the extra data, with package prefix.
7634 * @param value The String array data value.
7635 *
7636 * @return Returns the same Intent object, for chaining multiple calls
7637 * into a single statement.
7638 *
7639 * @see #putExtras
7640 * @see #removeExtra
7641 * @see #getStringArrayExtra(String)
7642 */
7643 public Intent putExtra(String name, String[] value) {
7644 if (mExtras == null) {
7645 mExtras = new Bundle();
7646 }
7647 mExtras.putStringArray(name, value);
7648 return this;
7649 }
7650
7651 /**
7652 * Add extended data to the intent. The name must include a package
7653 * prefix, for example the app com.android.contacts would use names
7654 * like "com.android.contacts.ShowAll".
7655 *
7656 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007657 * @param value The CharSequence array data value.
7658 *
7659 * @return Returns the same Intent object, for chaining multiple calls
7660 * into a single statement.
7661 *
7662 * @see #putExtras
7663 * @see #removeExtra
7664 * @see #getCharSequenceArrayExtra(String)
7665 */
7666 public Intent putExtra(String name, CharSequence[] value) {
7667 if (mExtras == null) {
7668 mExtras = new Bundle();
7669 }
7670 mExtras.putCharSequenceArray(name, value);
7671 return this;
7672 }
7673
7674 /**
7675 * Add extended data to the intent. The name must include a package
7676 * prefix, for example the app com.android.contacts would use names
7677 * like "com.android.contacts.ShowAll".
7678 *
7679 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007680 * @param value The Bundle data value.
7681 *
7682 * @return Returns the same Intent object, for chaining multiple calls
7683 * into a single statement.
7684 *
7685 * @see #putExtras
7686 * @see #removeExtra
7687 * @see #getBundleExtra(String)
7688 */
7689 public Intent putExtra(String name, Bundle value) {
7690 if (mExtras == null) {
7691 mExtras = new Bundle();
7692 }
7693 mExtras.putBundle(name, value);
7694 return this;
7695 }
7696
7697 /**
7698 * Add extended data to the intent. The name must include a package
7699 * prefix, for example the app com.android.contacts would use names
7700 * like "com.android.contacts.ShowAll".
7701 *
7702 * @param name The name of the extra data, with package prefix.
7703 * @param value The IBinder data value.
7704 *
7705 * @return Returns the same Intent object, for chaining multiple calls
7706 * into a single statement.
7707 *
7708 * @see #putExtras
7709 * @see #removeExtra
7710 * @see #getIBinderExtra(String)
7711 *
7712 * @deprecated
7713 * @hide
7714 */
7715 @Deprecated
7716 public Intent putExtra(String name, IBinder value) {
7717 if (mExtras == null) {
7718 mExtras = new Bundle();
7719 }
7720 mExtras.putIBinder(name, value);
7721 return this;
7722 }
7723
7724 /**
7725 * Copy all extras in 'src' in to this intent.
7726 *
7727 * @param src Contains the extras to copy.
7728 *
7729 * @see #putExtra
7730 */
7731 public Intent putExtras(Intent src) {
7732 if (src.mExtras != null) {
7733 if (mExtras == null) {
7734 mExtras = new Bundle(src.mExtras);
7735 } else {
7736 mExtras.putAll(src.mExtras);
7737 }
7738 }
7739 return this;
7740 }
7741
7742 /**
7743 * Add a set of extended data to the intent. The keys must include a package
7744 * prefix, for example the app com.android.contacts would use names
7745 * like "com.android.contacts.ShowAll".
7746 *
7747 * @param extras The Bundle of extras to add to this intent.
7748 *
7749 * @see #putExtra
7750 * @see #removeExtra
7751 */
7752 public Intent putExtras(Bundle extras) {
7753 if (mExtras == null) {
7754 mExtras = new Bundle();
7755 }
7756 mExtras.putAll(extras);
7757 return this;
7758 }
7759
7760 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007761 * Completely replace the extras in the Intent with the extras in the
7762 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007763 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007764 * @param src The exact extras contained in this Intent are copied
7765 * into the target intent, replacing any that were previously there.
7766 */
7767 public Intent replaceExtras(Intent src) {
7768 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7769 return this;
7770 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007771
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007772 /**
7773 * Completely replace the extras in the Intent with the given Bundle of
7774 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007775 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007776 * @param extras The new set of extras in the Intent, or null to erase
7777 * all extras.
7778 */
7779 public Intent replaceExtras(Bundle extras) {
7780 mExtras = extras != null ? new Bundle(extras) : null;
7781 return this;
7782 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007783
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007784 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007785 * Remove extended data from the intent.
7786 *
7787 * @see #putExtra
7788 */
7789 public void removeExtra(String name) {
7790 if (mExtras != null) {
7791 mExtras.remove(name);
7792 if (mExtras.size() == 0) {
7793 mExtras = null;
7794 }
7795 }
7796 }
7797
7798 /**
7799 * Set special flags controlling how this intent is handled. Most values
7800 * here depend on the type of component being executed by the Intent,
7801 * specifically the FLAG_ACTIVITY_* flags are all for use with
7802 * {@link Context#startActivity Context.startActivity()} and the
7803 * FLAG_RECEIVER_* flags are all for use with
7804 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7805 *
Scott Main7aee61f2011-02-08 11:25:01 -08007806 * <p>See the
7807 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7808 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007809 * the behavior of your application.
7810 *
7811 * @param flags The desired flags.
7812 *
7813 * @return Returns the same Intent object, for chaining multiple calls
7814 * into a single statement.
7815 *
7816 * @see #getFlags
7817 * @see #addFlags
7818 *
7819 * @see #FLAG_GRANT_READ_URI_PERMISSION
7820 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007821 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7822 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007823 * @see #FLAG_DEBUG_LOG_RESOLUTION
7824 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007825 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007826 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007827 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007828 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007829 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7830 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007831 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007832 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007833 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007834 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007835 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007836 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007837 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007838 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7839 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007840 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007841 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007842 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007843 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7844 */
7845 public Intent setFlags(int flags) {
7846 mFlags = flags;
7847 return this;
7848 }
7849
7850 /**
7851 * Add additional flags to the intent (or with existing flags
7852 * value).
7853 *
7854 * @param flags The new flags to set.
7855 *
7856 * @return Returns the same Intent object, for chaining multiple calls
7857 * into a single statement.
7858 *
7859 * @see #setFlags
7860 */
7861 public Intent addFlags(int flags) {
7862 mFlags |= flags;
7863 return this;
7864 }
7865
7866 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007867 * (Usually optional) Set an explicit application package name that limits
7868 * the components this Intent will resolve to. If left to the default
7869 * value of null, all components in all applications will considered.
7870 * If non-null, the Intent can only match the components in the given
7871 * application package.
7872 *
7873 * @param packageName The name of the application package to handle the
7874 * intent, or null to allow any application package.
7875 *
7876 * @return Returns the same Intent object, for chaining multiple calls
7877 * into a single statement.
7878 *
7879 * @see #getPackage
7880 * @see #resolveActivity
7881 */
7882 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007883 if (packageName != null && mSelector != null) {
7884 throw new IllegalArgumentException(
7885 "Can't set package name when selector is already set");
7886 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007887 mPackage = packageName;
7888 return this;
7889 }
7890
7891 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007892 * (Usually optional) Explicitly set the component to handle the intent.
7893 * If left with the default value of null, the system will determine the
7894 * appropriate class to use based on the other fields (action, data,
7895 * type, categories) in the Intent. If this class is defined, the
7896 * specified class will always be used regardless of the other fields. You
7897 * should only set this value when you know you absolutely want a specific
7898 * class to be used; otherwise it is better to let the system find the
7899 * appropriate class so that you will respect the installed applications
7900 * and user preferences.
7901 *
7902 * @param component The name of the application component to handle the
7903 * intent, or null to let the system find one for you.
7904 *
7905 * @return Returns the same Intent object, for chaining multiple calls
7906 * into a single statement.
7907 *
7908 * @see #setClass
7909 * @see #setClassName(Context, String)
7910 * @see #setClassName(String, String)
7911 * @see #getComponent
7912 * @see #resolveActivity
7913 */
7914 public Intent setComponent(ComponentName component) {
7915 mComponent = component;
7916 return this;
7917 }
7918
7919 /**
7920 * Convenience for calling {@link #setComponent} with an
7921 * explicit class name.
7922 *
7923 * @param packageContext A Context of the application package implementing
7924 * this class.
7925 * @param className The name of a class inside of the application package
7926 * that will be used as the component for this Intent.
7927 *
7928 * @return Returns the same Intent object, for chaining multiple calls
7929 * into a single statement.
7930 *
7931 * @see #setComponent
7932 * @see #setClass
7933 */
7934 public Intent setClassName(Context packageContext, String className) {
7935 mComponent = new ComponentName(packageContext, className);
7936 return this;
7937 }
7938
7939 /**
7940 * Convenience for calling {@link #setComponent} with an
7941 * explicit application package name and class name.
7942 *
7943 * @param packageName The name of the package implementing the desired
7944 * component.
7945 * @param className The name of a class inside of the application package
7946 * that will be used as the component for this Intent.
7947 *
7948 * @return Returns the same Intent object, for chaining multiple calls
7949 * into a single statement.
7950 *
7951 * @see #setComponent
7952 * @see #setClass
7953 */
7954 public Intent setClassName(String packageName, String className) {
7955 mComponent = new ComponentName(packageName, className);
7956 return this;
7957 }
7958
7959 /**
7960 * Convenience for calling {@link #setComponent(ComponentName)} with the
7961 * name returned by a {@link Class} object.
7962 *
7963 * @param packageContext A Context of the application package implementing
7964 * this class.
7965 * @param cls The class name to set, equivalent to
7966 * <code>setClassName(context, cls.getName())</code>.
7967 *
7968 * @return Returns the same Intent object, for chaining multiple calls
7969 * into a single statement.
7970 *
7971 * @see #setComponent
7972 */
7973 public Intent setClass(Context packageContext, Class<?> cls) {
7974 mComponent = new ComponentName(packageContext, cls);
7975 return this;
7976 }
7977
7978 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007979 * Set the bounds of the sender of this intent, in screen coordinates. This can be
7980 * used as a hint to the receiver for animations and the like. Null means that there
7981 * is no source bounds.
7982 */
7983 public void setSourceBounds(Rect r) {
7984 if (r != null) {
7985 mSourceBounds = new Rect(r);
7986 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07007987 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007988 }
7989 }
7990
Tor Norbyed9273d62013-05-30 15:59:53 -07007991 /** @hide */
7992 @IntDef(flag = true,
7993 value = {
7994 FILL_IN_ACTION,
7995 FILL_IN_DATA,
7996 FILL_IN_CATEGORIES,
7997 FILL_IN_COMPONENT,
7998 FILL_IN_PACKAGE,
7999 FILL_IN_SOURCE_BOUNDS,
8000 FILL_IN_SELECTOR,
8001 FILL_IN_CLIP_DATA
8002 })
8003 @Retention(RetentionPolicy.SOURCE)
8004 public @interface FillInFlags {}
8005
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008006 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008007 * Use with {@link #fillIn} to allow the current action value to be
8008 * overwritten, even if it is already set.
8009 */
8010 public static final int FILL_IN_ACTION = 1<<0;
8011
8012 /**
8013 * Use with {@link #fillIn} to allow the current data or type value
8014 * overwritten, even if it is already set.
8015 */
8016 public static final int FILL_IN_DATA = 1<<1;
8017
8018 /**
8019 * Use with {@link #fillIn} to allow the current categories to be
8020 * overwritten, even if they are already set.
8021 */
8022 public static final int FILL_IN_CATEGORIES = 1<<2;
8023
8024 /**
8025 * Use with {@link #fillIn} to allow the current component value to be
8026 * overwritten, even if it is already set.
8027 */
8028 public static final int FILL_IN_COMPONENT = 1<<3;
8029
8030 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008031 * Use with {@link #fillIn} to allow the current package value to be
8032 * overwritten, even if it is already set.
8033 */
8034 public static final int FILL_IN_PACKAGE = 1<<4;
8035
8036 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008037 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008038 * overwritten, even if it is already set.
8039 */
8040 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8041
8042 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008043 * Use with {@link #fillIn} to allow the current selector to be
8044 * overwritten, even if it is already set.
8045 */
8046 public static final int FILL_IN_SELECTOR = 1<<6;
8047
8048 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008049 * Use with {@link #fillIn} to allow the current ClipData to be
8050 * overwritten, even if it is already set.
8051 */
8052 public static final int FILL_IN_CLIP_DATA = 1<<7;
8053
8054 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008055 * Copy the contents of <var>other</var> in to this object, but only
8056 * where fields are not defined by this object. For purposes of a field
8057 * being defined, the following pieces of data in the Intent are
8058 * considered to be separate fields:
8059 *
8060 * <ul>
8061 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008062 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008063 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8064 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008065 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008066 * <li> component, as set by {@link #setComponent(ComponentName)} or
8067 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008068 * <li> source bounds, as set by {@link #setSourceBounds}.
8069 * <li> selector, as set by {@link #setSelector(Intent)}.
8070 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008071 * <li> each top-level name in the associated extras.
8072 * </ul>
8073 *
8074 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008075 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008076 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8077 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8078 * the restriction where the corresponding field will not be replaced if
8079 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008080 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008081 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8082 * is explicitly specified. The selector will only be copied if
8083 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008084 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008085 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8086 * and Intent B with {action="gotit", data-type="some/thing",
8087 * categories="one","two"}.
8088 *
8089 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8090 * containing: {action="gotit", data-type="some/thing",
8091 * categories="bar"}.
8092 *
8093 * @param other Another Intent whose values are to be used to fill in
8094 * the current one.
8095 * @param flags Options to control which fields can be filled in.
8096 *
8097 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008098 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008099 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8100 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8101 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008102 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008103 @FillInFlags
8104 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008105 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008106 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008107 if (other.mAction != null
8108 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008109 mAction = other.mAction;
8110 changes |= FILL_IN_ACTION;
8111 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008112 if ((other.mData != null || other.mType != null)
8113 && ((mData == null && mType == null)
8114 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008115 mData = other.mData;
8116 mType = other.mType;
8117 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008118 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008119 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008120 if (other.mCategories != null
8121 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008122 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008123 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008124 }
8125 changes |= FILL_IN_CATEGORIES;
8126 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008127 if (other.mPackage != null
8128 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008129 // Only do this if mSelector is not set.
8130 if (mSelector == null) {
8131 mPackage = other.mPackage;
8132 changes |= FILL_IN_PACKAGE;
8133 }
8134 }
8135 // Selector is special: it can only be set if explicitly allowed,
8136 // for the same reason as the component name.
8137 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8138 if (mPackage == null) {
8139 mSelector = new Intent(other.mSelector);
8140 mPackage = null;
8141 changes |= FILL_IN_SELECTOR;
8142 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008143 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008144 if (other.mClipData != null
8145 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8146 mClipData = other.mClipData;
8147 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008148 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008149 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008150 // Component is special: it can -only- be set if explicitly allowed,
8151 // since otherwise the sender could force the intent somewhere the
8152 // originator didn't intend.
8153 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008154 mComponent = other.mComponent;
8155 changes |= FILL_IN_COMPONENT;
8156 }
8157 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008158 if (other.mSourceBounds != null
8159 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8160 mSourceBounds = new Rect(other.mSourceBounds);
8161 changes |= FILL_IN_SOURCE_BOUNDS;
8162 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008163 if (mExtras == null) {
8164 if (other.mExtras != null) {
8165 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008166 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008167 }
8168 } else if (other.mExtras != null) {
8169 try {
8170 Bundle newb = new Bundle(other.mExtras);
8171 newb.putAll(mExtras);
8172 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008173 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008174 } catch (RuntimeException e) {
8175 // Modifying the extras can cause us to unparcel the contents
8176 // of the bundle, and if we do this in the system process that
8177 // may fail. We really should handle this (i.e., the Bundle
8178 // impl shouldn't be on top of a plain map), but for now just
8179 // ignore it and keep the original contents. :(
8180 Log.w("Intent", "Failure filling in extras", e);
8181 }
8182 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008183 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8184 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8185 mContentUserHint = other.mContentUserHint;
8186 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008187 return changes;
8188 }
8189
8190 /**
8191 * Wrapper class holding an Intent and implementing comparisons on it for
8192 * the purpose of filtering. The class implements its
8193 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8194 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8195 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8196 * on the wrapped Intent.
8197 */
8198 public static final class FilterComparison {
8199 private final Intent mIntent;
8200 private final int mHashCode;
8201
8202 public FilterComparison(Intent intent) {
8203 mIntent = intent;
8204 mHashCode = intent.filterHashCode();
8205 }
8206
8207 /**
8208 * Return the Intent that this FilterComparison represents.
8209 * @return Returns the Intent held by the FilterComparison. Do
8210 * not modify!
8211 */
8212 public Intent getIntent() {
8213 return mIntent;
8214 }
8215
8216 @Override
8217 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008218 if (obj instanceof FilterComparison) {
8219 Intent other = ((FilterComparison)obj).mIntent;
8220 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008221 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008222 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008223 }
8224
8225 @Override
8226 public int hashCode() {
8227 return mHashCode;
8228 }
8229 }
8230
8231 /**
8232 * Determine if two intents are the same for the purposes of intent
8233 * resolution (filtering). That is, if their action, data, type,
8234 * class, and categories are the same. This does <em>not</em> compare
8235 * any extra data included in the intents.
8236 *
8237 * @param other The other Intent to compare against.
8238 *
8239 * @return Returns true if action, data, type, class, and categories
8240 * are the same.
8241 */
8242 public boolean filterEquals(Intent other) {
8243 if (other == null) {
8244 return false;
8245 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008246 if (!Objects.equals(this.mAction, other.mAction)) return false;
8247 if (!Objects.equals(this.mData, other.mData)) return false;
8248 if (!Objects.equals(this.mType, other.mType)) return false;
8249 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8250 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8251 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008252
8253 return true;
8254 }
8255
8256 /**
8257 * Generate hash code that matches semantics of filterEquals().
8258 *
8259 * @return Returns the hash value of the action, data, type, class, and
8260 * categories.
8261 *
8262 * @see #filterEquals
8263 */
8264 public int filterHashCode() {
8265 int code = 0;
8266 if (mAction != null) {
8267 code += mAction.hashCode();
8268 }
8269 if (mData != null) {
8270 code += mData.hashCode();
8271 }
8272 if (mType != null) {
8273 code += mType.hashCode();
8274 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008275 if (mPackage != null) {
8276 code += mPackage.hashCode();
8277 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008278 if (mComponent != null) {
8279 code += mComponent.hashCode();
8280 }
8281 if (mCategories != null) {
8282 code += mCategories.hashCode();
8283 }
8284 return code;
8285 }
8286
8287 @Override
8288 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008289 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008290
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008291 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008292 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008293 b.append(" }");
8294
8295 return b.toString();
8296 }
8297
8298 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008299 public String toInsecureString() {
8300 StringBuilder b = new StringBuilder(128);
8301
8302 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008303 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008304 b.append(" }");
8305
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008306 return b.toString();
8307 }
Romain Guy4969af72009-06-17 10:53:19 -07008308
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008309 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008310 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008311 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008312
8313 b.append("Intent { ");
8314 toShortString(b, false, true, true, true);
8315 b.append(" }");
8316
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008317 return b.toString();
8318 }
8319
8320 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008321 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8322 StringBuilder b = new StringBuilder(128);
8323 toShortString(b, secure, comp, extras, clip);
8324 return b.toString();
8325 }
8326
8327 /** @hide */
8328 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8329 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008330 boolean first = true;
8331 if (mAction != null) {
8332 b.append("act=").append(mAction);
8333 first = false;
8334 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008335 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008336 if (!first) {
8337 b.append(' ');
8338 }
8339 first = false;
8340 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008341 for (int i=0; i<mCategories.size(); i++) {
8342 if (i > 0) b.append(',');
8343 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008344 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008345 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008346 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008347 if (mData != null) {
8348 if (!first) {
8349 b.append(' ');
8350 }
8351 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008352 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008353 if (secure) {
8354 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008355 } else {
8356 b.append(mData);
8357 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008358 }
8359 if (mType != null) {
8360 if (!first) {
8361 b.append(' ');
8362 }
8363 first = false;
8364 b.append("typ=").append(mType);
8365 }
8366 if (mFlags != 0) {
8367 if (!first) {
8368 b.append(' ');
8369 }
8370 first = false;
8371 b.append("flg=0x").append(Integer.toHexString(mFlags));
8372 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008373 if (mPackage != null) {
8374 if (!first) {
8375 b.append(' ');
8376 }
8377 first = false;
8378 b.append("pkg=").append(mPackage);
8379 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008380 if (comp && mComponent != null) {
8381 if (!first) {
8382 b.append(' ');
8383 }
8384 first = false;
8385 b.append("cmp=").append(mComponent.flattenToShortString());
8386 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008387 if (mSourceBounds != null) {
8388 if (!first) {
8389 b.append(' ');
8390 }
8391 first = false;
8392 b.append("bnds=").append(mSourceBounds.toShortString());
8393 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008394 if (mClipData != null) {
8395 if (!first) {
8396 b.append(' ');
8397 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008398 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008399 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008400 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008401 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008402 if (mClipData.getDescription() != null) {
8403 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8404 } else {
8405 first = true;
8406 }
8407 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008408 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008409 first = false;
8410 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008411 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008412 if (extras && mExtras != null) {
8413 if (!first) {
8414 b.append(' ');
8415 }
8416 first = false;
8417 b.append("(has extras)");
8418 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008419 if (mContentUserHint != UserHandle.USER_CURRENT) {
8420 if (!first) {
8421 b.append(' ');
8422 }
8423 first = false;
8424 b.append("u=").append(mContentUserHint);
8425 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008426 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008427 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008428 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008429 b.append("}");
8430 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008431 }
8432
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008433 /**
8434 * Call {@link #toUri} with 0 flags.
8435 * @deprecated Use {@link #toUri} instead.
8436 */
8437 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008438 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008439 return toUri(0);
8440 }
8441
8442 /**
8443 * Convert this Intent into a String holding a URI representation of it.
8444 * The returned URI string has been properly URI encoded, so it can be
8445 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8446 * Intent's data as the base URI, with an additional fragment describing
8447 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008448 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008449 * <p>You can convert the returned string back to an Intent with
8450 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008451 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008452 * @param flags Additional operating flags. Either 0,
8453 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008454 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008455 * @return Returns a URI encoding URI string describing the entire contents
8456 * of the Intent.
8457 */
8458 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008459 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008460 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8461 if (mPackage == null) {
8462 throw new IllegalArgumentException(
8463 "Intent must include an explicit package name to build an android-app: "
8464 + this);
8465 }
8466 uri.append("android-app://");
8467 uri.append(mPackage);
8468 String scheme = null;
8469 if (mData != null) {
8470 scheme = mData.getScheme();
8471 if (scheme != null) {
8472 uri.append('/');
8473 uri.append(scheme);
8474 String authority = mData.getEncodedAuthority();
8475 if (authority != null) {
8476 uri.append('/');
8477 uri.append(authority);
8478 String path = mData.getEncodedPath();
8479 if (path != null) {
8480 uri.append(path);
8481 }
8482 String queryParams = mData.getEncodedQuery();
8483 if (queryParams != null) {
8484 uri.append('?');
8485 uri.append(queryParams);
8486 }
8487 String fragment = mData.getEncodedFragment();
8488 if (fragment != null) {
8489 uri.append('#');
8490 uri.append(fragment);
8491 }
8492 }
8493 }
8494 }
8495 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8496 mPackage, flags);
8497 return uri.toString();
8498 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008499 String scheme = null;
8500 if (mData != null) {
8501 String data = mData.toString();
8502 if ((flags&URI_INTENT_SCHEME) != 0) {
8503 final int N = data.length();
8504 for (int i=0; i<N; i++) {
8505 char c = data.charAt(i);
8506 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8507 || c == '.' || c == '-') {
8508 continue;
8509 }
8510 if (c == ':' && i > 0) {
8511 // Valid scheme.
8512 scheme = data.substring(0, i);
8513 uri.append("intent:");
8514 data = data.substring(i+1);
8515 break;
8516 }
Tom Taylord4a47292009-12-21 13:59:18 -08008517
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008518 // No scheme.
8519 break;
8520 }
8521 }
8522 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008523
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008524 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8525 uri.append("intent:");
8526 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008527
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008528 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008529
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008530 return uri.toString();
8531 }
8532
8533 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8534 String defPackage, int flags) {
8535 StringBuilder frag = new StringBuilder(128);
8536
8537 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008538 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008539 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008540 // Note that for now we are not going to try to handle the
8541 // data part; not clear how to represent this as a URI, and
8542 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008543 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8544 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008545 }
8546
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008547 if (frag.length() > 0) {
8548 uri.append("#Intent;");
8549 uri.append(frag);
8550 uri.append("end");
8551 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008552 }
8553
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008554 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8555 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008556 if (scheme != null) {
8557 uri.append("scheme=").append(scheme).append(';');
8558 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008559 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008560 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008561 }
8562 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008563 for (int i=0; i<mCategories.size(); i++) {
8564 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008565 }
8566 }
8567 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008568 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008569 }
8570 if (mFlags != 0) {
8571 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8572 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008573 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008574 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8575 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008576 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008577 uri.append("component=").append(Uri.encode(
8578 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008579 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008580 if (mSourceBounds != null) {
8581 uri.append("sourceBounds=")
8582 .append(Uri.encode(mSourceBounds.flattenToString()))
8583 .append(';');
8584 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 if (mExtras != null) {
8586 for (String key : mExtras.keySet()) {
8587 final Object value = mExtras.get(key);
8588 char entryType =
8589 value instanceof String ? 'S' :
8590 value instanceof Boolean ? 'B' :
8591 value instanceof Byte ? 'b' :
8592 value instanceof Character ? 'c' :
8593 value instanceof Double ? 'd' :
8594 value instanceof Float ? 'f' :
8595 value instanceof Integer ? 'i' :
8596 value instanceof Long ? 'l' :
8597 value instanceof Short ? 's' :
8598 '\0';
8599
8600 if (entryType != '\0') {
8601 uri.append(entryType);
8602 uri.append('.');
8603 uri.append(Uri.encode(key));
8604 uri.append('=');
8605 uri.append(Uri.encode(value.toString()));
8606 uri.append(';');
8607 }
8608 }
8609 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008610 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008611
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008612 public int describeContents() {
8613 return (mExtras != null) ? mExtras.describeContents() : 0;
8614 }
8615
8616 public void writeToParcel(Parcel out, int flags) {
8617 out.writeString(mAction);
8618 Uri.writeToParcel(out, mData);
8619 out.writeString(mType);
8620 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008621 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008622 ComponentName.writeToParcel(mComponent, out);
8623
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008624 if (mSourceBounds != null) {
8625 out.writeInt(1);
8626 mSourceBounds.writeToParcel(out, flags);
8627 } else {
8628 out.writeInt(0);
8629 }
8630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008631 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008632 final int N = mCategories.size();
8633 out.writeInt(N);
8634 for (int i=0; i<N; i++) {
8635 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008636 }
8637 } else {
8638 out.writeInt(0);
8639 }
8640
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008641 if (mSelector != null) {
8642 out.writeInt(1);
8643 mSelector.writeToParcel(out, flags);
8644 } else {
8645 out.writeInt(0);
8646 }
8647
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008648 if (mClipData != null) {
8649 out.writeInt(1);
8650 mClipData.writeToParcel(out, flags);
8651 } else {
8652 out.writeInt(0);
8653 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008654 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008655 out.writeBundle(mExtras);
8656 }
8657
8658 public static final Parcelable.Creator<Intent> CREATOR
8659 = new Parcelable.Creator<Intent>() {
8660 public Intent createFromParcel(Parcel in) {
8661 return new Intent(in);
8662 }
8663 public Intent[] newArray(int size) {
8664 return new Intent[size];
8665 }
8666 };
8667
Dianne Hackborneb034652009-09-07 00:49:58 -07008668 /** @hide */
8669 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008670 readFromParcel(in);
8671 }
8672
8673 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008674 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008675 mData = Uri.CREATOR.createFromParcel(in);
8676 mType = in.readString();
8677 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008678 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 mComponent = ComponentName.readFromParcel(in);
8680
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008681 if (in.readInt() != 0) {
8682 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8683 }
8684
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008685 int N = in.readInt();
8686 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008687 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008688 int i;
8689 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008690 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008691 }
8692 } else {
8693 mCategories = null;
8694 }
8695
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008696 if (in.readInt() != 0) {
8697 mSelector = new Intent(in);
8698 }
8699
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008700 if (in.readInt() != 0) {
8701 mClipData = new ClipData(in);
8702 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008703 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008704 mExtras = in.readBundle();
8705 }
8706
8707 /**
8708 * Parses the "intent" element (and its children) from XML and instantiates
8709 * an Intent object. The given XML parser should be located at the tag
8710 * where parsing should start (often named "intent"), from which the
8711 * basic action, data, type, and package and class name will be
8712 * retrieved. The function will then parse in to any child elements,
8713 * looking for <category android:name="xxx"> tags to add categories and
8714 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8715 * to the intent.
8716 *
8717 * @param resources The Resources to use when inflating resources.
8718 * @param parser The XML parser pointing at an "intent" tag.
8719 * @param attrs The AttributeSet interface for retrieving extended
8720 * attribute data at the current <var>parser</var> location.
8721 * @return An Intent object matching the XML data.
8722 * @throws XmlPullParserException If there was an XML parsing error.
8723 * @throws IOException If there was an I/O error.
8724 */
8725 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8726 throws XmlPullParserException, IOException {
8727 Intent intent = new Intent();
8728
8729 TypedArray sa = resources.obtainAttributes(attrs,
8730 com.android.internal.R.styleable.Intent);
8731
8732 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8733
8734 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8735 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8736 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8737
8738 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8739 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8740 if (packageName != null && className != null) {
8741 intent.setComponent(new ComponentName(packageName, className));
8742 }
8743
8744 sa.recycle();
8745
8746 int outerDepth = parser.getDepth();
8747 int type;
8748 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8749 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8750 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8751 continue;
8752 }
8753
8754 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008755 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008756 sa = resources.obtainAttributes(attrs,
8757 com.android.internal.R.styleable.IntentCategory);
8758 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8759 sa.recycle();
8760
8761 if (cat != null) {
8762 intent.addCategory(cat);
8763 }
8764 XmlUtils.skipCurrentTag(parser);
8765
Craig Mautner21d24a22014-04-23 11:45:37 -07008766 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008767 if (intent.mExtras == null) {
8768 intent.mExtras = new Bundle();
8769 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008770 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008771 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008772
8773 } else {
8774 XmlUtils.skipCurrentTag(parser);
8775 }
8776 }
8777
8778 return intent;
8779 }
Nick Pellyccae4122012-01-09 14:12:58 -08008780
Craig Mautner21d24a22014-04-23 11:45:37 -07008781 /** @hide */
8782 public void saveToXml(XmlSerializer out) throws IOException {
8783 if (mAction != null) {
8784 out.attribute(null, ATTR_ACTION, mAction);
8785 }
8786 if (mData != null) {
8787 out.attribute(null, ATTR_DATA, mData.toString());
8788 }
8789 if (mType != null) {
8790 out.attribute(null, ATTR_TYPE, mType);
8791 }
8792 if (mComponent != null) {
8793 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8794 }
8795 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8796
8797 if (mCategories != null) {
8798 out.startTag(null, TAG_CATEGORIES);
8799 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8800 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8801 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008802 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008803 }
8804 }
8805
8806 /** @hide */
8807 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8808 XmlPullParserException {
8809 Intent intent = new Intent();
8810 final int outerDepth = in.getDepth();
8811
8812 int attrCount = in.getAttributeCount();
8813 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8814 final String attrName = in.getAttributeName(attrNdx);
8815 final String attrValue = in.getAttributeValue(attrNdx);
8816 if (ATTR_ACTION.equals(attrName)) {
8817 intent.setAction(attrValue);
8818 } else if (ATTR_DATA.equals(attrName)) {
8819 intent.setData(Uri.parse(attrValue));
8820 } else if (ATTR_TYPE.equals(attrName)) {
8821 intent.setType(attrValue);
8822 } else if (ATTR_COMPONENT.equals(attrName)) {
8823 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8824 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008825 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008826 } else {
8827 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8828 }
8829 }
8830
8831 int event;
8832 String name;
8833 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8834 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8835 if (event == XmlPullParser.START_TAG) {
8836 name = in.getName();
8837 if (TAG_CATEGORIES.equals(name)) {
8838 attrCount = in.getAttributeCount();
8839 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8840 intent.addCategory(in.getAttributeValue(attrNdx));
8841 }
8842 } else {
8843 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8844 XmlUtils.skipCurrentTag(in);
8845 }
8846 }
8847 }
8848
8849 return intent;
8850 }
8851
Nick Pellyccae4122012-01-09 14:12:58 -08008852 /**
8853 * Normalize a MIME data type.
8854 *
8855 * <p>A normalized MIME type has white-space trimmed,
8856 * content-type parameters removed, and is lower-case.
8857 * This aligns the type with Android best practices for
8858 * intent filtering.
8859 *
8860 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8861 * "text/x-vCard" becomes "text/x-vcard".
8862 *
8863 * <p>All MIME types received from outside Android (such as user input,
8864 * or external sources like Bluetooth, NFC, or the Internet) should
8865 * be normalized before they are used to create an Intent.
8866 *
8867 * @param type MIME data type to normalize
8868 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008869 * @see #setType
8870 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008871 */
8872 public static String normalizeMimeType(String type) {
8873 if (type == null) {
8874 return null;
8875 }
8876
Elliott Hughescb64d432013-08-02 10:00:44 -07008877 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008878
8879 final int semicolonIndex = type.indexOf(';');
8880 if (semicolonIndex != -1) {
8881 type = type.substring(0, semicolonIndex);
8882 }
8883 return type;
8884 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008885
8886 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008887 * Prepare this {@link Intent} to leave an app process.
8888 *
8889 * @hide
8890 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008891 public void prepareToLeaveProcess(Context context) {
8892 final boolean leavingPackage = (mComponent == null)
8893 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8894 prepareToLeaveProcess(leavingPackage);
8895 }
8896
8897 /**
8898 * Prepare this {@link Intent} to leave an app process.
8899 *
8900 * @hide
8901 */
8902 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008903 setAllowFds(false);
8904
8905 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008906 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008907 }
8908 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008909 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008910 }
8911
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008912 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8913 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008914 switch (mAction) {
8915 case ACTION_MEDIA_REMOVED:
8916 case ACTION_MEDIA_UNMOUNTED:
8917 case ACTION_MEDIA_CHECKING:
8918 case ACTION_MEDIA_NOFS:
8919 case ACTION_MEDIA_MOUNTED:
8920 case ACTION_MEDIA_SHARED:
8921 case ACTION_MEDIA_UNSHARED:
8922 case ACTION_MEDIA_BAD_REMOVAL:
8923 case ACTION_MEDIA_UNMOUNTABLE:
8924 case ACTION_MEDIA_EJECT:
8925 case ACTION_MEDIA_SCANNER_STARTED:
8926 case ACTION_MEDIA_SCANNER_FINISHED:
8927 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008928 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8929 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008930 // Ignore legacy actions
8931 break;
8932 default:
8933 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008934 }
8935 }
8936 }
8937
8938 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008939 * @hide
8940 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008941 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008942 // We just entered destination process, so we should be able to read all
8943 // parcelables inside.
8944 setDefusable(true);
8945
8946 if (mSelector != null) {
8947 mSelector.prepareToEnterProcess();
8948 }
8949 if (mClipData != null) {
8950 mClipData.prepareToEnterProcess();
8951 }
8952
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008953 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008954 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8955 fixUris(mContentUserHint);
8956 mContentUserHint = UserHandle.USER_CURRENT;
8957 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008958 }
8959 }
8960
8961 /**
8962 * @hide
8963 */
8964 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008965 Uri data = getData();
8966 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008967 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008968 }
8969 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008970 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008971 }
8972 String action = getAction();
8973 if (ACTION_SEND.equals(action)) {
8974 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8975 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008976 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008977 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008978 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008979 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8980 if (streams != null) {
8981 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8982 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008983 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008984 }
8985 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8986 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008987 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8988 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8989 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
8990 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
8991 if (output != null) {
8992 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
8993 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008994 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008995 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008996
8997 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008998 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07008999 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9000 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009001 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009002 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009003 * @hide
9004 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009005 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009006 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009007 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009008
9009 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009010 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009011
9012 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009013 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009014 // Inspect contained intents to see if we need to migrate extras. We
9015 // don't promote ClipData to the parent, since ChooserActivity will
9016 // already start the picked item as the caller, and we can't combine
9017 // the flags in a safe way.
9018
9019 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009020 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009021 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9022 if (intent != null) {
9023 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009024 }
9025 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009026 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009027 try {
9028 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9029 if (intents != null) {
9030 for (int i = 0; i < intents.length; i++) {
9031 final Intent intent = (Intent) intents[i];
9032 if (intent != null) {
9033 migrated |= intent.migrateExtraStreamToClipData();
9034 }
9035 }
9036 }
9037 } catch (ClassCastException e) {
9038 }
9039 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009040
9041 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009042 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009043 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9044 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9045 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9046 if (stream != null || text != null || htmlText != null) {
9047 final ClipData clipData = new ClipData(
9048 null, new String[] { getType() },
9049 new ClipData.Item(text, htmlText, null, stream));
9050 setClipData(clipData);
9051 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009052 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009053 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009054 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009055 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009056
9057 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009058 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009059 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9060 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9061 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9062 int num = -1;
9063 if (streams != null) {
9064 num = streams.size();
9065 }
9066 if (texts != null) {
9067 if (num >= 0 && num != texts.size()) {
9068 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009069 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009070 }
9071 num = texts.size();
9072 }
9073 if (htmlTexts != null) {
9074 if (num >= 0 && num != htmlTexts.size()) {
9075 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009076 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009077 }
9078 num = htmlTexts.size();
9079 }
9080 if (num > 0) {
9081 final ClipData clipData = new ClipData(
9082 null, new String[] { getType() },
9083 makeClipItem(streams, texts, htmlTexts, 0));
9084
9085 for (int i = 1; i < num; i++) {
9086 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9087 }
9088
9089 setClipData(clipData);
9090 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009091 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009092 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009093 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009094 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009095 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9096 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9097 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9098 final Uri output;
9099 try {
9100 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9101 } catch (ClassCastException e) {
9102 return false;
9103 }
9104 if (output != null) {
9105 setClipData(ClipData.newRawUri("", output));
9106 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9107 return true;
9108 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009109 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009110
9111 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009112 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009113
9114 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9115 ArrayList<String> htmlTexts, int which) {
9116 Uri uri = streams != null ? streams.get(which) : null;
9117 CharSequence text = texts != null ? texts.get(which) : null;
9118 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9119 return new ClipData.Item(text, htmlText, null, uri);
9120 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009121
9122 /** @hide */
9123 public boolean isDocument() {
9124 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9125 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009126}