blob: 4243246c2f2ec6279828b02b418d4a956c5e7c23 [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
118 * VIEW action does what what is considered the most reasonable thing for
119 * a particular URI.</p>
120 * </li>
121 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
122 * the phone dialer with the given number filled in.</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * information about the person whose identifier is "1".</p>
126 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700127 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700128 * a list of people, which the user can browse through. This example is a
129 * typical top-level entry into the Contacts application, showing you the
130 * list of people. Selecting a particular person to view would result in a
131 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
132 * being used to start an activity to display that person.</p>
133 * </li>
134 * </ul>
135 *
136 * <p>In addition to these primary attributes, there are a number of secondary
137 * attributes that you can also include with an intent:</p>
138 *
139 * <ul>
140 * <li> <p><b>category</b> -- Gives additional information about the action
141 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
142 * appear in the Launcher as a top-level application, while
143 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
144 * of alternative actions the user can perform on a piece of data.</p>
145 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
146 * intent data. Normally the type is inferred from the data itself.
147 * By setting this attribute, you disable that evaluation and force
148 * an explicit type.</p>
149 * <li> <p><b>component</b> -- Specifies an explicit name of a component
150 * class to use for the intent. Normally this is determined by looking
151 * at the other information in the intent (the action, data/type, and
152 * categories) and matching that with a component that can handle it.
153 * If this attribute is set then none of the evaluation is performed,
154 * and this component is used exactly as is. By specifying this attribute,
155 * all of the other Intent attributes become optional.</p>
156 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
157 * This can be used to provide extended information to the component.
158 * For example, if we have a action to send an e-mail message, we could
159 * also include extra pieces of data here to supply a subject, body,
160 * etc.</p>
161 * </ul>
162 *
163 * <p>Here are some examples of other operations you can specify as intents
164 * using these additional parameters:</p>
165 *
166 * <ul>
167 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
168 * Launch the home screen.</p>
169 * </li>
170 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
171 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
172 * vnd.android.cursor.item/phone}</i></b>
173 * -- Display the list of people's phone numbers, allowing the user to
174 * browse through them and pick one and return it to the parent activity.</p>
175 * </li>
176 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
177 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
178 * -- Display all pickers for data that can be opened with
179 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
180 * allowing the user to pick one of them and then some data inside of it
181 * and returning the resulting URI to the caller. This can be used,
182 * for example, in an e-mail application to allow the user to pick some
183 * data to include as an attachment.</p>
184 * </li>
185 * </ul>
186 *
187 * <p>There are a variety of standard Intent action and category constants
188 * defined in the Intent class, but applications can also define their own.
189 * These strings use java style scoping, to ensure they are unique -- for
190 * 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;
342 * &lt;data mimeType:name="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>
361 * <p>This filter describes the ability return to the caller a note selected by
362 * 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 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001327 * Activity Action: List all available applications
1328 * <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 /**
1334 * Activity Action: Show settings for choosing wallpaper
1335 * <p>Input: Nothing.
1336 * <p>Output: Nothing.
1337 */
1338 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1339 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1340
1341 /**
1342 * Activity Action: Show activity for reporting a bug.
1343 * <p>Input: Nothing.
1344 * <p>Output: Nothing.
1345 */
1346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1347 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1348
1349 /**
1350 * Activity Action: Main entry point for factory tests. Only used when
1351 * the device is booting in factory test node. The implementing package
1352 * must be installed in the system image.
1353 * <p>Input: nothing
1354 * <p>Output: nothing
1355 */
1356 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1357
1358 /**
1359 * Activity Action: The user pressed the "call" button to go to the dialer
1360 * or other appropriate UI for placing a call.
1361 * <p>Input: Nothing.
1362 * <p>Output: Nothing.
1363 */
1364 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1365 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1366
1367 /**
1368 * Activity Action: Start Voice Command.
1369 * <p>Input: Nothing.
1370 * <p>Output: Nothing.
1371 */
1372 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1373 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001374
1375 /**
1376 * Activity Action: Start action associated with long pressing on the
1377 * search key.
1378 * <p>Input: Nothing.
1379 * <p>Output: Nothing.
1380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001383
Jacek Surazski86b6c532009-05-13 14:38:28 +02001384 /**
1385 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1386 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001387 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001388 * <p>Input: No data is specified. The bug report is passed in using
1389 * an {@link #EXTRA_BUG_REPORT} field.
1390 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001391 *
1392 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001396
1397 /**
1398 * Activity Action: Show power usage information to the user.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 */
1402 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1403 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001404
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001405 /**
1406 * Activity Action: Setup wizard to launch after a platform update. This
1407 * activity should have a string meta-data field associated with it,
1408 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1409 * the platform for setup. The activity will be launched only if
1410 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1411 * same value.
1412 * <p>Input: Nothing.
1413 * <p>Output: Nothing.
1414 * @hide
1415 */
1416 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1417 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001418
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001419 /**
Clara Bayarrieb3c2d32016-04-01 14:37:32 +01001420 * Activity Action: Start the Keyboard Shortcuts Helper screen.
1421 * <p>Input: Nothing.
1422 * <p>Output: Nothing.
1423 * @hide
1424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_SHOW_KEYBOARD_SHORTCUTS =
1427 "android.intent.action.SHOW_KEYBOARD_SHORTCUTS";
1428
1429 /**
Andrei Stingaceanu0bf096f2016-04-14 18:11:57 +01001430 * Activity Action: Dismiss the Keyboard Shortcuts Helper screen.
1431 * <p>Input: Nothing.
1432 * <p>Output: Nothing.
1433 * @hide
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_DISMISS_KEYBOARD_SHORTCUTS =
1437 "android.intent.action.DISMISS_KEYBOARD_SHORTCUTS";
1438
1439 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001440 * Activity Action: Show settings for managing network data usage of a
1441 * specific application. Applications should define an activity that offers
1442 * options to control data usage.
1443 */
1444 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1445 public static final String ACTION_MANAGE_NETWORK_USAGE =
1446 "android.intent.action.MANAGE_NETWORK_USAGE";
1447
1448 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001449 * Activity Action: Launch application installer.
1450 * <p>
1451 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001452 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1453 * you can also use "package:<package-name>" to install an application for the
1454 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001455 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1456 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1457 * <p>
1458 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1459 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001460 * <p>
1461 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1462 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1463 * in order to launch the application installer.
1464 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 *
1466 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1467 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1468 * @see #EXTRA_RETURN_RESULT
1469 */
1470 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1471 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1472
1473 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001474 * Activity Action: Launch ephemeral installer.
1475 * <p>
1476 * Input: The data must be a http: URI that the ephemeral application is registered
1477 * to handle.
1478 * <p class="note">
1479 * This is a protected intent that can only be sent by the system.
1480 * </p>
1481 *
1482 * @hide
1483 */
1484 @SystemApi
1485 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1486 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1487 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1488
1489 /**
1490 * Service Action: Resolve ephemeral application.
1491 * <p>
1492 * The system will have a persistent connection to this service.
1493 * This is a protected intent that can only be sent by the system.
1494 * </p>
1495 *
1496 * @hide
1497 */
1498 @SystemApi
1499 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1500 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1501 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1502
1503 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001504 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1505 * package. Specifies the installer package name; this package will receive the
1506 * {@link #ACTION_APP_ERROR} intent.
1507 */
1508 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1509 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1510
1511 /**
1512 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1513 * package. Specifies that the application being installed should not be
1514 * treated as coming from an unknown source, but as coming from the app
1515 * invoking the Intent. For this to work you must start the installer with
1516 * startActivityForResult().
1517 */
1518 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1519 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1520
1521 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001522 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1523 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001524 * data field originated from.
1525 */
rich cannings706e8ba2012-08-20 13:20:14 -07001526 public static final String EXTRA_ORIGINATING_URI
1527 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001528
1529 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001530 * This extra can be used with any Intent used to launch an activity, supplying information
1531 * about who is launching that activity. This field contains a {@link android.net.Uri}
1532 * object, typically an http: or https: URI of the web site that the referral came from;
1533 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1534 * a native application that it came from.
1535 *
1536 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1537 * instead of directly retrieving the extra. It is also valid for applications to
1538 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1539 * a string, not a Uri; the field here, if supplied, will always take precedence,
1540 * however.</p>
1541 *
1542 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001543 */
1544 public static final String EXTRA_REFERRER
1545 = "android.intent.extra.REFERRER";
1546
1547 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001548 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1549 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1550 * not be created, in particular when Intent extras are supplied through the
1551 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1552 * schemes.
1553 *
1554 * @see #EXTRA_REFERRER
1555 */
1556 public static final String EXTRA_REFERRER_NAME
1557 = "android.intent.extra.REFERRER_NAME";
1558
1559 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001560 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1561 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1562 * @hide
1563 */
1564 public static final String EXTRA_ORIGINATING_UID
1565 = "android.intent.extra.ORIGINATING_UID";
1566
1567 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001568 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1569 * package. Tells the installer UI to skip the confirmation with the user
1570 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001571 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1572 * will no longer show an interstitial message about updating existing
1573 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001574 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001575 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001576 public static final String EXTRA_ALLOW_REPLACE
1577 = "android.intent.extra.ALLOW_REPLACE";
1578
1579 /**
1580 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1581 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1582 * return to the application the result code of the install/uninstall. The returned result
1583 * code will be {@link android.app.Activity#RESULT_OK} on success or
1584 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1585 */
1586 public static final String EXTRA_RETURN_RESULT
1587 = "android.intent.extra.RETURN_RESULT";
1588
1589 /**
1590 * Package manager install result code. @hide because result codes are not
1591 * yet ready to be exposed.
1592 */
1593 public static final String EXTRA_INSTALL_RESULT
1594 = "android.intent.extra.INSTALL_RESULT";
1595
1596 /**
1597 * Activity Action: Launch application uninstaller.
1598 * <p>
1599 * Input: The data must be a package: URI whose scheme specific part is
1600 * the package name of the current installed package to be uninstalled.
1601 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1602 * <p>
1603 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1604 * succeeded.
1605 */
1606 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1607 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1608
1609 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001610 * Specify whether the package should be uninstalled for all users.
1611 * @hide because these should not be part of normal application flow.
1612 */
1613 public static final String EXTRA_UNINSTALL_ALL_USERS
1614 = "android.intent.extra.UNINSTALL_ALL_USERS";
1615
1616 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001617 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1618 * describing the last run version of the platform that was setup.
1619 * @hide
1620 */
1621 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1622
Svet Ganov3695b8a2015-03-24 16:30:25 -07001623 /**
1624 * Activity action: Launch UI to manage the permissions of an app.
1625 * <p>
1626 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1627 * will be managed by the launched UI.
1628 * </p>
1629 * <p>
1630 * Output: Nothing.
1631 * </p>
1632 *
1633 * @see #EXTRA_PACKAGE_NAME
1634 *
1635 * @hide
1636 */
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 Ganov321f0152015-05-16 22:51:50 -07001652 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1653 public static final String ACTION_MANAGE_PERMISSIONS =
1654 "android.intent.action.MANAGE_PERMISSIONS";
1655
1656 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001657 * Activity action: Launch UI to review permissions for an app.
1658 * The system uses this intent if permission review for apps not
1659 * supporting the new runtime permissions model is enabled. In
1660 * this mode a permission review is required before any of the
1661 * app components can run.
1662 * <p>
1663 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1664 * permissions will be reviewed (mandatory).
1665 * </p>
1666 * <p>
1667 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1668 * be fired after the permission review (optional).
1669 * </p>
1670 * <p>
1671 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1672 * be invoked after the permission review (optional).
1673 * </p>
1674 * <p>
1675 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1676 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1677 * </p>
1678 * <p>
1679 * Output: Nothing.
1680 * </p>
1681 *
1682 * @see #EXTRA_PACKAGE_NAME
1683 * @see #EXTRA_INTENT
1684 * @see #EXTRA_REMOTE_CALLBACK
1685 * @see #EXTRA_RESULT_NEEDED
1686 *
1687 * @hide
1688 */
1689 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1690 public static final String ACTION_REVIEW_PERMISSIONS =
1691 "android.intent.action.REVIEW_PERMISSIONS";
1692
1693 /**
1694 * Intent extra: A callback for reporting remote result as a bundle.
1695 * <p>
1696 * Type: IRemoteCallback
1697 * </p>
1698 *
1699 * @hide
1700 */
1701 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1702
1703 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001704 * Intent extra: An app package name.
1705 * <p>
1706 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001707 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001708 *
Svet Ganov3695b8a2015-03-24 16:30:25 -07001709 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001710 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1711
1712 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001713 * Intent extra: An extra for specifying whether a result is needed.
1714 * <p>
1715 * Type: boolean
1716 * </p>
1717 *
1718 * @hide
1719 */
1720 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1721
1722 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001723 * Broadcast action that requests current permission granted information. It will respond
1724 * to the request by sending a broadcast with action defined by
1725 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001726 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1727 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1728 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001729 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001730 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1731 * number of permissions requested and the number of granted additional permissions
1732 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001733 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001734 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1735 * of localized permission group names that are granted in
1736 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001737 *
1738 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1739 * permissions and the total number of apps requesting runtime permissions will be the first
1740 * and second elements respectively of an int[] in the response as
1741 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1742 *
1743 * @hide
1744 */
1745 public static final String ACTION_GET_PERMISSIONS_COUNT
1746 = "android.intent.action.GET_PERMISSIONS_COUNT";
1747
1748 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001749 * Broadcast action that requests list of all apps that have runtime permissions. It will
1750 * respond to the request by sending a broadcast with action defined by
1751 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1752 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1753 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1754 * a null upon failure.
1755 *
1756 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1757 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1758 * will contain the list of app labels corresponding ot the apps in the first list.
1759 *
1760 * @hide
1761 */
1762 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1763 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1764
1765 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001766 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1767 * @hide
1768 */
1769 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1770 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1771
1772 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001773 * List of CharSequence of localized permission group labels.
1774 * @hide
1775 */
1776 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1777 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1778
1779 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001780 * String list of apps that have one or more runtime permissions.
1781 * @hide
1782 */
1783 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1784 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1785
1786 /**
1787 * String list of app labels for apps that have one or more runtime permissions.
1788 * @hide
1789 */
1790 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1791 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1792
1793 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001794 * Boolean list describing if the app is a system app for apps that have one or more runtime
1795 * permissions.
1796 * @hide
1797 */
1798 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1799 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1800
1801 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001802 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001803 * @hide
1804 */
1805 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1806 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1807
1808 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001809 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1810 * @hide
1811 */
1812 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1813 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1814
1815 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001816 * Activity action: Launch UI to manage which apps have a given permission.
1817 * <p>
1818 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1819 * to which will be managed by the launched UI.
1820 * </p>
1821 * <p>
1822 * Output: Nothing.
1823 * </p>
1824 *
1825 * @see #EXTRA_PERMISSION_NAME
1826 *
1827 * @hide
1828 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001829 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1830 public static final String ACTION_MANAGE_PERMISSION_APPS =
1831 "android.intent.action.MANAGE_PERMISSION_APPS";
1832
1833 /**
1834 * Intent extra: The name of a permission.
1835 * <p>
1836 * Type: String
1837 * </p>
1838 *
1839 * @hide
1840 */
1841 @SystemApi
1842 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1843
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001844 // ---------------------------------------------------------------------
1845 // ---------------------------------------------------------------------
1846 // Standard intent broadcast actions (see action variable).
1847
1848 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001849 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1850 * <p>
1851 * For historical reasons, the name of this broadcast action refers to the power
1852 * state of the screen but it is actually sent in response to changes in the
1853 * overall interactive state of the device.
1854 * </p><p>
1855 * This broadcast is sent when the device becomes non-interactive which may have
1856 * nothing to do with the screen turning off. To determine the
1857 * actual state of the screen, use {@link android.view.Display#getState}.
1858 * </p><p>
1859 * See {@link android.os.PowerManager#isInteractive} for details.
1860 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001861 * You <em>cannot</em> receive this through components declared in
1862 * manifests, only by explicitly registering for it with
1863 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1864 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001865 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001866 * <p class="note">This is a protected intent that can only be sent
1867 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001868 */
1869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1870 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001871
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001872 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001873 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1874 * <p>
1875 * For historical reasons, the name of this broadcast action refers to the power
1876 * state of the screen but it is actually sent in response to changes in the
1877 * overall interactive state of the device.
1878 * </p><p>
1879 * This broadcast is sent when the device becomes interactive which may have
1880 * nothing to do with the screen turning on. To determine the
1881 * actual state of the screen, use {@link android.view.Display#getState}.
1882 * </p><p>
1883 * See {@link android.os.PowerManager#isInteractive} for details.
1884 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001885 * You <em>cannot</em> receive this through components declared in
1886 * manifests, only by explicitly registering for it with
1887 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1888 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001889 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001890 * <p class="note">This is a protected intent that can only be sent
1891 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1894 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001895
1896 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001897 * Broadcast Action: Sent after the system stops dreaming.
1898 *
1899 * <p class="note">This is a protected intent that can only be sent by the system.
1900 * It is only sent to registered receivers.</p>
1901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1904
1905 /**
1906 * Broadcast Action: Sent after the system starts dreaming.
1907 *
1908 * <p class="note">This is a protected intent that can only be sent by the system.
1909 * It is only sent to registered receivers.</p>
1910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1912 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1913
1914 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001915 * 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 -07001916 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001917 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001918 * <p class="note">This is a protected intent that can only be sent
1919 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001920 */
1921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001922 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001923
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001924 /**
1925 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001926 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001927 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1929 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001930 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001931 * <p class="note">This is a protected intent that can only be sent
1932 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1936 /**
1937 * Broadcast Action: The time was set.
1938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1941 /**
1942 * Broadcast Action: The date has changed.
1943 */
1944 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1945 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1946 /**
1947 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1948 * <ul>
1949 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1950 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001951 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001952 * <p class="note">This is a protected intent that can only be sent
1953 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 */
1955 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1956 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1957 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001958 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1959 * DNS entries should be tossed.
1960 * @hide
1961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1964 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001965 * Alarm Changed Action: This is broadcast when the AlarmClock
1966 * application's alarm is set or unset. It is used by the
1967 * AlarmClock application and the StatusBar service.
1968 * @hide
1969 */
1970 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1971 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001972
1973 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001974 * Broadcast Action: This is broadcast once, after the user has finished
1975 * booting, but while still in the "locked" state. It can be used to perform
1976 * application-specific initialization, such as installing alarms. You must
1977 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1978 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001979 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001980 * This broadcast is sent immediately at boot by all devices (regardless of
1981 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1982 * higher. Upon receipt of this broadcast, the user is still locked and only
1983 * device-protected storage can be accessed safely. If you want to access
1984 * credential-protected storage, you need to wait for the user to be
1985 * unlocked (typically by entering their lock pattern or PIN for the first
1986 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1987 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1988 * <p>
1989 * To receive this broadcast, your receiver component must be marked as
1990 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001991 * <p class="note">
1992 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001993 *
1994 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001995 */
1996 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1997 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1998
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001999 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06002000 * Broadcast Action: This is broadcast once, after the user has finished
2001 * booting. It can be used to perform application-specific initialization,
2002 * such as installing alarms. You must hold the
2003 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
2004 * order to receive this broadcast.
2005 * <p>
2006 * This broadcast is sent at boot by all devices (both with and without
2007 * direct boot support). Upon receipt of this broadcast, the user is
2008 * unlocked and both device-protected and credential-protected storage can
2009 * accessed safely.
2010 * <p>
2011 * If you need to run while the user is still locked (before they've entered
2012 * their lock pattern or PIN for the first time), you can listen for the
2013 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
2014 * <p class="note">
2015 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07002019
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002020 /**
2021 * Broadcast Action: This is broadcast when a user action should request a
2022 * temporary system dialog to dismiss. Some examples of temporary system
2023 * dialogs are the notification window-shade and the recent tasks dialog.
2024 */
2025 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2026 /**
2027 * Broadcast Action: Trigger the download and eventual installation
2028 * of a package.
2029 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002030 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002031 * <p class="note">This is a protected intent that can only be sent
2032 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002033 *
2034 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002036 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002037 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2038 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2039 /**
2040 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002041 * device. The data contains the name of the package. Note that the
2042 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002043 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002044 * <ul>
2045 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2046 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2047 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2048 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002049 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002050 * <p class="note">This is a protected intent that can only be sent
2051 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2055 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002056 * Broadcast Action: A new version of an application package has been
2057 * installed, replacing an existing version that was previously installed.
2058 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002059 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002060 * <ul>
2061 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2062 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002063 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002064 * <p class="note">This is a protected intent that can only be sent
2065 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2069 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002070 * Broadcast Action: A new version of your application has been installed
2071 * over an existing one. This is only sent to the application that was
2072 * replaced. It does not contain any additional data; to receive it, just
2073 * use an intent filter for this action.
2074 *
2075 * <p class="note">This is a protected intent that can only be sent
2076 * by the system.
2077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2079 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002081 * Broadcast Action: An existing application package has been removed from
2082 * the device. The data contains the name of the package. The package
2083 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002084 * <ul>
2085 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2086 * to the package.
2087 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2088 * application -- data and code -- is being removed.
2089 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2090 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2091 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002092 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002093 * <p class="note">This is a protected intent that can only be sent
2094 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002095 */
2096 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2097 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2098 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002099 * Broadcast Action: An existing application package has been completely
2100 * removed from the device. The data contains the name of the package.
2101 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2102 * {@link #EXTRA_DATA_REMOVED} is true and
2103 * {@link #EXTRA_REPLACING} is false of that broadcast.
2104 *
2105 * <ul>
2106 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2107 * to the package.
2108 * </ul>
2109 *
2110 * <p class="note">This is a protected intent that can only be sent
2111 * by the system.
2112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_PACKAGE_FULLY_REMOVED
2115 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2116 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002117 * Broadcast Action: An existing application package has been changed (e.g.
2118 * a component has been enabled or disabled). The data contains the name of
2119 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002120 * <ul>
2121 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002122 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002123 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002124 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2125 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002126 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002127 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002128 * <p class="note">This is a protected intent that can only be sent
2129 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002130 */
2131 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2132 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2133 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002134 * @hide
2135 * Broadcast Action: Ask system services if there is any reason to
2136 * restart the given package. The data contains the name of the
2137 * package.
2138 * <ul>
2139 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2140 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2141 * </ul>
2142 *
2143 * <p class="note">This is a protected intent that can only be sent
2144 * by the system.
2145 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002146 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002147 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2148 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2149 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002150 * Broadcast Action: The user has restarted a package, and all of its
2151 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002153 * be removed. Note that the restarted package does <em>not</em>
2154 * receive this broadcast.
2155 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002156 * <ul>
2157 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2158 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002159 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002160 * <p class="note">This is a protected intent that can only be sent
2161 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002162 */
2163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2164 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2165 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002166 * Broadcast Action: The user has cleared the data of a package. This should
2167 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002168 * its persistent data is erased and this broadcast sent.
2169 * Note that the cleared package does <em>not</em>
2170 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002171 * <ul>
2172 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2173 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002174 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002175 * <p class="note">This is a protected intent that can only be sent
2176 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002177 */
2178 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2179 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2180 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002181 * Broadcast Action: Packages have been suspended.
2182 * <p>Includes the following extras:
2183 * <ul>
2184 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2185 * </ul>
2186 *
2187 * <p class="note">This is a protected intent that can only be sent
2188 * by the system. It is only sent to registered receivers.
2189 */
2190 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2191 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2192 /**
2193 * Broadcast Action: Packages have been unsuspended.
2194 * <p>Includes the following extras:
2195 * <ul>
2196 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2197 * </ul>
2198 *
2199 * <p class="note">This is a protected intent that can only be sent
2200 * by the system. It is only sent to registered receivers.
2201 */
2202 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2203 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2204 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002205 * Broadcast Action: A user ID has been removed from the system. The user
2206 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002207 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002208 * <p class="note">This is a protected intent that can only be sent
2209 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002210 */
2211 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2212 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002213
2214 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002215 * Broadcast Action: Sent to the installer package of an application
2216 * when that application is first launched (that is the first time it
2217 * is moved out of the stopped state). The data contains the name of the package.
2218 *
2219 * <p class="note">This is a protected intent that can only be sent
2220 * by the system.
2221 */
2222 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2223 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2224
2225 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002226 * Broadcast Action: Sent to the system package verifier when a package
2227 * needs to be verified. The data contains the package URI.
2228 * <p class="note">
2229 * This is a protected intent that can only be sent by the system.
2230 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2233 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2234
2235 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002236 * Broadcast Action: Sent to the system package verifier when a package is
2237 * verified. The data contains the package URI.
2238 * <p class="note">
2239 * This is a protected intent that can only be sent by the system.
2240 */
2241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2242 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2243
2244 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002245 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2246 * needs to be verified. The data contains the filter data hosts to be verified against.
2247 * <p class="note">
2248 * This is a protected intent that can only be sent by the system.
2249 * </p>
2250 *
2251 * @hide
2252 */
2253 @SystemApi
2254 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2255 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2256
2257 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002258 * Broadcast Action: Resources for a set of packages (which were
2259 * previously unavailable) are currently
2260 * available since the media on which they exist is available.
2261 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2262 * list of packages whose availability changed.
2263 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2264 * list of uids of packages whose availability changed.
2265 * Note that the
2266 * packages in this list do <em>not</em> receive this broadcast.
2267 * The specified set of packages are now available on the system.
2268 * <p>Includes the following extras:
2269 * <ul>
2270 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2271 * whose resources(were previously unavailable) are currently available.
2272 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2273 * packages whose resources(were previously unavailable)
2274 * are currently available.
2275 * </ul>
2276 *
2277 * <p class="note">This is a protected intent that can only be sent
2278 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002279 */
2280 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002281 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2282 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002283
2284 /**
2285 * Broadcast Action: Resources for a set of packages are currently
2286 * unavailable since the media on which they exist is unavailable.
2287 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2288 * list of packages whose availability changed.
2289 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2290 * list of uids of packages whose availability changed.
2291 * The specified set of packages can no longer be
2292 * launched and are practically unavailable on the system.
2293 * <p>Inclues the following extras:
2294 * <ul>
2295 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2296 * whose resources are no longer available.
2297 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2298 * whose resources are no longer available.
2299 * </ul>
2300 *
2301 * <p class="note">This is a protected intent that can only be sent
2302 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002303 */
2304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002305 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002306 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002307
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002308 /**
2309 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002310 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002311 * This should <em>only</em> be used to determine when the wallpaper
2312 * has changed to show the new wallpaper to the user. You should certainly
2313 * never, in response to this, change the wallpaper or other attributes of
2314 * it such as the suggested size. That would be crazy, right? You'd cause
2315 * all kinds of loops, especially if other apps are doing similar things,
2316 * right? Of course. So please don't do this.
2317 *
2318 * @deprecated Modern applications should use
2319 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2320 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2321 * shown behind their UI, rather than watching for this broadcast and
2322 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002323 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002324 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002325 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2326 /**
2327 * Broadcast Action: The current device {@link android.content.res.Configuration}
2328 * (orientation, locale, etc) has changed. When such a change happens, the
2329 * UIs (view hierarchy) will need to be rebuilt based on this new
2330 * information; for the most part, applications don't need to worry about
2331 * this, because the system will take care of stopping and restarting the
2332 * application to make sure it sees the new changes. Some system code that
2333 * can not be restarted will need to watch for this action and handle it
2334 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002335 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002336 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002337 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002338 * in manifests, only by explicitly registering for it with
2339 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2340 * Context.registerReceiver()}.
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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002344 *
2345 * @see android.content.res.Configuration
2346 */
2347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2348 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2349 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002350 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002351 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002352 * <p class="note">This is a protected intent that can only be sent
2353 * by the system.
2354 */
2355 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2356 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2357 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002358 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2359 * charging state, level, and other information about the battery.
2360 * See {@link android.os.BatteryManager} for documentation on the
2361 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002362 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002364 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002365 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002366 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002367 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2368 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2369 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2370 * broadcasts that are sent and can be received through manifest
2371 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002372 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002373 * <p class="note">This is a protected intent that can only be sent
2374 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002375 */
2376 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2377 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2378 /**
2379 * Broadcast Action: Indicates low battery condition on the device.
2380 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002381 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002382 * <p class="note">This is a protected intent that can only be sent
2383 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002384 */
2385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2386 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2387 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002388 * Broadcast Action: Indicates the battery is now okay after being low.
2389 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2390 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002391 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002392 * <p class="note">This is a protected intent that can only be sent
2393 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002394 */
2395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2396 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2397 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002398 * Broadcast Action: External power has been connected to the device.
2399 * This is intended for applications that wish to register specifically to this notification.
2400 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2401 * stay active to receive this notification. This action can be used to implement actions
2402 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002403 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002404 * <p class="note">This is a protected intent that can only be sent
2405 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002406 */
2407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002408 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002409 /**
2410 * Broadcast Action: External power has been removed from the device.
2411 * This is intended for applications that wish to register specifically to this notification.
2412 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2413 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002414 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002415 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002416 * <p class="note">This is a protected intent that can only be sent
2417 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002418 */
2419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002420 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002421 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002422 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002423 * Broadcast Action: Device is shutting down.
2424 * This is broadcast when the device is being shut down (completely turned
2425 * off, not sleeping). Once the broadcast is complete, the final shutdown
2426 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002427 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002428 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002429 * <p class="note">This is a protected intent that can only be sent
2430 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002431 * <p>May include the following extras:
2432 * <ul>
2433 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2434 * shutdown is only for userspace processes. If not set, assumed to be false.
2435 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002436 */
2437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002438 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002439 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002440 * Activity Action: Start this activity to request system shutdown.
2441 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002442 * to request confirmation from the user before shutting down. The optional boolean
2443 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2444 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002445 *
2446 * <p class="note">This is a protected intent that can only be sent
2447 * by the system.
2448 *
2449 * {@hide}
2450 */
2451 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2452 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002453 * Broadcast Action: A sticky broadcast that indicates low memory
2454 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002455 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002456 * <p class="note">This is a protected intent that can only be sent
2457 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002458 */
2459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2460 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2461 /**
2462 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002463 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002464 * <p class="note">This is a protected intent that can only be sent
2465 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002466 */
2467 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2468 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2469 /**
Jake Hambybb371632010-08-23 18:16:48 -07002470 * Broadcast Action: A sticky broadcast that indicates a memory full
2471 * condition on the device. This is intended for activities that want
2472 * to be able to fill the data partition completely, leaving only
2473 * enough free space to prevent system-wide SQLite failures.
2474 *
2475 * <p class="note">This is a protected intent that can only be sent
2476 * by the system.
2477 *
2478 * {@hide}
2479 */
2480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2481 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2482 /**
2483 * Broadcast Action: Indicates memory full condition on the device
2484 * no longer exists.
2485 *
2486 * <p class="note">This is a protected intent that can only be sent
2487 * by the system.
2488 *
2489 * {@hide}
2490 */
2491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2492 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2493 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002494 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2495 * and package management should be started.
2496 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2497 * notification.
2498 */
2499 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2500 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2501 /**
2502 * Broadcast Action: The device has entered USB Mass Storage mode.
2503 * This is used mainly for the USB Settings panel.
2504 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2505 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002506 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002507 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002508 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002509 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2510
2511 /**
2512 * Broadcast Action: The device has exited USB Mass Storage mode.
2513 * This is used mainly for the USB Settings panel.
2514 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2515 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002516 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002517 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002518 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002519 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2520
2521 /**
2522 * Broadcast Action: External media has been removed.
2523 * The path to the mount point for the removed media is contained in the Intent.mData field.
2524 */
2525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2526 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2527
2528 /**
2529 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002530 * 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 -07002531 */
2532 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2533 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2534
2535 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002536 * Broadcast Action: External media is present, and being disk-checked
2537 * 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 -08002538 */
2539 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2540 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2541
2542 /**
2543 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2544 * 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 -08002545 */
2546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2547 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2548
2549 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002550 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002551 * 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 -07002552 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2553 * media was mounted read only.
2554 */
2555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2556 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2557
2558 /**
2559 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002560 * 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 -07002561 */
2562 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2563 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2564
2565 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002566 * Broadcast Action: External media is no longer being shared via USB mass storage.
2567 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2568 *
2569 * @hide
2570 */
2571 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2572
2573 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002574 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2575 * The path to the mount point for the removed media is contained in the Intent.mData field.
2576 */
2577 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2578 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2579
2580 /**
2581 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002582 * 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 -07002583 */
2584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2585 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2586
2587 /**
2588 * Broadcast Action: User has expressed the desire to remove the external storage media.
2589 * Applications should close all files they have open within the mount point when they receive this intent.
2590 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2591 */
2592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2593 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2594
2595 /**
2596 * Broadcast Action: The media scanner has started scanning a directory.
2597 * The path to the directory being scanned is contained in the Intent.mData field.
2598 */
2599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2600 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2601
2602 /**
2603 * Broadcast Action: The media scanner has finished scanning a directory.
2604 * The path to the scanned directory is contained in the Intent.mData field.
2605 */
2606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2607 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2608
2609 /**
2610 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2611 * The path to the file is contained in the Intent.mData field.
2612 */
2613 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2614 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2615
2616 /**
2617 * Broadcast Action: The "Media Button" was pressed. Includes a single
2618 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2619 * caused the broadcast.
2620 */
2621 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2622 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2623
2624 /**
2625 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2626 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2627 * caused the broadcast.
2628 */
2629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2630 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2631
2632 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2633 // location; they are not general-purpose actions.
2634
2635 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002636 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002637 */
2638 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2639 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2640 "android.intent.action.GTALK_CONNECTED";
2641
2642 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002643 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002644 */
2645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2646 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2647 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002648
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002649 /**
2650 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002651 */
2652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2653 public static final String ACTION_INPUT_METHOD_CHANGED =
2654 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002655
2656 /**
2657 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2658 * more radios have been turned off or on. The intent will have the following extra value:</p>
2659 * <ul>
2660 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2661 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2662 * turned off</li>
2663 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002664 *
Peng Xua35b5532016-01-20 00:05:45 -08002665 * <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 -07002666 */
2667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2668 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2669
2670 /**
2671 * Broadcast Action: Some content providers have parts of their namespace
2672 * where they publish new events or items that the user may be especially
2673 * interested in. For these things, they may broadcast this action when the
2674 * set of interesting items change.
2675 *
2676 * For example, GmailProvider sends this notification when the set of unread
2677 * mail in the inbox changes.
2678 *
2679 * <p>The data of the intent identifies which part of which provider
2680 * changed. When queried through the content resolver, the data URI will
2681 * return the data set in question.
2682 *
2683 * <p>The intent will have the following extra values:
2684 * <ul>
2685 * <li><em>count</em> - The number of items in the data set. This is the
2686 * same as the number of items in the cursor returned by querying the
2687 * data URI. </li>
2688 * </ul>
2689 *
2690 * This intent will be sent at boot (if the count is non-zero) and when the
2691 * data set changes. It is possible for the data set to change without the
2692 * count changing (for example, if a new unread message arrives in the same
2693 * sync operation in which a message is archived). The phone should still
2694 * ring/vibrate/etc as normal in this case.
2695 */
2696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2697 public static final String ACTION_PROVIDER_CHANGED =
2698 "android.intent.action.PROVIDER_CHANGED";
2699
2700 /**
2701 * Broadcast Action: Wired Headset plugged in or unplugged.
2702 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002703 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2704 * and documentation.
2705 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002706 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002707 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002708 */
2709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002710 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002711
2712 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002713 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2714 * <ul>
2715 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2716 * </ul>
2717 *
2718 * <p class="note">This is a protected intent that can only be sent
2719 * by the system.
2720 *
2721 * @hide
2722 */
2723 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2724 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2725 = "android.intent.action.ADVANCED_SETTINGS";
2726
2727 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002728 * Broadcast Action: Sent after application restrictions are changed.
2729 *
2730 * <p class="note">This is a protected intent that can only be sent
2731 * by the system.</p>
2732 */
2733 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2734 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2735 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2736
2737 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002738 * Broadcast Action: An outgoing call is about to be placed.
2739 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002740 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002741 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002742 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002743 * the phone number originally intended to be dialed.</li>
2744 * </ul>
2745 * <p>Once the broadcast is finished, the resultData is used as the actual
2746 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002747 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002748 * outgoing call in turn: for example, a parental control application
2749 * might verify that the user is authorized to place the call at that
2750 * time, then a number-rewriting application might add an area code if
2751 * one was not specified.</p>
2752 * <p>For consistency, any receiver whose purpose is to prohibit phone
2753 * calls should have a priority of 0, to ensure it will see the final
2754 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002755 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002756 * should have a positive priority.
2757 * Negative priorities are reserved for the system for this broadcast;
2758 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002759 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2760 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002761 * <p>Emergency calls cannot be intercepted using this mechanism, and
2762 * other calls cannot be modified to call emergency numbers using this
2763 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002764 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2765 * call to use their own service instead. Those apps should first prevent
2766 * the call from being placed by setting resultData to <code>null</code>
2767 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002768 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002769 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2770 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002771 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002772 * <p class="note">This is a protected intent that can only be sent
2773 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002774 */
2775 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2776 public static final String ACTION_NEW_OUTGOING_CALL =
2777 "android.intent.action.NEW_OUTGOING_CALL";
2778
2779 /**
2780 * Broadcast Action: Have the device reboot. This is only for use by
2781 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002782 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002783 * <p class="note">This is a protected intent that can only be sent
2784 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002785 */
2786 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2787 public static final String ACTION_REBOOT =
2788 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002789
Wei Huang97ecc9c2009-05-11 17:44:20 -07002790 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002791 * Broadcast Action: A sticky broadcast for changes in the physical
2792 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002793 *
2794 * <p>The intent will have the following extra values:
2795 * <ul>
2796 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002797 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002798 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002799 * <p>This is intended for monitoring the current physical dock state.
2800 * See {@link android.app.UiModeManager} for the normal API dealing with
2801 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002802 */
2803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2804 public static final String ACTION_DOCK_EVENT =
2805 "android.intent.action.DOCK_EVENT";
2806
2807 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002808 * Broadcast Action: A broadcast when idle maintenance can be started.
2809 * This means that the user is not interacting with the device and is
2810 * not expected to do so soon. Typical use of the idle maintenance is
2811 * to perform somehow expensive tasks that can be postponed at a moment
2812 * when they will not degrade user experience.
2813 * <p>
2814 * <p class="note">In order to keep the device responsive in case of an
2815 * unexpected user interaction, implementations of a maintenance task
2816 * should be interruptible. In such a scenario a broadcast with action
2817 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2818 * should not do the maintenance work in
2819 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2820 * maintenance service by {@link Context#startService(Intent)}. Also
2821 * you should hold a wake lock while your maintenance service is running
2822 * to prevent the device going to sleep.
2823 * </p>
2824 * <p>
2825 * <p class="note">This is a protected intent that can only be sent by
2826 * the system.
2827 * </p>
2828 *
2829 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002830 *
2831 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002832 */
2833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2834 public static final String ACTION_IDLE_MAINTENANCE_START =
2835 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2836
2837 /**
2838 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2839 * This means that the user was not interacting with the device as a result
2840 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2841 * was sent and now the user started interacting with the device. Typical
2842 * use of the idle maintenance is to perform somehow expensive tasks that
2843 * can be postponed at a moment when they will not degrade user experience.
2844 * <p>
2845 * <p class="note">In order to keep the device responsive in case of an
2846 * unexpected user interaction, implementations of a maintenance task
2847 * should be interruptible. Hence, on receiving a broadcast with this
2848 * action, the maintenance task should be interrupted as soon as possible.
2849 * In other words, you should not do the maintenance work in
2850 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2851 * maintenance service that was started on receiving of
2852 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2853 * lock you acquired when your maintenance service started.
2854 * </p>
2855 * <p class="note">This is a protected intent that can only be sent
2856 * by the system.
2857 *
2858 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002859 *
2860 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002861 */
2862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2863 public static final String ACTION_IDLE_MAINTENANCE_END =
2864 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2865
2866 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002867 * Broadcast Action: a remote intent is to be broadcasted.
2868 *
2869 * A remote intent is used for remote RPC between devices. The remote intent
2870 * is serialized and sent from one device to another device. The receiving
2871 * device parses the remote intent and broadcasts it. Note that anyone can
2872 * broadcast a remote intent. However, if the intent receiver of the remote intent
2873 * does not trust intent broadcasts from arbitrary intent senders, it should require
2874 * the sender to hold certain permissions so only trusted sender's broadcast will be
2875 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002876 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002877 */
2878 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002879 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002880
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002881 /**
Jeff Sharkeybd91e2f2016-03-22 15:32:31 -06002882 * Broadcast Action: This is broadcast once when the user is booting after a
2883 * system update. It can be used to perform cleanup or upgrades after a
2884 * system update.
2885 * <p>
2886 * This broadcast is sent after the {@link #ACTION_LOCKED_BOOT_COMPLETED}
2887 * broadcast but before the {@link #ACTION_BOOT_COMPLETED} broadcast. It's
2888 * only sent when the {@link Build#FINGERPRINT} has changed, and it's only
2889 * sent to receivers in the system image.
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002890 *
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002891 * @hide
2892 */
2893 public static final String ACTION_PRE_BOOT_COMPLETED =
2894 "android.intent.action.PRE_BOOT_COMPLETED";
2895
Amith Yamasani13593602012-03-22 16:16:17 -07002896 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002897 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002898 * on restricted users. The broadcast intent contains an extra
2899 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2900 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2901 * String[] depending on the restriction type.<p/>
2902 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002903 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2904 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2905 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002906 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2907 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002908 * @see RestrictionEntry
2909 */
2910 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2911 "android.intent.action.GET_RESTRICTION_ENTRIES";
2912
2913 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002914 * Sent the first time a user is starting, to allow system apps to
2915 * perform one time initialization. (This will not be seen by third
2916 * party applications because a newly initialized user does not have any
2917 * third party applications installed for it.) This is sent early in
2918 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002919 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2920 * broadcast, since it is part of a visible user interaction; be as quick
2921 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002922 */
2923 public static final String ACTION_USER_INITIALIZE =
2924 "android.intent.action.USER_INITIALIZE";
2925
2926 /**
2927 * Sent when a user switch is happening, causing the process's user to be
2928 * brought to the foreground. This is only sent to receivers registered
2929 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2930 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002931 * foreground. This is sent as a foreground
2932 * broadcast, since it is part of a visible user interaction; be as quick
2933 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002934 */
2935 public static final String ACTION_USER_FOREGROUND =
2936 "android.intent.action.USER_FOREGROUND";
2937
2938 /**
2939 * Sent when a user switch is happening, causing the process's user to be
2940 * sent to the background. This is only sent to receivers registered
2941 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2942 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002943 * background. This is sent as a foreground
2944 * broadcast, since it is part of a visible user interaction; be as quick
2945 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002946 */
2947 public static final String ACTION_USER_BACKGROUND =
2948 "android.intent.action.USER_BACKGROUND";
2949
2950 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002951 * Broadcast sent to the system when a user is added. Carries an extra
2952 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2953 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002954 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002955 * @hide
2956 */
2957 public static final String ACTION_USER_ADDED =
2958 "android.intent.action.USER_ADDED";
2959
2960 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002961 * Broadcast sent by the system when a user is started. Carries an extra
2962 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002963 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002964 * that has been started. This is sent as a foreground
2965 * broadcast, since it is part of a visible user interaction; be as quick
2966 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002967 * @hide
2968 */
2969 public static final String ACTION_USER_STARTED =
2970 "android.intent.action.USER_STARTED";
2971
2972 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002973 * Broadcast sent when a user is in the process of starting. Carries an extra
2974 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2975 * sent to registered receivers, not manifest receivers. It is sent to all
2976 * users (including the one that is being started). You must hold
2977 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2978 * this broadcast. This is sent as a background broadcast, since
2979 * its result is not part of the primary UX flow; to safely keep track of
2980 * started/stopped state of a user you can use this in conjunction with
2981 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2982 * other user state broadcasts since those are foreground broadcasts so can
2983 * execute in a different order.
2984 * @hide
2985 */
2986 public static final String ACTION_USER_STARTING =
2987 "android.intent.action.USER_STARTING";
2988
2989 /**
2990 * Broadcast sent when a user is going to be stopped. Carries an extra
2991 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2992 * sent to registered receivers, not manifest receivers. It is sent to all
2993 * users (including the one that is being stopped). You must hold
2994 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2995 * this broadcast. The user will not stop until all receivers have
2996 * handled the broadcast. This is sent as a background broadcast, since
2997 * its result is not part of the primary UX flow; to safely keep track of
2998 * started/stopped state of a user you can use this in conjunction with
2999 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
3000 * other user state broadcasts since those are foreground broadcasts so can
3001 * execute in a different order.
3002 * @hide
3003 */
3004 public static final String ACTION_USER_STOPPING =
3005 "android.intent.action.USER_STOPPING";
3006
3007 /**
3008 * Broadcast sent to the system when a user is stopped. Carries an extra
3009 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
3010 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
3011 * specific package. This is only sent to registered receivers, not manifest
3012 * receivers. It is sent to all running users <em>except</em> the one that
3013 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07003014 * @hide
3015 */
3016 public static final String ACTION_USER_STOPPED =
3017 "android.intent.action.USER_STOPPED";
3018
3019 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003020 * 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 -07003021 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07003022 * one that has been removed. The user will not be completely removed until all receivers have
3023 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003024 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003025 * @hide
3026 */
3027 public static final String ACTION_USER_REMOVED =
3028 "android.intent.action.USER_REMOVED";
3029
3030 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003031 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003032 * the userHandle of the user to become the current one. This is only sent to
3033 * registered receivers, not manifest receivers. It is sent to all running users.
3034 * You must hold
3035 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003036 * @hide
3037 */
3038 public static final String ACTION_USER_SWITCHED =
3039 "android.intent.action.USER_SWITCHED";
3040
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003041 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003042 * Broadcast Action: Sent when the credential-encrypted private storage has
3043 * become unlocked for the target user. This is only sent to registered
3044 * receivers, not manifest receivers.
3045 */
3046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3047 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3048
3049 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003050 * Broadcast sent to the system when a user's information changes. Carries an extra
3051 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003052 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003053 * @hide
3054 */
3055 public static final String ACTION_USER_INFO_CHANGED =
3056 "android.intent.action.USER_INFO_CHANGED";
3057
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003058 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003059 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3060 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003061 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3062 * that need to display merged content across both primary and managed profiles need to
3063 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003064 * not manifest receivers.
3065 */
3066 public static final String ACTION_MANAGED_PROFILE_ADDED =
3067 "android.intent.action.MANAGED_PROFILE_ADDED";
3068
3069 /**
3070 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003071 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3072 * Only applications (for example Launchers) that need to display merged content across both
3073 * primary and managed profiles need to worry about this broadcast. This is only sent to
3074 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003075 */
3076 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3077 "android.intent.action.MANAGED_PROFILE_REMOVED";
3078
3079 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003080 * Broadcast sent to the primary user when the credential-encrypted private storage for
3081 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3082 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3083 * Launchers) that need to display merged content across both primary and managed profiles
3084 * need to worry about this broadcast. This is only sent to registered receivers,
3085 * not manifest receivers.
3086 */
3087 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3088 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3089
Rubin Xue95057a2016-04-01 16:49:25 +01003090 /** @hide */
3091 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3092 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3093
Kenny Guyb1b30262016-02-09 16:02:35 +00003094 /**
Rubin Xue95057a2016-04-01 16:49:25 +01003095 * Broadcast sent to the primary user when an associated managed profile has become available.
3096 * Currently this includes when the user disables quiet mode for the profile. Carries an extra
Rubin Xuf13c9802016-01-21 18:06:00 +00003097 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3098 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3099 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003100 */
Rubin Xue95057a2016-04-01 16:49:25 +01003101 public static final String ACTION_MANAGED_PROFILE_AVAILABLE =
3102 "android.intent.action.MANAGED_PROFILE_AVAILABLE";
3103
3104 /**
3105 * Broadcast sent to the primary user when an associated managed profile has become unavailable.
3106 * Currently this includes when the user enables quiet mode for the profile. Carries an extra
3107 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3108 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3109 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
3110 */
3111 public static final String ACTION_MANAGED_PROFILE_UNAVAILABLE =
3112 "android.intent.action.MANAGED_PROFILE_UNAVAILABLE";
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003113
3114 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003115 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3116 */
3117 public static final String ACTION_QUICK_CLOCK =
3118 "android.intent.action.QUICK_CLOCK";
3119
Michael Wright0087a142013-02-05 16:29:39 -08003120 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003121 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003122 * @hide
3123 */
3124 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3125 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3126
Justin Kohd378ad72013-04-01 12:18:26 -07003127 /**
3128 * Broadcast Action: A global button was pressed. Includes a single
3129 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3130 * caused the broadcast.
3131 * @hide
3132 */
3133 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3134
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003135 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003136 * Broadcast Action: Sent when media resource is granted.
3137 * <p>
3138 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3139 * granted.
3140 * </p>
3141 * <p class="note">
3142 * This is a protected intent that can only be sent by the system.
3143 * </p>
3144 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003145 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003146 * </p>
3147 *
3148 * @hide
3149 */
3150 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3151 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3152
3153 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003154 * Activity Action: Allow the user to select and return one or more existing
3155 * documents. When invoked, the system will display the various
3156 * {@link DocumentsProvider} instances installed on the device, letting the
3157 * user interactively navigate through them. These documents include local
3158 * media, such as photos and video, and documents provided by installed
3159 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003160 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003161 * Each document is represented as a {@code content://} URI backed by a
3162 * {@link DocumentsProvider}, which can be opened as a stream with
3163 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3164 * {@link android.provider.DocumentsContract.Document} metadata.
3165 * <p>
3166 * All selected documents are returned to the calling application with
3167 * persistable read and write permission grants. If you want to maintain
3168 * access to the documents across device reboots, you need to explicitly
3169 * take the persistable permissions using
3170 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3171 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003172 * Callers must indicate the acceptable document MIME types through
3173 * {@link #setType(String)}. For example, to select photos, use
3174 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3175 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3176 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003177 * <p>
3178 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003179 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3180 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003181 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003182 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3183 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003184 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003185 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003186 * Output: The URI of the item that was picked, returned in
3187 * {@link #getData()}. This must be a {@code content://} URI so that any
3188 * receiver can access it. If multiple documents were selected, they are
3189 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003190 *
3191 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003192 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003193 * @see #ACTION_CREATE_DOCUMENT
3194 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003195 */
3196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3197 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3198
3199 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003200 * Activity Action: Allow the user to create a new document. When invoked,
3201 * the system will display the various {@link DocumentsProvider} instances
3202 * installed on the device, letting the user navigate through them. The
3203 * returned document may be a newly created document with no content, or it
3204 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003205 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003206 * Each document is represented as a {@code content://} URI backed by a
3207 * {@link DocumentsProvider}, which can be opened as a stream with
3208 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3209 * {@link android.provider.DocumentsContract.Document} metadata.
3210 * <p>
3211 * Callers must indicate the concrete MIME type of the document being
3212 * created by setting {@link #setType(String)}. This MIME type cannot be
3213 * changed after the document is created.
3214 * <p>
3215 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3216 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003217 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003218 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3219 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003220 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003221 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003222 * Output: The URI of the item that was created. This must be a
3223 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003224 *
3225 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003226 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003227 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003228 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003229 */
3230 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3231 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3232
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003233 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003234 * Activity Action: Allow the user to pick a directory subtree. When
3235 * invoked, the system will display the various {@link DocumentsProvider}
3236 * instances installed on the device, letting the user navigate through
3237 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003238 * <p>
3239 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003240 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3241 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3242 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003243 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003244 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003245 *
3246 * @see DocumentsContract
3247 */
3248 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003249 public static final String
3250 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003251
Felipe Lemec7b1f892016-01-15 15:02:31 -08003252 /**
Peng Xua35b5532016-01-20 00:05:45 -08003253 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3254 * exisiting sensor being disconnected.
3255 *
3256 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3257 *
3258 * {@hide}
3259 */
3260 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3261 public static final String
3262 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3263
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003264 /** {@hide} */
3265 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3266
Christopher Tate6597e342015-02-17 12:15:25 -08003267 /**
3268 * Broadcast action: report that a settings element is being restored from backup. The intent
3269 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3270 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3271 * is the value of that settings entry prior to the restore operation. All of these values are
3272 * represented as strings.
3273 *
3274 * <p>This broadcast is sent only for settings provider entries known to require special handling
3275 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3276 * the provider's backup agent implementation.
3277 *
3278 * @see #EXTRA_SETTING_NAME
3279 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3280 * @see #EXTRA_SETTING_NEW_VALUE
3281 * {@hide}
3282 */
3283 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3284
3285 /** {@hide} */
3286 public static final String EXTRA_SETTING_NAME = "setting_name";
3287 /** {@hide} */
3288 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3289 /** {@hide} */
3290 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3291
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003292 /**
3293 * Activity Action: Process a piece of text.
3294 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3295 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3296 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3297 */
3298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3299 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3300 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003301 * The name of the extra used to define the text to be processed, as a
3302 * CharSequence. Note that this may be a styled CharSequence, so you must use
3303 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003304 */
3305 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3306 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003307 * 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 +00003308 */
3309 public static final String EXTRA_PROCESS_TEXT_READONLY =
3310 "android.intent.extra.PROCESS_TEXT_READONLY";
3311
Bryce Leebc58f592015-09-25 16:43:01 -07003312 /**
3313 * Broadcast action: reports when a new thermal event has been reached. When the device
3314 * is reaching its maximum temperatue, the thermal level reported
3315 * {@hide}
3316 */
3317 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3318 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3319
3320 /** {@hide} */
3321 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3322
3323 /**
3324 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003325 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003326 * {@hide}
3327 */
3328 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3329
3330 /**
3331 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003332 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003333 * {@hide}
3334 */
3335 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3336
3337 /**
3338 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003339 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003340 * {@hide}
3341 */
3342 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3343
3344
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003345 // ---------------------------------------------------------------------
3346 // ---------------------------------------------------------------------
3347 // Standard intent categories (see addCategory()).
3348
3349 /**
3350 * Set if the activity should be an option for the default action
3351 * (center press) to perform on a piece of data. Setting this will
3352 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003353 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003354 * Intent when initiating an action -- it is for use in intent filters
3355 * specified in packages.
3356 */
3357 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3358 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3359 /**
3360 * Activities that can be safely invoked from a browser must support this
3361 * category. For example, if the user is viewing a web page or an e-mail
3362 * and clicks on a link in the text, the Intent generated execute that
3363 * link will require the BROWSABLE category, so that only activities
3364 * supporting this category will be considered as possible actions. By
3365 * supporting this category, you are promising that there is nothing
3366 * damaging (without user intervention) that can happen by invoking any
3367 * matching Intent.
3368 */
3369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3370 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3371 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003372 * Categories for activities that can participate in voice interaction.
3373 * An activity that supports this category must be prepared to run with
3374 * no UI shown at all (though in some case it may have a UI shown), and
3375 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3376 */
3377 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3378 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3379 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003380 * Set if the activity should be considered as an alternative action to
3381 * the data the user is currently viewing. See also
3382 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3383 * applies to the selection in a list of items.
3384 *
3385 * <p>Supporting this category means that you would like your activity to be
3386 * displayed in the set of alternative things the user can do, usually as
3387 * part of the current activity's options menu. You will usually want to
3388 * include a specific label in the &lt;intent-filter&gt; of this action
3389 * describing to the user what it does.
3390 *
3391 * <p>The action of IntentFilter with this category is important in that it
3392 * describes the specific action the target will perform. This generally
3393 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3394 * a specific name such as "com.android.camera.action.CROP. Only one
3395 * alternative of any particular action will be shown to the user, so using
3396 * a specific action like this makes sure that your alternative will be
3397 * displayed while also allowing other applications to provide their own
3398 * overrides of that particular action.
3399 */
3400 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3401 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3402 /**
3403 * Set if the activity should be considered as an alternative selection
3404 * action to the data the user has currently selected. This is like
3405 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3406 * of items from which the user can select, giving them alternatives to the
3407 * default action that will be performed on it.
3408 */
3409 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3410 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3411 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003412 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003413 */
3414 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3415 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3416 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417 * Should be displayed in the top-level launcher.
3418 */
3419 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3420 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3421 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003422 * Indicates an activity optimized for Leanback mode, and that should
3423 * be displayed in the Leanback launcher.
3424 */
3425 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3426 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3427 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003428 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3429 * @hide
3430 */
3431 @SystemApi
3432 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3433 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003434 * Provides information about the package it is in; typically used if
3435 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3436 * a front-door to the user without having to be shown in the all apps list.
3437 */
3438 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3439 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3440 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441 * This is the home activity, that is the first activity that is displayed
3442 * when the device boots.
3443 */
3444 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3445 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3446 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003447 * This is the home activity that is displayed when the device is finished setting up and ready
3448 * for use.
3449 * @hide
3450 */
3451 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3452 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3453 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003454 * This is the setup wizard activity, that is the first activity that is displayed
3455 * when the user sets up the device for the first time.
3456 * @hide
3457 */
3458 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3459 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3460 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003461 * This activity is a preference panel.
3462 */
3463 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3464 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3465 /**
3466 * This activity is a development preference panel.
3467 */
3468 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3469 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3470 /**
3471 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003472 */
3473 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3474 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3475 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003476 * This activity allows the user to browse and download new applications.
3477 */
3478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3479 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3480 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481 * This activity may be exercised by the monkey or other automated test tools.
3482 */
3483 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3484 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3485 /**
3486 * To be used as a test (not part of the normal user experience).
3487 */
3488 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3489 /**
3490 * To be used as a unit test (run through the Test Harness).
3491 */
3492 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3493 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003494 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003495 * experience).
3496 */
3497 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003498
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003499 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003500 * Used to indicate that an intent only wants URIs that can be opened with
3501 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3502 * must support at least the columns defined in {@link OpenableColumns} when
3503 * queried.
3504 *
3505 * @see #ACTION_GET_CONTENT
3506 * @see #ACTION_OPEN_DOCUMENT
3507 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003508 */
3509 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3510 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3511
3512 /**
3513 * To be used as code under test for framework instrumentation tests.
3514 */
3515 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3516 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003517 /**
3518 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003519 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3520 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003521 */
3522 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3523 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3524 /**
3525 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003526 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3527 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003528 */
3529 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3530 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003531 /**
3532 * An activity to run when device is inserted into a analog (low end) dock.
3533 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3534 * information, see {@link android.app.UiModeManager}.
3535 */
3536 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3537 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3538
3539 /**
3540 * An activity to run when device is inserted into a digital (high end) dock.
3541 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3542 * information, see {@link android.app.UiModeManager}.
3543 */
3544 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3545 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003546
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003547 /**
3548 * Used to indicate that the activity can be used in a car environment.
3549 */
3550 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3551 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3552
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003553 // ---------------------------------------------------------------------
3554 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003555 // Application launch intent categories (see addCategory()).
3556
3557 /**
3558 * Used with {@link #ACTION_MAIN} to launch the browser application.
3559 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003560 * <p>NOTE: This should not be used as the primary key of an Intent,
3561 * since it will not result in the app launching with the correct
3562 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003563 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003564 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003565 */
3566 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3567 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3568
3569 /**
3570 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3571 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003572 * <p>NOTE: This should not be used as the primary key of an Intent,
3573 * since it will not result in the app launching with the correct
3574 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003575 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003576 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003577 */
3578 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3579 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3580
3581 /**
3582 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3583 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003584 * <p>NOTE: This should not be used as the primary key of an Intent,
3585 * since it will not result in the app launching with the correct
3586 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003587 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003588 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003589 */
3590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3591 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3592
3593 /**
3594 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3595 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003596 * <p>NOTE: This should not be used as the primary key of an Intent,
3597 * since it will not result in the app launching with the correct
3598 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003599 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003600 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003601 */
3602 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3603 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3604
3605 /**
3606 * Used with {@link #ACTION_MAIN} to launch the email application.
3607 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003608 * <p>NOTE: This should not be used as the primary key of an Intent,
3609 * since it will not result in the app launching with the correct
3610 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003611 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003612 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003613 */
3614 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3615 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3616
3617 /**
3618 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3619 * The activity should be able to view and manipulate image and video files
3620 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003621 * <p>NOTE: This should not be used as the primary key of an Intent,
3622 * since it will not result in the app launching with the correct
3623 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003624 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003625 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003626 */
3627 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3628 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3629
3630 /**
3631 * Used with {@link #ACTION_MAIN} to launch the maps application.
3632 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003633 * <p>NOTE: This should not be used as the primary key of an Intent,
3634 * since it will not result in the app launching with the correct
3635 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003636 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003637 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003638 */
3639 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3640 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3641
3642 /**
3643 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3644 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003645 * <p>NOTE: This should not be used as the primary key of an Intent,
3646 * since it will not result in the app launching with the correct
3647 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003648 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003649 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003650 */
3651 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3652 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3653
3654 /**
3655 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003656 * The activity should be able to play, browse, or manipulate music files
3657 * stored on the device.
3658 * <p>NOTE: This should not be used as the primary key of an Intent,
3659 * since it will not result in the app launching with the correct
3660 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003661 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003662 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003663 */
3664 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3665 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3666
3667 // ---------------------------------------------------------------------
3668 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003669 // Standard extra data keys.
3670
3671 /**
3672 * The initial data to place in a newly created record. Use with
3673 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3674 * fields as would be given to the underlying ContentProvider.insert()
3675 * call.
3676 */
3677 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3678
3679 /**
3680 * A constant CharSequence that is associated with the Intent, used with
3681 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3682 * this may be a styled CharSequence, so you must use
3683 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3684 * retrieve it.
3685 */
3686 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3687
3688 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003689 * A constant String that is associated with the Intent, used with
3690 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3691 * as HTML formatted text. Note that you <em>must</em> also supply
3692 * {@link #EXTRA_TEXT}.
3693 */
3694 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3695
3696 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003697 * A content: URI holding a stream of data associated with the Intent,
3698 * used with {@link #ACTION_SEND} to supply the data being sent.
3699 */
3700 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3701
3702 /**
3703 * A String[] holding e-mail addresses that should be delivered to.
3704 */
3705 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3706
3707 /**
3708 * A String[] holding e-mail addresses that should be carbon copied.
3709 */
3710 public static final String EXTRA_CC = "android.intent.extra.CC";
3711
3712 /**
3713 * A String[] holding e-mail addresses that should be blind carbon copied.
3714 */
3715 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3716
3717 /**
3718 * A constant string holding the desired subject line of a message.
3719 */
3720 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3721
3722 /**
3723 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003724 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003725 */
3726 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3727
3728 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003729 * An int representing the user id to be used.
3730 *
3731 * @hide
3732 */
3733 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3734
3735 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003736 * An int representing the task id to be retrieved. This is used when a launch from recents is
3737 * intercepted by another action such as credentials confirmation to remember which task should
3738 * be resumed when complete.
3739 *
3740 * @hide
3741 */
3742 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3743
3744 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003745 * An Intent[] describing additional, alternate choices you would like shown with
3746 * {@link #ACTION_CHOOSER}.
3747 *
3748 * <p>An app may be capable of providing several different payload types to complete a
3749 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3750 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3751 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3752 * photo data or a hosted link where the photos can be viewed.</p>
3753 *
3754 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3755 * first/primary/preferred intent in the set. Additional intents specified in
3756 * this extra are ordered; by default intents that appear earlier in the array will be
3757 * preferred over intents that appear later in the array as matches for the same
3758 * target component. To alter this preference, a calling app may also supply
3759 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3760 */
3761 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3762
3763 /**
Adam Powell52c39212016-04-07 15:14:18 -07003764 * A {@link ComponentName ComponentName[]} describing components that should be filtered out
3765 * and omitted from a list of components presented to the user.
3766 *
3767 * <p>When used with {@link #ACTION_CHOOSER}, the chooser will omit any of the components
3768 * in this array if it otherwise would have shown them. Useful for omitting specific targets
3769 * from your own package or other apps from your organization if the idea of sending to those
3770 * targets would be redundant with other app functionality. Filtered components will not
3771 * be able to present targets from an associated <code>ChooserTargetService</code>.</p>
3772 */
3773 public static final String EXTRA_EXCLUDE_COMPONENTS
3774 = "android.intent.extra.EXCLUDE_COMPONENTS";
3775
3776 /**
3777 * A {@link android.service.chooser.ChooserTarget ChooserTarget[]} for {@link #ACTION_CHOOSER}
3778 * describing additional high-priority deep-link targets for the chooser to present to the user.
3779 *
3780 * <p>Targets provided in this way will be presented inline with all other targets provided
3781 * by services from other apps. They will be prioritized before other service targets, but
3782 * after those targets provided by sources that the user has manually pinned to the front.</p>
3783 *
3784 * @see #ACTION_CHOOSER
3785 */
3786 public static final String EXTRA_CHOOSER_TARGETS = "android.intent.extra.CHOOSER_TARGETS";
3787
3788 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003789 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3790 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3791 *
3792 * <p>An app preparing an action for another app to complete may wish to allow the user to
3793 * disambiguate between several options for completing the action based on the chosen target
3794 * or otherwise refine the action before it is invoked.
3795 * </p>
3796 *
3797 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3798 * <ul>
3799 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3800 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3801 * chosen target beyond the first</li>
3802 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3803 * should fill in and send once the disambiguation is complete</li>
3804 * </ul>
3805 */
3806 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3807 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3808
3809 /**
3810 * A {@link ResultReceiver} used to return data back to the sender.
3811 *
3812 * <p>Used to complete an app-specific
3813 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3814 *
3815 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3816 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3817 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3818 * when the user selects a target component from the chooser. It is up to the recipient
3819 * to send a result to this ResultReceiver to signal that disambiguation is complete
3820 * and that the chooser should invoke the user's choice.</p>
3821 *
3822 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3823 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3824 * to match and fill in the final Intent or ChooserTarget before starting it.
3825 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3826 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3827 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3828 *
3829 * <p>The result code passed to the ResultReceiver should be
3830 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3831 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3832 * the chooser should finish without starting a target.</p>
3833 */
3834 public static final String EXTRA_RESULT_RECEIVER
3835 = "android.intent.extra.RESULT_RECEIVER";
3836
3837 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003838 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003839 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 */
3841 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3842
3843 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003844 * A Parcelable[] of {@link Intent} or
3845 * {@link android.content.pm.LabeledIntent} objects as set with
3846 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3847 * a the front of the list of choices, when shown to the user with a
3848 * {@link #ACTION_CHOOSER}.
3849 */
3850 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3851
3852 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003853 * A {@link IntentSender} to start after ephemeral installation success.
3854 * @hide
3855 */
3856 @SystemApi
3857 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3858
3859 /**
3860 * A {@link IntentSender} to start after ephemeral installation failure.
3861 * @hide
3862 */
3863 @SystemApi
3864 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3865
3866 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003867 * A Bundle forming a mapping of potential target package names to different extras Bundles
3868 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3869 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3870 * be currently installed on the device.
3871 *
3872 * <p>An application may choose to provide alternate extras for the case where a user
3873 * selects an activity from a predetermined set of target packages. If the activity
3874 * the user selects from the chooser belongs to a package with its package name as
3875 * a key in this bundle, the corresponding extras for that package will be merged with
3876 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3877 * extra has the same key as an extra already present in the intent it will overwrite
3878 * the extra from the intent.</p>
3879 *
3880 * <p><em>Examples:</em>
3881 * <ul>
3882 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3883 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3884 * parameters for that target.</li>
3885 * <li>An application may offer additional metadata for known targets of a given intent
3886 * to pass along information only relevant to that target such as account or content
3887 * identifiers already known to that application.</li>
3888 * </ul></p>
3889 */
3890 public static final String EXTRA_REPLACEMENT_EXTRAS =
3891 "android.intent.extra.REPLACEMENT_EXTRAS";
3892
3893 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003894 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3895 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3896 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3897 * {@link ComponentName} of the chosen component.
3898 *
3899 * <p>In some situations this callback may never come, for example if the user abandons
3900 * the chooser, switches to another task or any number of other reasons. Apps should not
3901 * be written assuming that this callback will always occur.</p>
3902 */
3903 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3904 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3905
3906 /**
3907 * The {@link ComponentName} chosen by the user to complete an action.
3908 *
3909 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3910 */
3911 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3912
3913 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003914 * A {@link android.view.KeyEvent} object containing the event that
3915 * triggered the creation of the Intent it is in.
3916 */
3917 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3918
3919 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003920 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3921 * before shutting down.
3922 *
3923 * {@hide}
3924 */
3925 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3926
3927 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003928 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3929 * requested by the user.
3930 *
3931 * {@hide}
3932 */
3933 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3934 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3935
3936 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003937 * 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 -07003938 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3939 * of restarting the application.
3940 */
3941 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3942
3943 /**
3944 * A String holding the phone number originally entered in
3945 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3946 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3947 */
3948 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003949
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003950 /**
3951 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3952 * intents to supply the uid the package had been assigned. Also an optional
3953 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3954 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3955 * purpose.
3956 */
3957 public static final String EXTRA_UID = "android.intent.extra.UID";
3958
3959 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003960 * @hide String array of package names.
3961 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003962 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003963 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3964
3965 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003966 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3967 * intents to indicate whether this represents a full uninstall (removing
3968 * both the code and its data) or a partial uninstall (leaving its data,
3969 * implying that this is an update).
3970 */
3971 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003972
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003973 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003974 * @hide
3975 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3976 * intents to indicate that at this point the package has been removed for
3977 * all users on the device.
3978 */
3979 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3980 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3981
3982 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003983 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3984 * intents to indicate that this is a replacement of the package, so this
3985 * broadcast will immediately be followed by an add broadcast for a
3986 * different version of the same package.
3987 */
3988 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003989
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003990 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003991 * Used as an int extra field in {@link android.app.AlarmManager} intents
3992 * to tell the application being invoked how many pending alarms are being
3993 * delievered with the intent. For one-shot alarms this will always be 1.
3994 * For recurring alarms, this might be greater than 1 if the device was
3995 * asleep or powered off at the time an earlier alarm would have been
3996 * delivered.
3997 */
3998 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003999
Jacek Surazski86b6c532009-05-13 14:38:28 +02004000 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004001 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
4002 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07004003 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
4004 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004005 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
4006 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
4007 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004008 */
4009 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
4010
4011 /**
4012 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4013 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004014 */
4015 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
4016
4017 /**
4018 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4019 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004020 */
4021 public static final int EXTRA_DOCK_STATE_DESK = 1;
4022
4023 /**
4024 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4025 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05004026 */
4027 public static final int EXTRA_DOCK_STATE_CAR = 2;
4028
4029 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05004030 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4031 * to represent that the phone is in a analog (low end) dock.
4032 */
4033 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
4034
4035 /**
4036 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
4037 * to represent that the phone is in a digital (high end) dock.
4038 */
4039 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
4040
4041 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004042 * Boolean that can be supplied as meta-data with a dock activity, to
4043 * indicate that the dock should take over the home key when it is active.
4044 */
4045 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08004046
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004047 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02004048 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
4049 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02004050 */
4051 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
4052
4053 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07004054 * Used in the extra field in the remote intent. It's astring token passed with the
4055 * remote intent.
4056 */
4057 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4058 "android.intent.extra.remote_intent_token";
4059
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004060 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004061 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004062 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004063 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004064 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004065 "android.intent.extra.changed_component_name";
4066
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004067 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004068 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004069 * and contains a string array of all of the components that have changed. If
4070 * the state of the overall package has changed, then it will contain an entry
4071 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004072 */
4073 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4074 "android.intent.extra.changed_component_name_list";
4075
4076 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004077 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004078 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004079 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4080 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4081 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004082 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004083 */
4084 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4085 "android.intent.extra.changed_package_list";
4086
4087 /**
4088 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004089 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4090 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004091 * and contains an integer array of uids of all of the components
4092 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004093 */
4094 public static final String EXTRA_CHANGED_UID_LIST =
4095 "android.intent.extra.changed_uid_list";
4096
4097 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004098 * @hide
4099 * Magic extra system code can use when binding, to give a label for
4100 * who it is that has bound to a service. This is an integer giving
4101 * a framework string resource that can be displayed to the user.
4102 */
4103 public static final String EXTRA_CLIENT_LABEL =
4104 "android.intent.extra.client_label";
4105
4106 /**
4107 * @hide
4108 * Magic extra system code can use when binding, to give a PendingIntent object
4109 * that can be launched for the user to disable the system's use of this
4110 * service.
4111 */
4112 public static final String EXTRA_CLIENT_INTENT =
4113 "android.intent.extra.client_intent";
4114
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004115 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004116 * Extra used to indicate that an intent should only return data that is on
4117 * the local device. This is a boolean extra; the default is false. If true,
4118 * an implementation should only allow the user to select data that is
4119 * already on the device, not requiring it be downloaded from a remote
4120 * service when opened.
4121 *
4122 * @see #ACTION_GET_CONTENT
4123 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004124 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004125 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004126 */
4127 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004128 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004129
Amith Yamasani13593602012-03-22 16:16:17 -07004130 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004131 * Extra used to indicate that an intent can allow the user to select and
4132 * return multiple items. This is a boolean extra; the default is false. If
4133 * true, an implementation is allowed to present the user with a UI where
4134 * they can pick multiple items that are all returned to the caller. When
4135 * this happens, they should be returned as the {@link #getClipData()} part
4136 * of the result Intent.
4137 *
4138 * @see #ACTION_GET_CONTENT
4139 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004140 */
4141 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004142 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004143
4144 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004145 * The integer userHandle carried with broadcast intents related to addition, removal and
4146 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4147 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4148 *
Amith Yamasani13593602012-03-22 16:16:17 -07004149 * @hide
4150 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004151 public static final String EXTRA_USER_HANDLE =
4152 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004153
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004154 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004155 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4156 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4157 */
4158 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004159 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004160
4161 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004162 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004163 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4164 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004165 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004166 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4167
4168 /**
4169 * Extra sent in the intent to the BroadcastReceiver that handles
4170 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4171 * the restrictions as key/value pairs.
4172 */
4173 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4174 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004175
Amith Yamasani86118ba2013-03-28 14:33:16 -07004176 /**
4177 * Extra used in the response from a BroadcastReceiver that handles
4178 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4179 */
4180 public static final String EXTRA_RESTRICTIONS_INTENT =
4181 "android.intent.extra.restrictions_intent";
4182
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004183 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004184 * Extra used to communicate a set of acceptable MIME types. The type of the
4185 * extra is {@code String[]}. Values may be a combination of concrete MIME
4186 * types (such as "image/png") and/or partial MIME types (such as
4187 * "audio/*").
4188 *
4189 * @see #ACTION_GET_CONTENT
4190 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004191 */
4192 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4193
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004194 /**
4195 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4196 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004197 * When this is true, hardware devices can use this information to determine that
4198 * they shouldn't do a complete shutdown of their device since this is not a
4199 * complete shutdown down to the kernel, but only user space restarting.
4200 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004201 */
4202 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4203 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4204
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004205 /**
4206 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4207 * user has set their time format preferences to the 24 hour format.
4208 *
4209 * @hide for internal use only.
4210 */
4211 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4212 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4213
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004214 /** {@hide} */
4215 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4216
Rubin Xue8490f12015-06-25 12:17:48 +01004217 /** {@hide} */
4218 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4219
Santos Cordon15a13782015-03-31 18:32:31 -07004220 /**
4221 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4222 * activation request.
4223 * TODO: Add information about the structure and response data used with the pending intent.
4224 * @hide
4225 */
4226 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4227 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4228
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004229 /**
4230 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004231 *
4232 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004233 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004234 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4235
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004236 /**
4237 * Optional boolean extra indicating whether quiet mode has been switched on or off.
Rubin Xue95057a2016-04-01 16:49:25 +01004238 * When a profile goes into quiet mode, all apps in the profile are killed and the
4239 * profile user is stopped. Widgets originating from the profile are masked, and app
4240 * launcher icons are grayed out.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004241 */
4242 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004243
4244 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004245 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004246 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004247 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4248 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004249 *
4250 * @hide
4251 */
4252 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4253 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4254
4255 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004256 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004257 * to represent that a video codec is allowed to use.
4258 *
4259 * @hide
4260 */
4261 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4262
4263 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004264 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004265 * to represent that a audio codec is allowed to use.
4266 *
4267 * @hide
4268 */
4269 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4270
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004271 // ---------------------------------------------------------------------
4272 // ---------------------------------------------------------------------
4273 // Intent flags (see mFlags variable).
4274
Tor Norbyed9273d62013-05-30 15:59:53 -07004275 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004276 @IntDef(flag = true, value = {
4277 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4278 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004279 @Retention(RetentionPolicy.SOURCE)
4280 public @interface GrantUriMode {}
4281
Jeff Sharkey846318a2014-04-04 12:12:41 -07004282 /** @hide */
4283 @IntDef(flag = true, value = {
4284 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4285 @Retention(RetentionPolicy.SOURCE)
4286 public @interface AccessUriMode {}
4287
4288 /**
4289 * Test if given mode flags specify an access mode, which must be at least
4290 * read and/or write.
4291 *
4292 * @hide
4293 */
4294 public static boolean isAccessUriMode(int modeFlags) {
4295 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4296 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4297 }
4298
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004299 /**
4300 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004301 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004302 * specified in its ClipData. When applying to an Intent's ClipData,
4303 * all URIs as well as recursive traversals through data or other ClipData
4304 * in Intent items will be granted; only the grant flags of the top-level
4305 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004306 */
4307 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4308 /**
4309 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004310 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004311 * specified in its ClipData. When applying to an Intent's ClipData,
4312 * all URIs as well as recursive traversals through data or other ClipData
4313 * in Intent items will be granted; only the grant flags of the top-level
4314 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004315 */
4316 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4317 /**
4318 * Can be set by the caller to indicate that this Intent is coming from
4319 * a background operation, not from direct user interaction.
4320 */
4321 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4322 /**
4323 * A flag you can enable for debugging: when set, log messages will be
4324 * printed during the resolution of this intent to show you what has
4325 * been found to create the final resolved list.
4326 */
4327 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004328 /**
4329 * If set, this intent will not match any components in packages that
4330 * are currently stopped. If this is not set, then the default behavior
4331 * is to include such applications in the result.
4332 */
4333 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4334 /**
4335 * If set, this intent will always match any components in packages that
4336 * are currently stopped. This is the default behavior when
4337 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4338 * flags are set, this one wins (it allows overriding of exclude for
4339 * places where the framework may automatically set the exclude flag).
4340 */
4341 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004342
4343 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004344 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004345 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004346 * persisted across device reboots until explicitly revoked with
4347 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4348 * grant for possible persisting; the receiving application must call
4349 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4350 * actually persist.
4351 *
4352 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4353 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4354 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004355 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004356 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004357 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004358
4359 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004360 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4361 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4362 * applies to any URI that is a prefix match against the original granted
4363 * URI. (Without this flag, the URI must match exactly for access to be
4364 * granted.) Another URI is considered a prefix match only when scheme,
4365 * authority, and all path segments defined by the prefix are an exact
4366 * match.
4367 */
4368 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4369
4370 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004371 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004372 * homework and verified that they correctly handle packages and components
4373 * that come and go over time. In particular:
4374 * <ul>
4375 * <li>Apps installed on external storage, which will appear to be
4376 * uninstalled while the the device is ejected.
4377 * <li>Apps with encryption unaware components, which will appear to not
4378 * exist while the device is locked.
4379 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004380 *
4381 * @hide
4382 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004383 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004384
4385 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004386 * If set, the new activity is not kept in the history stack. As soon as
4387 * the user navigates away from it, the activity is finished. This may also
4388 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4389 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004390 *
4391 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4392 * is never invoked when the current activity starts a new activity which
4393 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004394 */
4395 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4396 /**
4397 * If set, the activity will not be launched if it is already running
4398 * at the top of the history stack.
4399 */
4400 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4401 /**
4402 * If set, this activity will become the start of a new task on this
4403 * history stack. A task (from the activity that started it to the
4404 * next task activity) defines an atomic group of activities that the
4405 * user can move to. Tasks can be moved to the foreground and background;
4406 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004407 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004408 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4409 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004410 *
4411 * <p>This flag is generally used by activities that want
4412 * to present a "launcher" style behavior: they give the user a list of
4413 * separate things that can be done, which otherwise run completely
4414 * independently of the activity launching them.
4415 *
4416 * <p>When using this flag, if a task is already running for the activity
4417 * you are now starting, then a new activity will not be started; instead,
4418 * the current task will simply be brought to the front of the screen with
4419 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4420 * to disable this behavior.
4421 *
4422 * <p>This flag can not be used when the caller is requesting a result from
4423 * the activity being launched.
4424 */
4425 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4426 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004427 * This flag is used to create a new task and launch an activity into it.
4428 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4429 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4430 * search through existing tasks for ones matching this Intent. Only if no such
4431 * task is found would a new task be created. When paired with
4432 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4433 * the search for a matching task and unconditionally start a new task.
4434 *
4435 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4436 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004437 * top-level application launcher.</strong> Used in conjunction with
4438 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4439 * behavior of bringing an existing task to the foreground. When set,
4440 * a new task is <em>always</em> started to host the Activity for the
4441 * Intent, regardless of whether there is already an existing task running
4442 * the same thing.
4443 *
4444 * <p><strong>Because the default system does not include graphical task management,
4445 * you should not use this flag unless you provide some way for a user to
4446 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004447 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004448 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4449 * creating new document tasks.
4450 *
4451 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004452 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004453 *
Scott Main7aee61f2011-02-08 11:25:01 -08004454 * <p>See
4455 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4456 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004457 *
4458 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4459 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004460 */
4461 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4462 /**
4463 * If set, and the activity being launched is already running in the
4464 * current task, then instead of launching a new instance of that activity,
4465 * all of the other activities on top of it will be closed and this Intent
4466 * will be delivered to the (now on top) old activity as a new Intent.
4467 *
4468 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4469 * If D calls startActivity() with an Intent that resolves to the component
4470 * of activity B, then C and D will be finished and B receive the given
4471 * Intent, resulting in the stack now being: A, B.
4472 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004473 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004474 * either receive the new intent you are starting here in its
4475 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004476 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004477 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4478 * the same intent, then it will be finished and re-created; for all other
4479 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4480 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004481 *
4482 * <p>This launch mode can also be used to good effect in conjunction with
4483 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4484 * of a task, it will bring any currently running instance of that task
4485 * to the foreground, and then clear it to its root state. This is
4486 * especially useful, for example, when launching an activity from the
4487 * notification manager.
4488 *
Scott Main7aee61f2011-02-08 11:25:01 -08004489 * <p>See
4490 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4491 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004492 */
4493 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4494 /**
4495 * If set and this intent is being used to launch a new activity from an
4496 * existing one, then the reply target of the existing activity will be
4497 * transfered to the new activity. This way the new activity can call
4498 * {@link android.app.Activity#setResult} and have that result sent back to
4499 * the reply target of the original activity.
4500 */
4501 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4502 /**
4503 * If set and this intent is being used to launch a new activity from an
4504 * existing one, the current activity will not be counted as the top
4505 * activity for deciding whether the new intent should be delivered to
4506 * the top instead of starting a new one. The previous activity will
4507 * be used as the top, with the assumption being that the current activity
4508 * will finish itself immediately.
4509 */
4510 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4511 /**
4512 * If set, the new activity is not kept in the list of recently launched
4513 * activities.
4514 */
4515 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4516 /**
4517 * This flag is not normally set by application code, but set for you by
4518 * the system as described in the
4519 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4520 * launchMode} documentation for the singleTask mode.
4521 */
4522 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4523 /**
4524 * If set, and this activity is either being started in a new task or
4525 * bringing to the top an existing task, then it will be launched as
4526 * the front door of the task. This will result in the application of
4527 * any affinities needed to have that task in the proper state (either
4528 * moving activities to or from it), or simply resetting that task to
4529 * its initial state if needed.
4530 */
4531 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4532 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004533 * This flag is not normally set by application code, but set for you by
4534 * the system if this activity is being launched from history
4535 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004536 */
4537 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004538 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004539 * @deprecated As of API 21 this performs identically to
4540 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004541 */
4542 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004543 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004544 * This flag is used to open a document into a new task rooted at the activity launched
4545 * by this Intent. Through the use of this flag, or its equivalent attribute,
4546 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004547 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004548 *
Craig Mautner026596b2014-05-21 15:35:44 -07004549 * <p>The use of the activity attribute form of this,
4550 * {@link android.R.attr#documentLaunchMode}, is
4551 * preferred over the Intent flag described here. The attribute form allows the
4552 * Activity to specify multiple document behavior for all launchers of the Activity
4553 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004554 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004555 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4556 * it is kept after the activity is finished is different than the use of
4557 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4558 * this flag is being used to create a new recents entry, then by default that entry
4559 * will be removed once the activity is finished. You can modify this behavior with
4560 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4561 *
Craig Mautner026596b2014-05-21 15:35:44 -07004562 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4563 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4564 * equivalent of the Activity manifest specifying {@link
4565 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4566 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4567 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004568 *
Craig Mautner026596b2014-05-21 15:35:44 -07004569 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004570 *
Craig Mautner026596b2014-05-21 15:35:44 -07004571 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004572 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4573 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004574 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004575 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004576 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004577 * callback from occurring on the current frontmost activity before it is
4578 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004579 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004580 * <p>Typically, an activity can rely on that callback to indicate that an
4581 * explicit user action has caused their activity to be moved out of the
4582 * foreground. The callback marks an appropriate point in the activity's
4583 * lifecycle for it to dismiss any notifications that it intends to display
4584 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004585 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004586 * <p>If an activity is ever started via any non-user-driven events such as
4587 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4588 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004589 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004590 */
4591 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004592 /**
4593 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4594 * this flag will cause the launched activity to be brought to the front of its
4595 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004596 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004597 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4598 * If D calls startActivity() with an Intent that resolves to the component
4599 * of activity B, then B will be brought to the front of the history stack,
4600 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004601 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004602 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004603 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004604 */
4605 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004606 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004607 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4608 * this flag will prevent the system from applying an activity transition
4609 * animation to go to the next activity state. This doesn't mean an
4610 * animation will never run -- if another activity change happens that doesn't
4611 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004612 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004613 * when you are going to do a series of activity operations but the
4614 * animation seen by the user shouldn't be driven by the first activity
4615 * change but rather a later one.
4616 */
4617 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4618 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004619 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4620 * this flag will cause any existing task that would be associated with the
4621 * activity to be cleared before the activity is started. That is, the activity
4622 * becomes the new root of an otherwise empty task, and any old activities
4623 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4624 */
4625 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4626 /**
4627 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4628 * this flag will cause a newly launching task to be placed on top of the current
4629 * home activity task (if there is one). That is, pressing back from the task
4630 * will always return the user to home even if that was not the last activity they
4631 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4632 */
4633 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4634 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004635 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4636 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004637 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004638 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004639 * this flag. When set and the task's activity is finished, the recents
4640 * entry will remain in the interface for the user to re-launch it, like a
4641 * recents entry for a top-level application.
4642 * <p>
4643 * The receiving activity can override this request with
4644 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4645 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004646 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004647 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004648 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004649
4650 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004651 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4652 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004653 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4654 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004655 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004656 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004657
4658 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004659 * If set, when sending a broadcast only registered receivers will be
4660 * called -- no BroadcastReceiver components will be launched.
4661 */
4662 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004663 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004664 * If set, when sending a broadcast the new broadcast will replace
4665 * any existing pending broadcast that matches it. Matching is defined
4666 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4667 * true for the intents of the two broadcasts. When a match is found,
4668 * the new broadcast (and receivers associated with it) will replace the
4669 * existing one in the pending broadcast list, remaining at the same
4670 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004671 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004672 * <p>This flag is most typically used with sticky broadcasts, which
4673 * only care about delivering the most recent values of the broadcast
4674 * to their receivers.
4675 */
4676 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4677 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004678 * If set, when sending a broadcast the recipient is allowed to run at
4679 * foreground priority, with a shorter timeout interval. During normal
4680 * broadcasts the receivers are not automatically hoisted out of the
4681 * background priority class.
4682 */
4683 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4684 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004685 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4686 * They can still propagate results through to later receivers, but they can not prevent
4687 * later receivers from seeing the broadcast.
4688 */
4689 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4690 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004691 * If set, when sending a broadcast <i>before boot has completed</i> only
4692 * registered receivers will be called -- no BroadcastReceiver components
4693 * will be launched. Sticky intent state will be recorded properly even
4694 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4695 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004696 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004697 * <p>This flag is only for use by system sevices as a convenience to
4698 * avoid having to implement a more complex mechanism around detection
4699 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004700 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004701 * @hide
4702 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004703 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004704 /**
4705 * Set when this broadcast is for a boot upgrade, a special mode that
4706 * allows the broadcast to be sent before the system is ready and launches
4707 * the app process with no providers running in it.
4708 * @hide
4709 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004710 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004711 /**
4712 * If set, the broadcast will always go to manifest receivers in background (cached
4713 * or not running) apps, regardless of whether that would be done by default. By
4714 * default they will only receive broadcasts if the broadcast has specified an
4715 * explicit component or package name.
4716 * @hide
4717 */
4718 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4719 /**
4720 * If set, the broadcast will never go to manifest receivers in background (cached
4721 * or not running) apps, regardless of whether that would be done by default. By
4722 * default they will receive broadcasts if the broadcast has specified an
4723 * explicit component or package name.
4724 * @hide
4725 */
4726 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004727
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004728 /**
4729 * @hide Flags that can't be changed with PendingIntent.
4730 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004731 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4732 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4733 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004734
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004735 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004736 // ---------------------------------------------------------------------
4737 // toUri() and parseUri() options.
4738
4739 /**
4740 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4741 * always has the "intent:" scheme. This syntax can be used when you want
4742 * to later disambiguate between URIs that are intended to describe an
4743 * Intent vs. all others that should be treated as raw URIs. When used
4744 * with {@link #parseUri}, any other scheme will result in a generic
4745 * VIEW action for that raw URI.
4746 */
4747 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004748
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004749 /**
4750 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4751 * always has the "android-app:" scheme. This is a variation of
4752 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4753 * http/https URI being delivered to a specific package name. The format
4754 * is:
4755 *
4756 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004757 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004758 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004759 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4760 * you must also include a scheme; including a path also requires both a host and a scheme.
4761 * The final #Intent; fragment can be used without a scheme, host, or path.
4762 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004763 * used with intents that have a {@link #setSelector}, since the base intent
4764 * will always have an explicit package name.</p>
4765 *
4766 * <p>Some examples of how this scheme maps to Intent objects:</p>
4767 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4768 * <colgroup align="left" />
4769 * <colgroup align="left" />
4770 * <thead>
4771 * <tr><th>URI</th> <th>Intent</th></tr>
4772 * </thead>
4773 *
4774 * <tbody>
4775 * <tr><td><code>android-app://com.example.app</code></td>
4776 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4777 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4778 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4779 * </table></td>
4780 * </tr>
4781 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4782 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4783 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4784 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4785 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4786 * </table></td>
4787 * </tr>
4788 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4789 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4790 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4791 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4792 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4793 * </table></td>
4794 * </tr>
4795 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4796 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4797 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4798 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4799 * </table></td>
4800 * </tr>
4801 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4802 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4803 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4804 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4805 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4806 * </table></td>
4807 * </tr>
4808 * <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>
4809 * <td><table border="" style="margin:0" >
4810 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4811 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4812 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4813 * </table></td>
4814 * </tr>
4815 * </tbody>
4816 * </table>
4817 */
4818 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4819
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004820 /**
4821 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4822 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4823 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4824 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4825 * generated Intent can not cause unexpected data access to happen.
4826 *
4827 * <p>If you do not trust the source of the URI being parsed, you should still do further
4828 * processing to protect yourself from it. In particular, when using it to start an
4829 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4830 * that can handle it.</p>
4831 */
4832 public static final int URI_ALLOW_UNSAFE = 1<<2;
4833
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004834 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004835
4836 private String mAction;
4837 private Uri mData;
4838 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004839 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004840 private ComponentName mComponent;
4841 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004842 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004843 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004844 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004845 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004846 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004847 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004848
4849 // ---------------------------------------------------------------------
4850
4851 /**
4852 * Create an empty intent.
4853 */
4854 public Intent() {
4855 }
4856
4857 /**
4858 * Copy constructor.
4859 */
4860 public Intent(Intent o) {
4861 this.mAction = o.mAction;
4862 this.mData = o.mData;
4863 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004864 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004865 this.mComponent = o.mComponent;
4866 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004867 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004868 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004869 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004870 }
4871 if (o.mExtras != null) {
4872 this.mExtras = new Bundle(o.mExtras);
4873 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004874 if (o.mSourceBounds != null) {
4875 this.mSourceBounds = new Rect(o.mSourceBounds);
4876 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004877 if (o.mSelector != null) {
4878 this.mSelector = new Intent(o.mSelector);
4879 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004880 if (o.mClipData != null) {
4881 this.mClipData = new ClipData(o.mClipData);
4882 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004883 }
4884
4885 @Override
4886 public Object clone() {
4887 return new Intent(this);
4888 }
4889
4890 private Intent(Intent o, boolean all) {
4891 this.mAction = o.mAction;
4892 this.mData = o.mData;
4893 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004894 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004895 this.mComponent = o.mComponent;
4896 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004897 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004898 }
4899 }
4900
4901 /**
4902 * Make a clone of only the parts of the Intent that are relevant for
4903 * filter matching: the action, data, type, component, and categories.
4904 */
4905 public Intent cloneFilter() {
4906 return new Intent(this, false);
4907 }
4908
4909 /**
4910 * Create an intent with a given action. All other fields (data, type,
4911 * class) are null. Note that the action <em>must</em> be in a
4912 * namespace because Intents are used globally in the system -- for
4913 * example the system VIEW action is android.intent.action.VIEW; an
4914 * application's custom action would be something like
4915 * com.google.app.myapp.CUSTOM_ACTION.
4916 *
4917 * @param action The Intent action, such as ACTION_VIEW.
4918 */
4919 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004920 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004921 }
4922
4923 /**
4924 * Create an intent with a given action and for a given data url. Note
4925 * that the action <em>must</em> be in a namespace because Intents are
4926 * used globally in the system -- for example the system VIEW action is
4927 * android.intent.action.VIEW; an application's custom action would be
4928 * something like com.google.app.myapp.CUSTOM_ACTION.
4929 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004930 * <p><em>Note: scheme and host name matching in the Android framework is
4931 * case-sensitive, unlike the formal RFC. As a result,
4932 * you should always ensure that you write your Uri with these elements
4933 * using lower case letters, and normalize any Uris you receive from
4934 * outside of Android to ensure the scheme and host is lower case.</em></p>
4935 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004936 * @param action The Intent action, such as ACTION_VIEW.
4937 * @param uri The Intent data URI.
4938 */
4939 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004940 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004941 mData = uri;
4942 }
4943
4944 /**
4945 * Create an intent for a specific component. All other fields (action, data,
4946 * type, class) are null, though they can be modified later with explicit
4947 * calls. This provides a convenient way to create an intent that is
4948 * intended to execute a hard-coded class name, rather than relying on the
4949 * system to find an appropriate class for you; see {@link #setComponent}
4950 * for more information on the repercussions of this.
4951 *
4952 * @param packageContext A Context of the application package implementing
4953 * this class.
4954 * @param cls The component class that is to be used for the intent.
4955 *
4956 * @see #setClass
4957 * @see #setComponent
4958 * @see #Intent(String, android.net.Uri , Context, Class)
4959 */
4960 public Intent(Context packageContext, Class<?> cls) {
4961 mComponent = new ComponentName(packageContext, cls);
4962 }
4963
4964 /**
4965 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004966 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004967 * construct the Intent and then calling {@link #setClass} to set its
4968 * class.
4969 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004970 * <p><em>Note: scheme and host name matching in the Android framework is
4971 * case-sensitive, unlike the formal RFC. As a result,
4972 * you should always ensure that you write your Uri with these elements
4973 * using lower case letters, and normalize any Uris you receive from
4974 * outside of Android to ensure the scheme and host is lower case.</em></p>
4975 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004976 * @param action The Intent action, such as ACTION_VIEW.
4977 * @param uri The Intent data URI.
4978 * @param packageContext A Context of the application package implementing
4979 * this class.
4980 * @param cls The component class that is to be used for the intent.
4981 *
4982 * @see #Intent(String, android.net.Uri)
4983 * @see #Intent(Context, Class)
4984 * @see #setClass
4985 * @see #setComponent
4986 */
4987 public Intent(String action, Uri uri,
4988 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004989 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004990 mData = uri;
4991 mComponent = new ComponentName(packageContext, cls);
4992 }
4993
4994 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004995 * Create an intent to launch the main (root) activity of a task. This
4996 * is the Intent that is started when the application's is launched from
4997 * Home. For anything else that wants to launch an application in the
4998 * same way, it is important that they use an Intent structured the same
4999 * way, and can use this function to ensure this is the case.
5000 *
5001 * <p>The returned Intent has the given Activity component as its explicit
5002 * component, {@link #ACTION_MAIN} as its action, and includes the
5003 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5004 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5005 * to do that through {@link #addFlags(int)} on the returned Intent.
5006 *
5007 * @param mainActivity The main activity component that this Intent will
5008 * launch.
5009 * @return Returns a newly created Intent that can be used to launch the
5010 * activity as a main application entry.
5011 *
5012 * @see #setClass
5013 * @see #setComponent
5014 */
5015 public static Intent makeMainActivity(ComponentName mainActivity) {
5016 Intent intent = new Intent(ACTION_MAIN);
5017 intent.setComponent(mainActivity);
5018 intent.addCategory(CATEGORY_LAUNCHER);
5019 return intent;
5020 }
5021
5022 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005023 * Make an Intent for the main activity of an application, without
5024 * specifying a specific activity to run but giving a selector to find
5025 * the activity. This results in a final Intent that is structured
5026 * the same as when the application is launched from
5027 * Home. For anything else that wants to launch an application in the
5028 * same way, it is important that they use an Intent structured the same
5029 * way, and can use this function to ensure this is the case.
5030 *
5031 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
5032 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
5033 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
5034 * to do that through {@link #addFlags(int)} on the returned Intent.
5035 *
5036 * @param selectorAction The action name of the Intent's selector.
5037 * @param selectorCategory The name of a category to add to the Intent's
5038 * selector.
5039 * @return Returns a newly created Intent that can be used to launch the
5040 * activity as a main application entry.
5041 *
5042 * @see #setSelector(Intent)
5043 */
5044 public static Intent makeMainSelectorActivity(String selectorAction,
5045 String selectorCategory) {
5046 Intent intent = new Intent(ACTION_MAIN);
5047 intent.addCategory(CATEGORY_LAUNCHER);
5048 Intent selector = new Intent();
5049 selector.setAction(selectorAction);
5050 selector.addCategory(selectorCategory);
5051 intent.setSelector(selector);
5052 return intent;
5053 }
5054
5055 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08005056 * Make an Intent that can be used to re-launch an application's task
5057 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
5058 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
5059 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
5060 *
5061 * @param mainActivity The activity component that is the root of the
5062 * task; this is the activity that has been published in the application's
5063 * manifest as the main launcher icon.
5064 *
5065 * @return Returns a newly created Intent that can be used to relaunch the
5066 * activity's task in its root state.
5067 */
5068 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5069 Intent intent = makeMainActivity(mainActivity);
5070 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5071 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5072 return intent;
5073 }
5074
5075 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005076 * Call {@link #parseUri} with 0 flags.
5077 * @deprecated Use {@link #parseUri} instead.
5078 */
5079 @Deprecated
5080 public static Intent getIntent(String uri) throws URISyntaxException {
5081 return parseUri(uri, 0);
5082 }
Tom Taylord4a47292009-12-21 13:59:18 -08005083
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005084 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005085 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005086 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005087 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005088 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089 *
5090 * <p>The URI given here must not be relative -- that is, it must include
5091 * the scheme and full path.
5092 *
5093 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005094 * @param flags Additional processing flags. Either 0,
5095 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005096 *
5097 * @return Intent The newly created Intent object.
5098 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005099 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5100 * it bad (as parsed by the Uri class) or the Intent data within the
5101 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005102 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005103 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005104 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005105 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 int i = 0;
5107 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005108 final boolean androidApp = uri.startsWith("android-app:");
5109
5110 // Validate intent scheme if requested.
5111 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5112 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005113 Intent intent = new Intent(ACTION_VIEW);
5114 try {
5115 intent.setData(Uri.parse(uri));
5116 } catch (IllegalArgumentException e) {
5117 throw new URISyntaxException(uri, e.getMessage());
5118 }
5119 return intent;
5120 }
5121 }
Tom Taylord4a47292009-12-21 13:59:18 -08005122
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005123 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005124 // simple case
5125 if (i == -1) {
5126 if (!androidApp) {
5127 return new Intent(ACTION_VIEW, Uri.parse(uri));
5128 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005129
5130 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005131 } else if (!uri.startsWith("#Intent;", i)) {
5132 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005133 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005134 } else {
5135 i = -1;
5136 }
5137 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005138
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005139 // new format
5140 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005141 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005142 boolean explicitAction = false;
5143 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005144
5145 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005146 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005147 String data;
5148 if (i >= 0) {
5149 data = uri.substring(0, i);
5150 i += 8; // length of "#Intent;"
5151 } else {
5152 data = uri;
5153 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005154
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005155 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005156 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005157 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005158 if (eq < 0) eq = i-1;
5159 int semi = uri.indexOf(';', i);
5160 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005161
5162 // action
5163 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005164 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005165 if (!inSelector) {
5166 explicitAction = true;
5167 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005168 }
5169
5170 // categories
5171 else if (uri.startsWith("category=", i)) {
5172 intent.addCategory(value);
5173 }
5174
5175 // type
5176 else if (uri.startsWith("type=", i)) {
5177 intent.mType = value;
5178 }
5179
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005180 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005181 else if (uri.startsWith("launchFlags=", i)) {
5182 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005183 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5184 intent.mFlags &= ~IMMUTABLE_FLAGS;
5185 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005186 }
5187
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005188 // package
5189 else if (uri.startsWith("package=", i)) {
5190 intent.mPackage = value;
5191 }
5192
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005193 // component
5194 else if (uri.startsWith("component=", i)) {
5195 intent.mComponent = ComponentName.unflattenFromString(value);
5196 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005197
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005198 // scheme
5199 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005200 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005201 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005202 } else {
5203 scheme = value;
5204 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005205 }
5206
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005207 // source bounds
5208 else if (uri.startsWith("sourceBounds=", i)) {
5209 intent.mSourceBounds = Rect.unflattenFromString(value);
5210 }
5211
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005212 // selector
5213 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5214 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005215 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005216 }
5217
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005218 // extra
5219 else {
5220 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005221 // create Bundle if it doesn't already exist
5222 if (intent.mExtras == null) intent.mExtras = new Bundle();
5223 Bundle b = intent.mExtras;
5224 // add EXTRA
5225 if (uri.startsWith("S.", i)) b.putString(key, value);
5226 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5227 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5228 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5229 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5230 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5231 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5232 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5233 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5234 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5235 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005236
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005237 // move to the next item
5238 i = semi + 1;
5239 }
5240
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005241 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005242 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005243 if (baseIntent.mPackage == null) {
5244 baseIntent.setSelector(intent);
5245 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005246 intent = baseIntent;
5247 }
5248
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005249 if (data != null) {
5250 if (data.startsWith("intent:")) {
5251 data = data.substring(7);
5252 if (scheme != null) {
5253 data = scheme + ':' + data;
5254 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005255 } else if (data.startsWith("android-app:")) {
5256 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5257 // Correctly formed android-app, first part is package name.
5258 int end = data.indexOf('/', 14);
5259 if (end < 0) {
5260 // All we have is a package name.
5261 intent.mPackage = data.substring(14);
5262 if (!explicitAction) {
5263 intent.setAction(ACTION_MAIN);
5264 }
5265 data = "";
5266 } else {
5267 // Target the Intent at the given package name always.
5268 String authority = null;
5269 intent.mPackage = data.substring(14, end);
5270 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005271 if ((end+1) < data.length()) {
5272 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5273 // Found a scheme, remember it.
5274 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005275 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005276 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5277 // Found a authority, remember it.
5278 authority = data.substring(end+1, newEnd);
5279 end = newEnd;
5280 }
5281 } else {
5282 // All we have is a scheme.
5283 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005284 }
5285 }
5286 if (scheme == null) {
5287 // If there was no scheme, then this just targets the package.
5288 if (!explicitAction) {
5289 intent.setAction(ACTION_MAIN);
5290 }
5291 data = "";
5292 } else if (authority == null) {
5293 data = scheme + ":";
5294 } else {
5295 data = scheme + "://" + authority + data.substring(end);
5296 }
5297 }
5298 } else {
5299 data = "";
5300 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005301 }
Tom Taylord4a47292009-12-21 13:59:18 -08005302
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005303 if (data.length() > 0) {
5304 try {
5305 intent.mData = Uri.parse(data);
5306 } catch (IllegalArgumentException e) {
5307 throw new URISyntaxException(uri, e.getMessage());
5308 }
5309 }
5310 }
Tom Taylord4a47292009-12-21 13:59:18 -08005311
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005312 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005313
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005314 } catch (IndexOutOfBoundsException e) {
5315 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5316 }
5317 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005318
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005319 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005320 return getIntentOld(uri, 0);
5321 }
5322
5323 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005324 Intent intent;
5325
5326 int i = uri.lastIndexOf('#');
5327 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005328 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005329 final int intentFragmentStart = i;
5330 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005331
5332 i++;
5333
5334 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005335 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005336 i += 7;
5337 int j = uri.indexOf(')', i);
5338 action = uri.substring(i, j);
5339 i = j + 1;
5340 }
5341
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005342 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005343
5344 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005345 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005346 i += 11;
5347 int j = uri.indexOf(')', i);
5348 while (i < j) {
5349 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005350 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005351 if (i < sep) {
5352 intent.addCategory(uri.substring(i, sep));
5353 }
5354 i = sep + 1;
5355 }
5356 i = j + 1;
5357 }
5358
5359 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005360 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005361 i += 5;
5362 int j = uri.indexOf(')', i);
5363 intent.mType = uri.substring(i, j);
5364 i = j + 1;
5365 }
5366
5367 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005368 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005369 i += 12;
5370 int j = uri.indexOf(')', i);
5371 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005372 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5373 intent.mFlags &= ~IMMUTABLE_FLAGS;
5374 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005375 i = j + 1;
5376 }
5377
5378 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005379 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005380 i += 10;
5381 int j = uri.indexOf(')', i);
5382 int sep = uri.indexOf('!', i);
5383 if (sep >= 0 && sep < j) {
5384 String pkg = uri.substring(i, sep);
5385 String cls = uri.substring(sep + 1, j);
5386 intent.mComponent = new ComponentName(pkg, cls);
5387 }
5388 i = j + 1;
5389 }
5390
5391 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005392 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005393 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 final int closeParen = uri.indexOf(')', i);
5396 if (closeParen == -1) throw new URISyntaxException(uri,
5397 "EXTRA missing trailing ')'", i);
5398
5399 while (i < closeParen) {
5400 // fetch the key value
5401 int j = uri.indexOf('=', i);
5402 if (j <= i + 1 || i >= closeParen) {
5403 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5404 }
5405 char type = uri.charAt(i);
5406 i++;
5407 String key = uri.substring(i, j);
5408 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005409
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005410 // get type-value
5411 j = uri.indexOf('!', i);
5412 if (j == -1 || j >= closeParen) j = closeParen;
5413 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5414 String value = uri.substring(i, j);
5415 i = j;
5416
5417 // create Bundle if it doesn't already exist
5418 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005420 // add item to bundle
5421 try {
5422 switch (type) {
5423 case 'S':
5424 intent.mExtras.putString(key, Uri.decode(value));
5425 break;
5426 case 'B':
5427 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5428 break;
5429 case 'b':
5430 intent.mExtras.putByte(key, Byte.parseByte(value));
5431 break;
5432 case 'c':
5433 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5434 break;
5435 case 'd':
5436 intent.mExtras.putDouble(key, Double.parseDouble(value));
5437 break;
5438 case 'f':
5439 intent.mExtras.putFloat(key, Float.parseFloat(value));
5440 break;
5441 case 'i':
5442 intent.mExtras.putInt(key, Integer.parseInt(value));
5443 break;
5444 case 'l':
5445 intent.mExtras.putLong(key, Long.parseLong(value));
5446 break;
5447 case 's':
5448 intent.mExtras.putShort(key, Short.parseShort(value));
5449 break;
5450 default:
5451 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5452 }
5453 } catch (NumberFormatException e) {
5454 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5455 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005456
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005457 char ch = uri.charAt(i);
5458 if (ch == ')') break;
5459 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5460 i++;
5461 }
5462 }
5463
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005464 if (isIntentFragment) {
5465 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5466 } else {
5467 intent.mData = Uri.parse(uri);
5468 }
Tom Taylord4a47292009-12-21 13:59:18 -08005469
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005470 if (intent.mAction == null) {
5471 // By default, if no action is specified, then use VIEW.
5472 intent.mAction = ACTION_VIEW;
5473 }
5474
5475 } else {
5476 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5477 }
5478
5479 return intent;
5480 }
5481
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005482 /** @hide */
5483 public interface CommandOptionHandler {
5484 boolean handleOption(String opt, ShellCommand cmd);
5485 }
5486
5487 /** @hide */
5488 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5489 throws URISyntaxException {
5490 Intent intent = new Intent();
5491 Intent baseIntent = intent;
5492 boolean hasIntentInfo = false;
5493
5494 Uri data = null;
5495 String type = null;
5496
5497 String opt;
5498 while ((opt=cmd.getNextOption()) != null) {
5499 switch (opt) {
5500 case "-a":
5501 intent.setAction(cmd.getNextArgRequired());
5502 if (intent == baseIntent) {
5503 hasIntentInfo = true;
5504 }
5505 break;
5506 case "-d":
5507 data = Uri.parse(cmd.getNextArgRequired());
5508 if (intent == baseIntent) {
5509 hasIntentInfo = true;
5510 }
5511 break;
5512 case "-t":
5513 type = cmd.getNextArgRequired();
5514 if (intent == baseIntent) {
5515 hasIntentInfo = true;
5516 }
5517 break;
5518 case "-c":
5519 intent.addCategory(cmd.getNextArgRequired());
5520 if (intent == baseIntent) {
5521 hasIntentInfo = true;
5522 }
5523 break;
5524 case "-e":
5525 case "--es": {
5526 String key = cmd.getNextArgRequired();
5527 String value = cmd.getNextArgRequired();
5528 intent.putExtra(key, value);
5529 }
5530 break;
5531 case "--esn": {
5532 String key = cmd.getNextArgRequired();
5533 intent.putExtra(key, (String) null);
5534 }
5535 break;
5536 case "--ei": {
5537 String key = cmd.getNextArgRequired();
5538 String value = cmd.getNextArgRequired();
5539 intent.putExtra(key, Integer.decode(value));
5540 }
5541 break;
5542 case "--eu": {
5543 String key = cmd.getNextArgRequired();
5544 String value = cmd.getNextArgRequired();
5545 intent.putExtra(key, Uri.parse(value));
5546 }
5547 break;
5548 case "--ecn": {
5549 String key = cmd.getNextArgRequired();
5550 String value = cmd.getNextArgRequired();
5551 ComponentName cn = ComponentName.unflattenFromString(value);
5552 if (cn == null)
5553 throw new IllegalArgumentException("Bad component name: " + value);
5554 intent.putExtra(key, cn);
5555 }
5556 break;
5557 case "--eia": {
5558 String key = cmd.getNextArgRequired();
5559 String value = cmd.getNextArgRequired();
5560 String[] strings = value.split(",");
5561 int[] list = new int[strings.length];
5562 for (int i = 0; i < strings.length; i++) {
5563 list[i] = Integer.decode(strings[i]);
5564 }
5565 intent.putExtra(key, list);
5566 }
5567 break;
5568 case "--eial": {
5569 String key = cmd.getNextArgRequired();
5570 String value = cmd.getNextArgRequired();
5571 String[] strings = value.split(",");
5572 ArrayList<Integer> list = new ArrayList<>(strings.length);
5573 for (int i = 0; i < strings.length; i++) {
5574 list.add(Integer.decode(strings[i]));
5575 }
5576 intent.putExtra(key, list);
5577 }
5578 break;
5579 case "--el": {
5580 String key = cmd.getNextArgRequired();
5581 String value = cmd.getNextArgRequired();
5582 intent.putExtra(key, Long.valueOf(value));
5583 }
5584 break;
5585 case "--ela": {
5586 String key = cmd.getNextArgRequired();
5587 String value = cmd.getNextArgRequired();
5588 String[] strings = value.split(",");
5589 long[] list = new long[strings.length];
5590 for (int i = 0; i < strings.length; i++) {
5591 list[i] = Long.valueOf(strings[i]);
5592 }
5593 intent.putExtra(key, list);
5594 hasIntentInfo = true;
5595 }
5596 break;
5597 case "--elal": {
5598 String key = cmd.getNextArgRequired();
5599 String value = cmd.getNextArgRequired();
5600 String[] strings = value.split(",");
5601 ArrayList<Long> list = new ArrayList<>(strings.length);
5602 for (int i = 0; i < strings.length; i++) {
5603 list.add(Long.valueOf(strings[i]));
5604 }
5605 intent.putExtra(key, list);
5606 hasIntentInfo = true;
5607 }
5608 break;
5609 case "--ef": {
5610 String key = cmd.getNextArgRequired();
5611 String value = cmd.getNextArgRequired();
5612 intent.putExtra(key, Float.valueOf(value));
5613 hasIntentInfo = true;
5614 }
5615 break;
5616 case "--efa": {
5617 String key = cmd.getNextArgRequired();
5618 String value = cmd.getNextArgRequired();
5619 String[] strings = value.split(",");
5620 float[] list = new float[strings.length];
5621 for (int i = 0; i < strings.length; i++) {
5622 list[i] = Float.valueOf(strings[i]);
5623 }
5624 intent.putExtra(key, list);
5625 hasIntentInfo = true;
5626 }
5627 break;
5628 case "--efal": {
5629 String key = cmd.getNextArgRequired();
5630 String value = cmd.getNextArgRequired();
5631 String[] strings = value.split(",");
5632 ArrayList<Float> list = new ArrayList<>(strings.length);
5633 for (int i = 0; i < strings.length; i++) {
5634 list.add(Float.valueOf(strings[i]));
5635 }
5636 intent.putExtra(key, list);
5637 hasIntentInfo = true;
5638 }
5639 break;
5640 case "--esa": {
5641 String key = cmd.getNextArgRequired();
5642 String value = cmd.getNextArgRequired();
5643 // Split on commas unless they are preceeded by an escape.
5644 // The escape character must be escaped for the string and
5645 // again for the regex, thus four escape characters become one.
5646 String[] strings = value.split("(?<!\\\\),");
5647 intent.putExtra(key, strings);
5648 hasIntentInfo = true;
5649 }
5650 break;
5651 case "--esal": {
5652 String key = cmd.getNextArgRequired();
5653 String value = cmd.getNextArgRequired();
5654 // Split on commas unless they are preceeded by an escape.
5655 // The escape character must be escaped for the string and
5656 // again for the regex, thus four escape characters become one.
5657 String[] strings = value.split("(?<!\\\\),");
5658 ArrayList<String> list = new ArrayList<>(strings.length);
5659 for (int i = 0; i < strings.length; i++) {
5660 list.add(strings[i]);
5661 }
5662 intent.putExtra(key, list);
5663 hasIntentInfo = true;
5664 }
5665 break;
5666 case "--ez": {
5667 String key = cmd.getNextArgRequired();
5668 String value = cmd.getNextArgRequired().toLowerCase();
5669 // Boolean.valueOf() results in false for anything that is not "true", which is
5670 // error-prone in shell commands
5671 boolean arg;
5672 if ("true".equals(value) || "t".equals(value)) {
5673 arg = true;
5674 } else if ("false".equals(value) || "f".equals(value)) {
5675 arg = false;
5676 } else {
5677 try {
5678 arg = Integer.decode(value) != 0;
5679 } catch (NumberFormatException ex) {
5680 throw new IllegalArgumentException("Invalid boolean value: " + value);
5681 }
5682 }
5683
5684 intent.putExtra(key, arg);
5685 }
5686 break;
5687 case "-n": {
5688 String str = cmd.getNextArgRequired();
5689 ComponentName cn = ComponentName.unflattenFromString(str);
5690 if (cn == null)
5691 throw new IllegalArgumentException("Bad component name: " + str);
5692 intent.setComponent(cn);
5693 if (intent == baseIntent) {
5694 hasIntentInfo = true;
5695 }
5696 }
5697 break;
5698 case "-p": {
5699 String str = cmd.getNextArgRequired();
5700 intent.setPackage(str);
5701 if (intent == baseIntent) {
5702 hasIntentInfo = true;
5703 }
5704 }
5705 break;
5706 case "-f":
5707 String str = cmd.getNextArgRequired();
5708 intent.setFlags(Integer.decode(str).intValue());
5709 break;
5710 case "--grant-read-uri-permission":
5711 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5712 break;
5713 case "--grant-write-uri-permission":
5714 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5715 break;
5716 case "--grant-persistable-uri-permission":
5717 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5718 break;
5719 case "--grant-prefix-uri-permission":
5720 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5721 break;
5722 case "--exclude-stopped-packages":
5723 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5724 break;
5725 case "--include-stopped-packages":
5726 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5727 break;
5728 case "--debug-log-resolution":
5729 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5730 break;
5731 case "--activity-brought-to-front":
5732 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5733 break;
5734 case "--activity-clear-top":
5735 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5736 break;
5737 case "--activity-clear-when-task-reset":
5738 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5739 break;
5740 case "--activity-exclude-from-recents":
5741 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5742 break;
5743 case "--activity-launched-from-history":
5744 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5745 break;
5746 case "--activity-multiple-task":
5747 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5748 break;
5749 case "--activity-no-animation":
5750 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5751 break;
5752 case "--activity-no-history":
5753 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5754 break;
5755 case "--activity-no-user-action":
5756 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5757 break;
5758 case "--activity-previous-is-top":
5759 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5760 break;
5761 case "--activity-reorder-to-front":
5762 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5763 break;
5764 case "--activity-reset-task-if-needed":
5765 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5766 break;
5767 case "--activity-single-top":
5768 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5769 break;
5770 case "--activity-clear-task":
5771 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5772 break;
5773 case "--activity-task-on-home":
5774 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5775 break;
5776 case "--receiver-registered-only":
5777 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5778 break;
5779 case "--receiver-replace-pending":
5780 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5781 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005782 case "--receiver-foreground":
5783 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5784 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005785 case "--selector":
5786 intent.setDataAndType(data, type);
5787 intent = new Intent();
5788 break;
5789 default:
5790 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5791 // Okay, caller handled this option.
5792 } else {
5793 throw new IllegalArgumentException("Unknown option: " + opt);
5794 }
5795 break;
5796 }
5797 }
5798 intent.setDataAndType(data, type);
5799
5800 final boolean hasSelector = intent != baseIntent;
5801 if (hasSelector) {
5802 // A selector was specified; fix up.
5803 baseIntent.setSelector(intent);
5804 intent = baseIntent;
5805 }
5806
5807 String arg = cmd.getNextArg();
5808 baseIntent = null;
5809 if (arg == null) {
5810 if (hasSelector) {
5811 // If a selector has been specified, and no arguments
5812 // have been supplied for the main Intent, then we can
5813 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5814 // need to have a component name specified yet, the
5815 // selector will take care of that.
5816 baseIntent = new Intent(Intent.ACTION_MAIN);
5817 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5818 }
5819 } else if (arg.indexOf(':') >= 0) {
5820 // The argument is a URI. Fully parse it, and use that result
5821 // to fill in any data not specified so far.
5822 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5823 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5824 } else if (arg.indexOf('/') >= 0) {
5825 // The argument is a component name. Build an Intent to launch
5826 // it.
5827 baseIntent = new Intent(Intent.ACTION_MAIN);
5828 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5829 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5830 } else {
5831 // Assume the argument is a package name.
5832 baseIntent = new Intent(Intent.ACTION_MAIN);
5833 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5834 baseIntent.setPackage(arg);
5835 }
5836 if (baseIntent != null) {
5837 Bundle extras = intent.getExtras();
5838 intent.replaceExtras((Bundle)null);
5839 Bundle uriExtras = baseIntent.getExtras();
5840 baseIntent.replaceExtras((Bundle)null);
5841 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5842 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5843 for (String c : cats) {
5844 baseIntent.removeCategory(c);
5845 }
5846 }
5847 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5848 if (extras == null) {
5849 extras = uriExtras;
5850 } else if (uriExtras != null) {
5851 uriExtras.putAll(extras);
5852 extras = uriExtras;
5853 }
5854 intent.replaceExtras(extras);
5855 hasIntentInfo = true;
5856 }
5857
5858 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5859 return intent;
5860 }
5861
5862 /** @hide */
5863 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5864 final String[] lines = new String[] {
5865 "<INTENT> specifications include these flags and arguments:",
5866 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5867 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5868 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5869 " [--esn <EXTRA_KEY> ...]",
5870 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5871 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5872 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5873 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5874 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5875 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5876 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5877 " (mutiple extras passed as Integer[])",
5878 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5879 " (mutiple extras passed as List<Integer>)",
5880 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5881 " (mutiple extras passed as Long[])",
5882 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5883 " (mutiple extras passed as List<Long>)",
5884 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5885 " (mutiple extras passed as Float[])",
5886 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5887 " (mutiple extras passed as List<Float>)",
5888 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5889 " (mutiple extras passed as String[]; to embed a comma into a string,",
5890 " escape it using \"\\,\")",
5891 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5892 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5893 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005894 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005895 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5896 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5897 " [--debug-log-resolution] [--exclude-stopped-packages]",
5898 " [--include-stopped-packages]",
5899 " [--activity-brought-to-front] [--activity-clear-top]",
5900 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5901 " [--activity-launched-from-history] [--activity-multiple-task]",
5902 " [--activity-no-animation] [--activity-no-history]",
5903 " [--activity-no-user-action] [--activity-previous-is-top]",
5904 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5905 " [--activity-single-top] [--activity-clear-task]",
5906 " [--activity-task-on-home]",
5907 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005908 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005909 " [--selector]",
5910 " [<URI> | <PACKAGE> | <COMPONENT>]"
5911 };
5912 for (String line : lines) {
5913 pw.print(prefix);
5914 pw.println(line);
5915 }
5916 }
5917
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005918 /**
5919 * Retrieve the general action to be performed, such as
5920 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5921 * the information in the intent should be interpreted -- most importantly,
5922 * what to do with the data returned by {@link #getData}.
5923 *
5924 * @return The action of this intent or null if none is specified.
5925 *
5926 * @see #setAction
5927 */
5928 public String getAction() {
5929 return mAction;
5930 }
5931
5932 /**
5933 * Retrieve data this intent is operating on. This URI specifies the name
5934 * of the data; often it uses the content: scheme, specifying data in a
5935 * content provider. Other schemes may be handled by specific activities,
5936 * such as http: by the web browser.
5937 *
5938 * @return The URI of the data this intent is targeting or null.
5939 *
5940 * @see #getScheme
5941 * @see #setData
5942 */
5943 public Uri getData() {
5944 return mData;
5945 }
5946
5947 /**
5948 * The same as {@link #getData()}, but returns the URI as an encoded
5949 * String.
5950 */
5951 public String getDataString() {
5952 return mData != null ? mData.toString() : null;
5953 }
5954
5955 /**
5956 * Return the scheme portion of the intent's data. If the data is null or
5957 * does not include a scheme, null is returned. Otherwise, the scheme
5958 * prefix without the final ':' is returned, i.e. "http".
5959 *
5960 * <p>This is the same as calling getData().getScheme() (and checking for
5961 * null data).
5962 *
5963 * @return The scheme of this intent.
5964 *
5965 * @see #getData
5966 */
5967 public String getScheme() {
5968 return mData != null ? mData.getScheme() : null;
5969 }
5970
5971 /**
5972 * Retrieve any explicit MIME type included in the intent. This is usually
5973 * null, as the type is determined by the intent data.
5974 *
5975 * @return If a type was manually set, it is returned; else null is
5976 * returned.
5977 *
5978 * @see #resolveType(ContentResolver)
5979 * @see #setType
5980 */
5981 public String getType() {
5982 return mType;
5983 }
5984
5985 /**
5986 * Return the MIME data type of this intent. If the type field is
5987 * explicitly set, that is simply returned. Otherwise, if the data is set,
5988 * the type of that data is returned. If neither fields are set, a null is
5989 * returned.
5990 *
5991 * @return The MIME type of this intent.
5992 *
5993 * @see #getType
5994 * @see #resolveType(ContentResolver)
5995 */
5996 public String resolveType(Context context) {
5997 return resolveType(context.getContentResolver());
5998 }
5999
6000 /**
6001 * Return the MIME data type of this intent. If the type field is
6002 * explicitly set, that is simply returned. Otherwise, if the data is set,
6003 * the type of that data is returned. If neither fields are set, a null is
6004 * returned.
6005 *
6006 * @param resolver A ContentResolver that can be used to determine the MIME
6007 * type of the intent's data.
6008 *
6009 * @return The MIME type of this intent.
6010 *
6011 * @see #getType
6012 * @see #resolveType(Context)
6013 */
6014 public String resolveType(ContentResolver resolver) {
6015 if (mType != null) {
6016 return mType;
6017 }
6018 if (mData != null) {
6019 if ("content".equals(mData.getScheme())) {
6020 return resolver.getType(mData);
6021 }
6022 }
6023 return null;
6024 }
6025
6026 /**
6027 * Return the MIME data type of this intent, only if it will be needed for
6028 * intent resolution. This is not generally useful for application code;
6029 * it is used by the frameworks for communicating with back-end system
6030 * services.
6031 *
6032 * @param resolver A ContentResolver that can be used to determine the MIME
6033 * type of the intent's data.
6034 *
6035 * @return The MIME type of this intent, or null if it is unknown or not
6036 * needed.
6037 */
6038 public String resolveTypeIfNeeded(ContentResolver resolver) {
6039 if (mComponent != null) {
6040 return mType;
6041 }
6042 return resolveType(resolver);
6043 }
6044
6045 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006046 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006047 *
6048 * @param category The category to check.
6049 *
6050 * @return boolean True if the intent contains the category, else false.
6051 *
6052 * @see #getCategories
6053 * @see #addCategory
6054 */
6055 public boolean hasCategory(String category) {
6056 return mCategories != null && mCategories.contains(category);
6057 }
6058
6059 /**
6060 * Return the set of all categories in the intent. If there are no categories,
6061 * returns NULL.
6062 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006063 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006064 *
6065 * @see #hasCategory
6066 * @see #addCategory
6067 */
6068 public Set<String> getCategories() {
6069 return mCategories;
6070 }
6071
6072 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006073 * Return the specific selector associated with this Intent. If there is
6074 * none, returns null. See {@link #setSelector} for more information.
6075 *
6076 * @see #setSelector
6077 */
6078 public Intent getSelector() {
6079 return mSelector;
6080 }
6081
6082 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006083 * Return the {@link ClipData} associated with this Intent. If there is
6084 * none, returns null. See {@link #setClipData} for more information.
6085 *
John Spurlock125d1332013-11-25 11:58:37 -05006086 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006087 */
6088 public ClipData getClipData() {
6089 return mClipData;
6090 }
6091
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006092 /** @hide */
6093 public int getContentUserHint() {
6094 return mContentUserHint;
6095 }
6096
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006097 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006098 * Sets the ClassLoader that will be used when unmarshalling
6099 * any Parcelable values from the extras of this Intent.
6100 *
6101 * @param loader a ClassLoader, or null to use the default loader
6102 * at the time of unmarshalling.
6103 */
6104 public void setExtrasClassLoader(ClassLoader loader) {
6105 if (mExtras != null) {
6106 mExtras.setClassLoader(loader);
6107 }
6108 }
6109
6110 /**
6111 * Returns true if an extra value is associated with the given name.
6112 * @param name the extra's name
6113 * @return true if the given extra is present.
6114 */
6115 public boolean hasExtra(String name) {
6116 return mExtras != null && mExtras.containsKey(name);
6117 }
6118
6119 /**
6120 * Returns true if the Intent's extras contain a parcelled file descriptor.
6121 * @return true if the Intent contains a parcelled file descriptor.
6122 */
6123 public boolean hasFileDescriptors() {
6124 return mExtras != null && mExtras.hasFileDescriptors();
6125 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006126
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006127 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006128 public void setAllowFds(boolean allowFds) {
6129 if (mExtras != null) {
6130 mExtras.setAllowFds(allowFds);
6131 }
6132 }
6133
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006134 /** {@hide} */
6135 public void setDefusable(boolean defusable) {
6136 if (mExtras != null) {
6137 mExtras.setDefusable(defusable);
6138 }
6139 }
6140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006141 /**
6142 * Retrieve extended data from the intent.
6143 *
6144 * @param name The name of the desired item.
6145 *
6146 * @return the value of an item that previously added with putExtra()
6147 * or null if none was found.
6148 *
6149 * @deprecated
6150 * @hide
6151 */
6152 @Deprecated
6153 public Object getExtra(String name) {
6154 return getExtra(name, null);
6155 }
6156
6157 /**
6158 * Retrieve extended data from the intent.
6159 *
6160 * @param name The name of the desired item.
6161 * @param defaultValue the value to be returned if no value of the desired
6162 * type is stored with the given name.
6163 *
6164 * @return the value of an item that previously added with putExtra()
6165 * or the default value if none was found.
6166 *
6167 * @see #putExtra(String, boolean)
6168 */
6169 public boolean getBooleanExtra(String name, boolean defaultValue) {
6170 return mExtras == null ? defaultValue :
6171 mExtras.getBoolean(name, defaultValue);
6172 }
6173
6174 /**
6175 * Retrieve extended data from the intent.
6176 *
6177 * @param name The name of the desired item.
6178 * @param defaultValue the value to be returned if no value of the desired
6179 * type is stored with the given name.
6180 *
6181 * @return the value of an item that previously added with putExtra()
6182 * or the default value if none was found.
6183 *
6184 * @see #putExtra(String, byte)
6185 */
6186 public byte getByteExtra(String name, byte defaultValue) {
6187 return mExtras == null ? defaultValue :
6188 mExtras.getByte(name, defaultValue);
6189 }
6190
6191 /**
6192 * Retrieve extended data from the intent.
6193 *
6194 * @param name The name of the desired item.
6195 * @param defaultValue the value to be returned if no value of the desired
6196 * type is stored with the given name.
6197 *
6198 * @return the value of an item that previously added with putExtra()
6199 * or the default value if none was found.
6200 *
6201 * @see #putExtra(String, short)
6202 */
6203 public short getShortExtra(String name, short defaultValue) {
6204 return mExtras == null ? defaultValue :
6205 mExtras.getShort(name, defaultValue);
6206 }
6207
6208 /**
6209 * Retrieve extended data from the intent.
6210 *
6211 * @param name The name of the desired item.
6212 * @param defaultValue the value to be returned if no value of the desired
6213 * type is stored with the given name.
6214 *
6215 * @return the value of an item that previously added with putExtra()
6216 * or the default value if none was found.
6217 *
6218 * @see #putExtra(String, char)
6219 */
6220 public char getCharExtra(String name, char defaultValue) {
6221 return mExtras == null ? defaultValue :
6222 mExtras.getChar(name, defaultValue);
6223 }
6224
6225 /**
6226 * Retrieve extended data from the intent.
6227 *
6228 * @param name The name of the desired item.
6229 * @param defaultValue the value to be returned if no value of the desired
6230 * type is stored with the given name.
6231 *
6232 * @return the value of an item that previously added with putExtra()
6233 * or the default value if none was found.
6234 *
6235 * @see #putExtra(String, int)
6236 */
6237 public int getIntExtra(String name, int defaultValue) {
6238 return mExtras == null ? defaultValue :
6239 mExtras.getInt(name, defaultValue);
6240 }
6241
6242 /**
6243 * Retrieve extended data from the intent.
6244 *
6245 * @param name The name of the desired item.
6246 * @param defaultValue the value to be returned if no value of the desired
6247 * type is stored with the given name.
6248 *
6249 * @return the value of an item that previously added with putExtra()
6250 * or the default value if none was found.
6251 *
6252 * @see #putExtra(String, long)
6253 */
6254 public long getLongExtra(String name, long defaultValue) {
6255 return mExtras == null ? defaultValue :
6256 mExtras.getLong(name, defaultValue);
6257 }
6258
6259 /**
6260 * Retrieve extended data from the intent.
6261 *
6262 * @param name The name of the desired item.
6263 * @param defaultValue the value to be returned if no value of the desired
6264 * type is stored with the given name.
6265 *
6266 * @return the value of an item that previously added with putExtra(),
6267 * or the default value if no such item is present
6268 *
6269 * @see #putExtra(String, float)
6270 */
6271 public float getFloatExtra(String name, float defaultValue) {
6272 return mExtras == null ? defaultValue :
6273 mExtras.getFloat(name, defaultValue);
6274 }
6275
6276 /**
6277 * Retrieve extended data from the intent.
6278 *
6279 * @param name The name of the desired item.
6280 * @param defaultValue the value to be returned if no value of the desired
6281 * type is stored with the given name.
6282 *
6283 * @return the value of an item that previously added with putExtra()
6284 * or the default value if none was found.
6285 *
6286 * @see #putExtra(String, double)
6287 */
6288 public double getDoubleExtra(String name, double defaultValue) {
6289 return mExtras == null ? defaultValue :
6290 mExtras.getDouble(name, defaultValue);
6291 }
6292
6293 /**
6294 * Retrieve extended data from the intent.
6295 *
6296 * @param name The name of the desired item.
6297 *
6298 * @return the value of an item that previously added with putExtra()
6299 * or null if no String value was found.
6300 *
6301 * @see #putExtra(String, String)
6302 */
6303 public String getStringExtra(String name) {
6304 return mExtras == null ? null : mExtras.getString(name);
6305 }
6306
6307 /**
6308 * Retrieve extended data from the intent.
6309 *
6310 * @param name The name of the desired item.
6311 *
6312 * @return the value of an item that previously added with putExtra()
6313 * or null if no CharSequence value was found.
6314 *
6315 * @see #putExtra(String, CharSequence)
6316 */
6317 public CharSequence getCharSequenceExtra(String name) {
6318 return mExtras == null ? null : mExtras.getCharSequence(name);
6319 }
6320
6321 /**
6322 * Retrieve extended data from the intent.
6323 *
6324 * @param name The name of the desired item.
6325 *
6326 * @return the value of an item that previously added with putExtra()
6327 * or null if no Parcelable value was found.
6328 *
6329 * @see #putExtra(String, Parcelable)
6330 */
6331 public <T extends Parcelable> T getParcelableExtra(String name) {
6332 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6333 }
6334
6335 /**
6336 * Retrieve extended data from the intent.
6337 *
6338 * @param name The name of the desired item.
6339 *
6340 * @return the value of an item that previously added with putExtra()
6341 * or null if no Parcelable[] value was found.
6342 *
6343 * @see #putExtra(String, Parcelable[])
6344 */
6345 public Parcelable[] getParcelableArrayExtra(String name) {
6346 return mExtras == null ? null : mExtras.getParcelableArray(name);
6347 }
6348
6349 /**
6350 * Retrieve extended data from the intent.
6351 *
6352 * @param name The name of the desired item.
6353 *
6354 * @return the value of an item that previously added with putExtra()
6355 * or null if no ArrayList<Parcelable> value was found.
6356 *
6357 * @see #putParcelableArrayListExtra(String, ArrayList)
6358 */
6359 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6360 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6361 }
6362
6363 /**
6364 * Retrieve extended data from the intent.
6365 *
6366 * @param name The name of the desired item.
6367 *
6368 * @return the value of an item that previously added with putExtra()
6369 * or null if no Serializable value was found.
6370 *
6371 * @see #putExtra(String, Serializable)
6372 */
6373 public Serializable getSerializableExtra(String name) {
6374 return mExtras == null ? null : mExtras.getSerializable(name);
6375 }
6376
6377 /**
6378 * Retrieve extended data from the intent.
6379 *
6380 * @param name The name of the desired item.
6381 *
6382 * @return the value of an item that previously added with putExtra()
6383 * or null if no ArrayList<Integer> value was found.
6384 *
6385 * @see #putIntegerArrayListExtra(String, ArrayList)
6386 */
6387 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6388 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6389 }
6390
6391 /**
6392 * Retrieve extended data from the intent.
6393 *
6394 * @param name The name of the desired item.
6395 *
6396 * @return the value of an item that previously added with putExtra()
6397 * or null if no ArrayList<String> value was found.
6398 *
6399 * @see #putStringArrayListExtra(String, ArrayList)
6400 */
6401 public ArrayList<String> getStringArrayListExtra(String name) {
6402 return mExtras == null ? null : mExtras.getStringArrayList(name);
6403 }
6404
6405 /**
6406 * Retrieve extended data from the intent.
6407 *
6408 * @param name The name of the desired item.
6409 *
6410 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006411 * or null if no ArrayList<CharSequence> value was found.
6412 *
6413 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6414 */
6415 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6416 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6417 }
6418
6419 /**
6420 * Retrieve extended data from the intent.
6421 *
6422 * @param name The name of the desired item.
6423 *
6424 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006425 * or null if no boolean array value was found.
6426 *
6427 * @see #putExtra(String, boolean[])
6428 */
6429 public boolean[] getBooleanArrayExtra(String name) {
6430 return mExtras == null ? null : mExtras.getBooleanArray(name);
6431 }
6432
6433 /**
6434 * Retrieve extended data from the intent.
6435 *
6436 * @param name The name of the desired item.
6437 *
6438 * @return the value of an item that previously added with putExtra()
6439 * or null if no byte array value was found.
6440 *
6441 * @see #putExtra(String, byte[])
6442 */
6443 public byte[] getByteArrayExtra(String name) {
6444 return mExtras == null ? null : mExtras.getByteArray(name);
6445 }
6446
6447 /**
6448 * Retrieve extended data from the intent.
6449 *
6450 * @param name The name of the desired item.
6451 *
6452 * @return the value of an item that previously added with putExtra()
6453 * or null if no short array value was found.
6454 *
6455 * @see #putExtra(String, short[])
6456 */
6457 public short[] getShortArrayExtra(String name) {
6458 return mExtras == null ? null : mExtras.getShortArray(name);
6459 }
6460
6461 /**
6462 * Retrieve extended data from the intent.
6463 *
6464 * @param name The name of the desired item.
6465 *
6466 * @return the value of an item that previously added with putExtra()
6467 * or null if no char array value was found.
6468 *
6469 * @see #putExtra(String, char[])
6470 */
6471 public char[] getCharArrayExtra(String name) {
6472 return mExtras == null ? null : mExtras.getCharArray(name);
6473 }
6474
6475 /**
6476 * Retrieve extended data from the intent.
6477 *
6478 * @param name The name of the desired item.
6479 *
6480 * @return the value of an item that previously added with putExtra()
6481 * or null if no int array value was found.
6482 *
6483 * @see #putExtra(String, int[])
6484 */
6485 public int[] getIntArrayExtra(String name) {
6486 return mExtras == null ? null : mExtras.getIntArray(name);
6487 }
6488
6489 /**
6490 * Retrieve extended data from the intent.
6491 *
6492 * @param name The name of the desired item.
6493 *
6494 * @return the value of an item that previously added with putExtra()
6495 * or null if no long array value was found.
6496 *
6497 * @see #putExtra(String, long[])
6498 */
6499 public long[] getLongArrayExtra(String name) {
6500 return mExtras == null ? null : mExtras.getLongArray(name);
6501 }
6502
6503 /**
6504 * Retrieve extended data from the intent.
6505 *
6506 * @param name The name of the desired item.
6507 *
6508 * @return the value of an item that previously added with putExtra()
6509 * or null if no float array value was found.
6510 *
6511 * @see #putExtra(String, float[])
6512 */
6513 public float[] getFloatArrayExtra(String name) {
6514 return mExtras == null ? null : mExtras.getFloatArray(name);
6515 }
6516
6517 /**
6518 * Retrieve extended data from the intent.
6519 *
6520 * @param name The name of the desired item.
6521 *
6522 * @return the value of an item that previously added with putExtra()
6523 * or null if no double array value was found.
6524 *
6525 * @see #putExtra(String, double[])
6526 */
6527 public double[] getDoubleArrayExtra(String name) {
6528 return mExtras == null ? null : mExtras.getDoubleArray(name);
6529 }
6530
6531 /**
6532 * Retrieve extended data from the intent.
6533 *
6534 * @param name The name of the desired item.
6535 *
6536 * @return the value of an item that previously added with putExtra()
6537 * or null if no String array value was found.
6538 *
6539 * @see #putExtra(String, String[])
6540 */
6541 public String[] getStringArrayExtra(String name) {
6542 return mExtras == null ? null : mExtras.getStringArray(name);
6543 }
6544
6545 /**
6546 * Retrieve extended data from the intent.
6547 *
6548 * @param name The name of the desired item.
6549 *
6550 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006551 * or null if no CharSequence array value was found.
6552 *
6553 * @see #putExtra(String, CharSequence[])
6554 */
6555 public CharSequence[] getCharSequenceArrayExtra(String name) {
6556 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6557 }
6558
6559 /**
6560 * Retrieve extended data from the intent.
6561 *
6562 * @param name The name of the desired item.
6563 *
6564 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006565 * or null if no Bundle value was found.
6566 *
6567 * @see #putExtra(String, Bundle)
6568 */
6569 public Bundle getBundleExtra(String name) {
6570 return mExtras == null ? null : mExtras.getBundle(name);
6571 }
6572
6573 /**
6574 * Retrieve extended data from the intent.
6575 *
6576 * @param name The name of the desired item.
6577 *
6578 * @return the value of an item that previously added with putExtra()
6579 * or null if no IBinder value was found.
6580 *
6581 * @see #putExtra(String, IBinder)
6582 *
6583 * @deprecated
6584 * @hide
6585 */
6586 @Deprecated
6587 public IBinder getIBinderExtra(String name) {
6588 return mExtras == null ? null : mExtras.getIBinder(name);
6589 }
6590
6591 /**
6592 * Retrieve extended data from the intent.
6593 *
6594 * @param name The name of the desired item.
6595 * @param defaultValue The default value to return in case no item is
6596 * associated with the key 'name'
6597 *
6598 * @return the value of an item that previously added with putExtra()
6599 * or defaultValue if none was found.
6600 *
6601 * @see #putExtra
6602 *
6603 * @deprecated
6604 * @hide
6605 */
6606 @Deprecated
6607 public Object getExtra(String name, Object defaultValue) {
6608 Object result = defaultValue;
6609 if (mExtras != null) {
6610 Object result2 = mExtras.get(name);
6611 if (result2 != null) {
6612 result = result2;
6613 }
6614 }
6615
6616 return result;
6617 }
6618
6619 /**
6620 * Retrieves a map of extended data from the intent.
6621 *
6622 * @return the map of all extras previously added with putExtra(),
6623 * or null if none have been added.
6624 */
6625 public Bundle getExtras() {
6626 return (mExtras != null)
6627 ? new Bundle(mExtras)
6628 : null;
6629 }
6630
6631 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006632 * Filter extras to only basic types.
6633 * @hide
6634 */
6635 public void removeUnsafeExtras() {
6636 if (mExtras != null) {
6637 mExtras.filterValues();
6638 }
6639 }
6640
6641 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006642 * Retrieve any special flags associated with this intent. You will
6643 * normally just set them with {@link #setFlags} and let the system
6644 * take the appropriate action with them.
6645 *
6646 * @return int The currently set flags.
6647 *
6648 * @see #setFlags
6649 */
6650 public int getFlags() {
6651 return mFlags;
6652 }
6653
Dianne Hackborne7f97212011-02-24 14:40:20 -08006654 /** @hide */
6655 public boolean isExcludingStopped() {
6656 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6657 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6658 }
6659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006660 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006661 * Retrieve the application package name this Intent is limited to. When
6662 * resolving an Intent, if non-null this limits the resolution to only
6663 * components in the given application package.
6664 *
6665 * @return The name of the application package for the Intent.
6666 *
6667 * @see #resolveActivity
6668 * @see #setPackage
6669 */
6670 public String getPackage() {
6671 return mPackage;
6672 }
6673
6674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006675 * Retrieve the concrete component associated with the intent. When receiving
6676 * an intent, this is the component that was found to best handle it (that is,
6677 * yourself) and will always be non-null; in all other cases it will be
6678 * null unless explicitly set.
6679 *
6680 * @return The name of the application component to handle the intent.
6681 *
6682 * @see #resolveActivity
6683 * @see #setComponent
6684 */
6685 public ComponentName getComponent() {
6686 return mComponent;
6687 }
6688
6689 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006690 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6691 * used as a hint to the receiver for animations and the like. Null means that there
6692 * is no source bounds.
6693 */
6694 public Rect getSourceBounds() {
6695 return mSourceBounds;
6696 }
6697
6698 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006699 * Return the Activity component that should be used to handle this intent.
6700 * The appropriate component is determined based on the information in the
6701 * intent, evaluated as follows:
6702 *
6703 * <p>If {@link #getComponent} returns an explicit class, that is returned
6704 * without any further consideration.
6705 *
6706 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6707 * category to be considered.
6708 *
6709 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6710 * action.
6711 *
6712 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6713 * this type.
6714 *
6715 * <p>If {@link #addCategory} has added any categories, the activity must
6716 * handle ALL of the categories specified.
6717 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006718 * <p>If {@link #getPackage} is non-NULL, only activity components in
6719 * that application package will be considered.
6720 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006721 * <p>If there are no activities that satisfy all of these conditions, a
6722 * null string is returned.
6723 *
6724 * <p>If multiple activities are found to satisfy the intent, the one with
6725 * the highest priority will be used. If there are multiple activities
6726 * with the same priority, the system will either pick the best activity
6727 * based on user preference, or resolve to a system class that will allow
6728 * the user to pick an activity and forward from there.
6729 *
6730 * <p>This method is implemented simply by calling
6731 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6732 * true.</p>
6733 * <p> This API is called for you as part of starting an activity from an
6734 * intent. You do not normally need to call it yourself.</p>
6735 *
6736 * @param pm The package manager with which to resolve the Intent.
6737 *
6738 * @return Name of the component implementing an activity that can
6739 * display the intent.
6740 *
6741 * @see #setComponent
6742 * @see #getComponent
6743 * @see #resolveActivityInfo
6744 */
6745 public ComponentName resolveActivity(PackageManager pm) {
6746 if (mComponent != null) {
6747 return mComponent;
6748 }
6749
6750 ResolveInfo info = pm.resolveActivity(
6751 this, PackageManager.MATCH_DEFAULT_ONLY);
6752 if (info != null) {
6753 return new ComponentName(
6754 info.activityInfo.applicationInfo.packageName,
6755 info.activityInfo.name);
6756 }
6757
6758 return null;
6759 }
6760
6761 /**
6762 * Resolve the Intent into an {@link ActivityInfo}
6763 * describing the activity that should execute the intent. Resolution
6764 * follows the same rules as described for {@link #resolveActivity}, but
6765 * you get back the completely information about the resolved activity
6766 * instead of just its class name.
6767 *
6768 * @param pm The package manager with which to resolve the Intent.
6769 * @param flags Addition information to retrieve as per
6770 * {@link PackageManager#getActivityInfo(ComponentName, int)
6771 * PackageManager.getActivityInfo()}.
6772 *
6773 * @return PackageManager.ActivityInfo
6774 *
6775 * @see #resolveActivity
6776 */
6777 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6778 ActivityInfo ai = null;
6779 if (mComponent != null) {
6780 try {
6781 ai = pm.getActivityInfo(mComponent, flags);
6782 } catch (PackageManager.NameNotFoundException e) {
6783 // ignore
6784 }
6785 } else {
6786 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006787 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006788 if (info != null) {
6789 ai = info.activityInfo;
6790 }
6791 }
6792
6793 return ai;
6794 }
6795
6796 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006797 * Special function for use by the system to resolve service
6798 * intents to system apps. Throws an exception if there are
6799 * multiple potential matches to the Intent. Returns null if
6800 * there are no matches.
6801 * @hide
6802 */
6803 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6804 if (mComponent != null) {
6805 return mComponent;
6806 }
6807
6808 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6809 if (results == null) {
6810 return null;
6811 }
6812 ComponentName comp = null;
6813 for (int i=0; i<results.size(); i++) {
6814 ResolveInfo ri = results.get(i);
6815 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6816 continue;
6817 }
6818 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6819 ri.serviceInfo.name);
6820 if (comp != null) {
6821 throw new IllegalStateException("Multiple system services handle " + this
6822 + ": " + comp + ", " + foundComp);
6823 }
6824 comp = foundComp;
6825 }
6826 return comp;
6827 }
6828
6829 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006830 * Set the general action to be performed.
6831 *
6832 * @param action An action name, such as ACTION_VIEW. Application-specific
6833 * actions should be prefixed with the vendor's package name.
6834 *
6835 * @return Returns the same Intent object, for chaining multiple calls
6836 * into a single statement.
6837 *
6838 * @see #getAction
6839 */
6840 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006841 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006842 return this;
6843 }
6844
6845 /**
6846 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006847 * clears any type that was previously set by {@link #setType} or
6848 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006849 *
Nick Pellyccae4122012-01-09 14:12:58 -08006850 * <p><em>Note: scheme matching in the Android framework is
6851 * case-sensitive, unlike the formal RFC. As a result,
6852 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006853 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006854 * {@link #setDataAndNormalize}
6855 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006856 *
Nick Pellyccae4122012-01-09 14:12:58 -08006857 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006858 *
6859 * @return Returns the same Intent object, for chaining multiple calls
6860 * into a single statement.
6861 *
6862 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006863 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006864 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006865 */
6866 public Intent setData(Uri data) {
6867 mData = data;
6868 mType = null;
6869 return this;
6870 }
6871
6872 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006873 * Normalize and set the data this intent is operating on.
6874 *
6875 * <p>This method automatically clears any type that was
6876 * previously set (for example, by {@link #setType}).
6877 *
6878 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006879 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006880 * so really this is just a convenience method for
6881 * <pre>
6882 * setData(data.normalize())
6883 * </pre>
6884 *
6885 * @param data The Uri of the data this intent is now targeting.
6886 *
6887 * @return Returns the same Intent object, for chaining multiple calls
6888 * into a single statement.
6889 *
6890 * @see #getData
6891 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006892 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006893 */
6894 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006895 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006896 }
6897
6898 /**
6899 * Set an explicit MIME data type.
6900 *
6901 * <p>This is used to create intents that only specify a type and not data,
6902 * for example to indicate the type of data to return.
6903 *
6904 * <p>This method automatically clears any data that was
6905 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006906 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006907 * <p><em>Note: MIME type matching in the Android framework is
6908 * case-sensitive, unlike formal RFC MIME types. As a result,
6909 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006910 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6911 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006912 *
6913 * @param type The MIME type of the data being handled by this intent.
6914 *
6915 * @return Returns the same Intent object, for chaining multiple calls
6916 * into a single statement.
6917 *
6918 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006919 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006920 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006921 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006922 */
6923 public Intent setType(String type) {
6924 mData = null;
6925 mType = type;
6926 return this;
6927 }
6928
6929 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006930 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006931 *
Nick Pellyccae4122012-01-09 14:12:58 -08006932 * <p>This is used to create intents that only specify a type and not data,
6933 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006934 *
Nick Pellyccae4122012-01-09 14:12:58 -08006935 * <p>This method automatically clears any data that was
6936 * previously set (for example by {@link #setData}).
6937 *
6938 * <p>The MIME type is normalized using
6939 * {@link #normalizeMimeType} before it is set,
6940 * so really this is just a convenience method for
6941 * <pre>
6942 * setType(Intent.normalizeMimeType(type))
6943 * </pre>
6944 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006945 * @param type The MIME type of the data being handled by this intent.
6946 *
6947 * @return Returns the same Intent object, for chaining multiple calls
6948 * into a single statement.
6949 *
Nick Pellyccae4122012-01-09 14:12:58 -08006950 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006952 * @see #normalizeMimeType
6953 */
6954 public Intent setTypeAndNormalize(String type) {
6955 return setType(normalizeMimeType(type));
6956 }
6957
6958 /**
6959 * (Usually optional) Set the data for the intent along with an explicit
6960 * MIME data type. This method should very rarely be used -- it allows you
6961 * to override the MIME type that would ordinarily be inferred from the
6962 * data with your own type given here.
6963 *
6964 * <p><em>Note: MIME type and Uri scheme matching in the
6965 * Android framework is case-sensitive, unlike the formal RFC definitions.
6966 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006967 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006968 * {@link #setDataAndTypeAndNormalize}
6969 * to ensure that they are converted to lower case.</em>
6970 *
6971 * @param data The Uri of the data this intent is now targeting.
6972 * @param type The MIME type of the data being handled by this intent.
6973 *
6974 * @return Returns the same Intent object, for chaining multiple calls
6975 * into a single statement.
6976 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006977 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006978 * @see #setData
6979 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006980 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006981 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006982 */
6983 public Intent setDataAndType(Uri data, String type) {
6984 mData = data;
6985 mType = type;
6986 return this;
6987 }
6988
6989 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006990 * (Usually optional) Normalize and set both the data Uri and an explicit
6991 * MIME data type. This method should very rarely be used -- it allows you
6992 * to override the MIME type that would ordinarily be inferred from the
6993 * data with your own type given here.
6994 *
6995 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006996 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006997 * before they are set, so really this is just a convenience method for
6998 * <pre>
6999 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
7000 * </pre>
7001 *
7002 * @param data The Uri of the data this intent is now targeting.
7003 * @param type The MIME type of the data being handled by this intent.
7004 *
7005 * @return Returns the same Intent object, for chaining multiple calls
7006 * into a single statement.
7007 *
7008 * @see #setType
7009 * @see #setData
7010 * @see #setDataAndType
7011 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007012 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08007013 */
7014 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04007015 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08007016 }
7017
7018 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007019 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007020 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007021 * activities that provide <em>all</em> of the requested categories will be
7022 * used.
7023 *
7024 * @param category The desired category. This can be either one of the
7025 * predefined Intent categories, or a custom category in your own
7026 * namespace.
7027 *
7028 * @return Returns the same Intent object, for chaining multiple calls
7029 * into a single statement.
7030 *
7031 * @see #hasCategory
7032 * @see #removeCategory
7033 */
7034 public Intent addCategory(String category) {
7035 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007036 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007037 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08007038 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007039 return this;
7040 }
7041
7042 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09007043 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007044 *
7045 * @param category The category to remove.
7046 *
7047 * @see #addCategory
7048 */
7049 public void removeCategory(String category) {
7050 if (mCategories != null) {
7051 mCategories.remove(category);
7052 if (mCategories.size() == 0) {
7053 mCategories = null;
7054 }
7055 }
7056 }
7057
7058 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007059 * Set a selector for this Intent. This is a modification to the kinds of
7060 * things the Intent will match. If the selector is set, it will be used
7061 * when trying to find entities that can handle the Intent, instead of the
7062 * main contents of the Intent. This allows you build an Intent containing
7063 * a generic protocol while targeting it more specifically.
7064 *
7065 * <p>An example of where this may be used is with things like
7066 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
7067 * Intent that will launch the Browser application. However, the correct
7068 * main entry point of an application is actually {@link #ACTION_MAIN}
7069 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7070 * used to specify the actual Activity to launch. If you launch the browser
7071 * with something different, undesired behavior may happen if the user has
7072 * previously or later launches it the normal way, since they do not match.
7073 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7074 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7075 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7076 *
7077 * <p>Setting a selector does not impact the behavior of
7078 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7079 * desired behavior of a selector -- it does not impact the base meaning
7080 * of the Intent, just what kinds of things will be matched against it
7081 * when determining who can handle it.</p>
7082 *
7083 * <p>You can not use both a selector and {@link #setPackage(String)} on
7084 * the same base Intent.</p>
7085 *
7086 * @param selector The desired selector Intent; set to null to not use
7087 * a special selector.
7088 */
7089 public void setSelector(Intent selector) {
7090 if (selector == this) {
7091 throw new IllegalArgumentException(
7092 "Intent being set as a selector of itself");
7093 }
7094 if (selector != null && mPackage != null) {
7095 throw new IllegalArgumentException(
7096 "Can't set selector when package name is already set");
7097 }
7098 mSelector = selector;
7099 }
7100
7101 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007102 * Set a {@link ClipData} associated with this Intent. This replaces any
7103 * previously set ClipData.
7104 *
7105 * <p>The ClipData in an intent is not used for Intent matching or other
7106 * such operations. Semantically it is like extras, used to transmit
7107 * additional data with the Intent. The main feature of using this over
7108 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7109 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7110 * items included in the clip data. This is useful, in particular, if
7111 * you want to transmit an Intent containing multiple <code>content:</code>
7112 * URIs for which the recipient may not have global permission to access the
7113 * content provider.
7114 *
7115 * <p>If the ClipData contains items that are themselves Intents, any
7116 * grant flags in those Intents will be ignored. Only the top-level flags
7117 * of the main Intent are respected, and will be applied to all Uri or
7118 * Intent items in the clip (or sub-items of the clip).
7119 *
7120 * <p>The MIME type, label, and icon in the ClipData object are not
7121 * directly used by Intent. Applications should generally rely on the
7122 * MIME type of the Intent itself, not what it may find in the ClipData.
7123 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007124 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007125 *
7126 * @param clip The new clip to set. May be null to clear the current clip.
7127 */
7128 public void setClipData(ClipData clip) {
7129 mClipData = clip;
7130 }
7131
7132 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007133 * This is NOT a secure mechanism to identify the user who sent the intent.
7134 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7135 * who sent the intent.
7136 * @hide
7137 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007138 public void prepareToLeaveUser(int userId) {
7139 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7140 // We want mContentUserHint to refer to the original user, so don't do anything.
7141 if (mContentUserHint == UserHandle.USER_CURRENT) {
7142 mContentUserHint = userId;
7143 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007144 }
7145
7146 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007147 * Add extended data to the intent. The name must include a package
7148 * prefix, for example the app com.android.contacts would use names
7149 * like "com.android.contacts.ShowAll".
7150 *
7151 * @param name The name of the extra data, with package prefix.
7152 * @param value The boolean data value.
7153 *
7154 * @return Returns the same Intent object, for chaining multiple calls
7155 * into a single statement.
7156 *
7157 * @see #putExtras
7158 * @see #removeExtra
7159 * @see #getBooleanExtra(String, boolean)
7160 */
7161 public Intent putExtra(String name, boolean value) {
7162 if (mExtras == null) {
7163 mExtras = new Bundle();
7164 }
7165 mExtras.putBoolean(name, value);
7166 return this;
7167 }
7168
7169 /**
7170 * Add extended data to the intent. The name must include a package
7171 * prefix, for example the app com.android.contacts would use names
7172 * like "com.android.contacts.ShowAll".
7173 *
7174 * @param name The name of the extra data, with package prefix.
7175 * @param value The byte data value.
7176 *
7177 * @return Returns the same Intent object, for chaining multiple calls
7178 * into a single statement.
7179 *
7180 * @see #putExtras
7181 * @see #removeExtra
7182 * @see #getByteExtra(String, byte)
7183 */
7184 public Intent putExtra(String name, byte value) {
7185 if (mExtras == null) {
7186 mExtras = new Bundle();
7187 }
7188 mExtras.putByte(name, value);
7189 return this;
7190 }
7191
7192 /**
7193 * Add extended data to the intent. The name must include a package
7194 * prefix, for example the app com.android.contacts would use names
7195 * like "com.android.contacts.ShowAll".
7196 *
7197 * @param name The name of the extra data, with package prefix.
7198 * @param value The char data value.
7199 *
7200 * @return Returns the same Intent object, for chaining multiple calls
7201 * into a single statement.
7202 *
7203 * @see #putExtras
7204 * @see #removeExtra
7205 * @see #getCharExtra(String, char)
7206 */
7207 public Intent putExtra(String name, char value) {
7208 if (mExtras == null) {
7209 mExtras = new Bundle();
7210 }
7211 mExtras.putChar(name, value);
7212 return this;
7213 }
7214
7215 /**
7216 * Add extended data to the intent. The name must include a package
7217 * prefix, for example the app com.android.contacts would use names
7218 * like "com.android.contacts.ShowAll".
7219 *
7220 * @param name The name of the extra data, with package prefix.
7221 * @param value The short data value.
7222 *
7223 * @return Returns the same Intent object, for chaining multiple calls
7224 * into a single statement.
7225 *
7226 * @see #putExtras
7227 * @see #removeExtra
7228 * @see #getShortExtra(String, short)
7229 */
7230 public Intent putExtra(String name, short value) {
7231 if (mExtras == null) {
7232 mExtras = new Bundle();
7233 }
7234 mExtras.putShort(name, value);
7235 return this;
7236 }
7237
7238 /**
7239 * Add extended data to the intent. The name must include a package
7240 * prefix, for example the app com.android.contacts would use names
7241 * like "com.android.contacts.ShowAll".
7242 *
7243 * @param name The name of the extra data, with package prefix.
7244 * @param value The integer data value.
7245 *
7246 * @return Returns the same Intent object, for chaining multiple calls
7247 * into a single statement.
7248 *
7249 * @see #putExtras
7250 * @see #removeExtra
7251 * @see #getIntExtra(String, int)
7252 */
7253 public Intent putExtra(String name, int value) {
7254 if (mExtras == null) {
7255 mExtras = new Bundle();
7256 }
7257 mExtras.putInt(name, value);
7258 return this;
7259 }
7260
7261 /**
7262 * Add extended data to the intent. The name must include a package
7263 * prefix, for example the app com.android.contacts would use names
7264 * like "com.android.contacts.ShowAll".
7265 *
7266 * @param name The name of the extra data, with package prefix.
7267 * @param value The long data value.
7268 *
7269 * @return Returns the same Intent object, for chaining multiple calls
7270 * into a single statement.
7271 *
7272 * @see #putExtras
7273 * @see #removeExtra
7274 * @see #getLongExtra(String, long)
7275 */
7276 public Intent putExtra(String name, long value) {
7277 if (mExtras == null) {
7278 mExtras = new Bundle();
7279 }
7280 mExtras.putLong(name, value);
7281 return this;
7282 }
7283
7284 /**
7285 * Add extended data to the intent. The name must include a package
7286 * prefix, for example the app com.android.contacts would use names
7287 * like "com.android.contacts.ShowAll".
7288 *
7289 * @param name The name of the extra data, with package prefix.
7290 * @param value The float data value.
7291 *
7292 * @return Returns the same Intent object, for chaining multiple calls
7293 * into a single statement.
7294 *
7295 * @see #putExtras
7296 * @see #removeExtra
7297 * @see #getFloatExtra(String, float)
7298 */
7299 public Intent putExtra(String name, float value) {
7300 if (mExtras == null) {
7301 mExtras = new Bundle();
7302 }
7303 mExtras.putFloat(name, value);
7304 return this;
7305 }
7306
7307 /**
7308 * Add extended data to the intent. The name must include a package
7309 * prefix, for example the app com.android.contacts would use names
7310 * like "com.android.contacts.ShowAll".
7311 *
7312 * @param name The name of the extra data, with package prefix.
7313 * @param value The double data value.
7314 *
7315 * @return Returns the same Intent object, for chaining multiple calls
7316 * into a single statement.
7317 *
7318 * @see #putExtras
7319 * @see #removeExtra
7320 * @see #getDoubleExtra(String, double)
7321 */
7322 public Intent putExtra(String name, double value) {
7323 if (mExtras == null) {
7324 mExtras = new Bundle();
7325 }
7326 mExtras.putDouble(name, value);
7327 return this;
7328 }
7329
7330 /**
7331 * Add extended data to the intent. The name must include a package
7332 * prefix, for example the app com.android.contacts would use names
7333 * like "com.android.contacts.ShowAll".
7334 *
7335 * @param name The name of the extra data, with package prefix.
7336 * @param value The String data value.
7337 *
7338 * @return Returns the same Intent object, for chaining multiple calls
7339 * into a single statement.
7340 *
7341 * @see #putExtras
7342 * @see #removeExtra
7343 * @see #getStringExtra(String)
7344 */
7345 public Intent putExtra(String name, String value) {
7346 if (mExtras == null) {
7347 mExtras = new Bundle();
7348 }
7349 mExtras.putString(name, value);
7350 return this;
7351 }
7352
7353 /**
7354 * Add extended data to the intent. The name must include a package
7355 * prefix, for example the app com.android.contacts would use names
7356 * like "com.android.contacts.ShowAll".
7357 *
7358 * @param name The name of the extra data, with package prefix.
7359 * @param value The CharSequence data value.
7360 *
7361 * @return Returns the same Intent object, for chaining multiple calls
7362 * into a single statement.
7363 *
7364 * @see #putExtras
7365 * @see #removeExtra
7366 * @see #getCharSequenceExtra(String)
7367 */
7368 public Intent putExtra(String name, CharSequence value) {
7369 if (mExtras == null) {
7370 mExtras = new Bundle();
7371 }
7372 mExtras.putCharSequence(name, value);
7373 return this;
7374 }
7375
7376 /**
7377 * Add extended data to the intent. The name must include a package
7378 * prefix, for example the app com.android.contacts would use names
7379 * like "com.android.contacts.ShowAll".
7380 *
7381 * @param name The name of the extra data, with package prefix.
7382 * @param value The Parcelable data value.
7383 *
7384 * @return Returns the same Intent object, for chaining multiple calls
7385 * into a single statement.
7386 *
7387 * @see #putExtras
7388 * @see #removeExtra
7389 * @see #getParcelableExtra(String)
7390 */
7391 public Intent putExtra(String name, Parcelable value) {
7392 if (mExtras == null) {
7393 mExtras = new Bundle();
7394 }
7395 mExtras.putParcelable(name, value);
7396 return this;
7397 }
7398
7399 /**
7400 * Add extended data to the intent. The name must include a package
7401 * prefix, for example the app com.android.contacts would use names
7402 * like "com.android.contacts.ShowAll".
7403 *
7404 * @param name The name of the extra data, with package prefix.
7405 * @param value The Parcelable[] data value.
7406 *
7407 * @return Returns the same Intent object, for chaining multiple calls
7408 * into a single statement.
7409 *
7410 * @see #putExtras
7411 * @see #removeExtra
7412 * @see #getParcelableArrayExtra(String)
7413 */
7414 public Intent putExtra(String name, Parcelable[] value) {
7415 if (mExtras == null) {
7416 mExtras = new Bundle();
7417 }
7418 mExtras.putParcelableArray(name, value);
7419 return this;
7420 }
7421
7422 /**
7423 * Add extended data to the intent. The name must include a package
7424 * prefix, for example the app com.android.contacts would use names
7425 * like "com.android.contacts.ShowAll".
7426 *
7427 * @param name The name of the extra data, with package prefix.
7428 * @param value The ArrayList<Parcelable> data value.
7429 *
7430 * @return Returns the same Intent object, for chaining multiple calls
7431 * into a single statement.
7432 *
7433 * @see #putExtras
7434 * @see #removeExtra
7435 * @see #getParcelableArrayListExtra(String)
7436 */
7437 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7438 if (mExtras == null) {
7439 mExtras = new Bundle();
7440 }
7441 mExtras.putParcelableArrayList(name, value);
7442 return this;
7443 }
7444
7445 /**
7446 * Add extended data to the intent. The name must include a package
7447 * prefix, for example the app com.android.contacts would use names
7448 * like "com.android.contacts.ShowAll".
7449 *
7450 * @param name The name of the extra data, with package prefix.
7451 * @param value The ArrayList<Integer> data value.
7452 *
7453 * @return Returns the same Intent object, for chaining multiple calls
7454 * into a single statement.
7455 *
7456 * @see #putExtras
7457 * @see #removeExtra
7458 * @see #getIntegerArrayListExtra(String)
7459 */
7460 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7461 if (mExtras == null) {
7462 mExtras = new Bundle();
7463 }
7464 mExtras.putIntegerArrayList(name, value);
7465 return this;
7466 }
7467
7468 /**
7469 * Add extended data to the intent. The name must include a package
7470 * prefix, for example the app com.android.contacts would use names
7471 * like "com.android.contacts.ShowAll".
7472 *
7473 * @param name The name of the extra data, with package prefix.
7474 * @param value The ArrayList<String> data value.
7475 *
7476 * @return Returns the same Intent object, for chaining multiple calls
7477 * into a single statement.
7478 *
7479 * @see #putExtras
7480 * @see #removeExtra
7481 * @see #getStringArrayListExtra(String)
7482 */
7483 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7484 if (mExtras == null) {
7485 mExtras = new Bundle();
7486 }
7487 mExtras.putStringArrayList(name, value);
7488 return this;
7489 }
7490
7491 /**
7492 * Add extended data to the intent. The name must include a package
7493 * prefix, for example the app com.android.contacts would use names
7494 * like "com.android.contacts.ShowAll".
7495 *
7496 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007497 * @param value The ArrayList<CharSequence> data value.
7498 *
7499 * @return Returns the same Intent object, for chaining multiple calls
7500 * into a single statement.
7501 *
7502 * @see #putExtras
7503 * @see #removeExtra
7504 * @see #getCharSequenceArrayListExtra(String)
7505 */
7506 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7507 if (mExtras == null) {
7508 mExtras = new Bundle();
7509 }
7510 mExtras.putCharSequenceArrayList(name, value);
7511 return this;
7512 }
7513
7514 /**
7515 * Add extended data to the intent. The name must include a package
7516 * prefix, for example the app com.android.contacts would use names
7517 * like "com.android.contacts.ShowAll".
7518 *
7519 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007520 * @param value The Serializable data value.
7521 *
7522 * @return Returns the same Intent object, for chaining multiple calls
7523 * into a single statement.
7524 *
7525 * @see #putExtras
7526 * @see #removeExtra
7527 * @see #getSerializableExtra(String)
7528 */
7529 public Intent putExtra(String name, Serializable value) {
7530 if (mExtras == null) {
7531 mExtras = new Bundle();
7532 }
7533 mExtras.putSerializable(name, value);
7534 return this;
7535 }
7536
7537 /**
7538 * Add extended data to the intent. The name must include a package
7539 * prefix, for example the app com.android.contacts would use names
7540 * like "com.android.contacts.ShowAll".
7541 *
7542 * @param name The name of the extra data, with package prefix.
7543 * @param value The boolean array data value.
7544 *
7545 * @return Returns the same Intent object, for chaining multiple calls
7546 * into a single statement.
7547 *
7548 * @see #putExtras
7549 * @see #removeExtra
7550 * @see #getBooleanArrayExtra(String)
7551 */
7552 public Intent putExtra(String name, boolean[] value) {
7553 if (mExtras == null) {
7554 mExtras = new Bundle();
7555 }
7556 mExtras.putBooleanArray(name, value);
7557 return this;
7558 }
7559
7560 /**
7561 * Add extended data to the intent. The name must include a package
7562 * prefix, for example the app com.android.contacts would use names
7563 * like "com.android.contacts.ShowAll".
7564 *
7565 * @param name The name of the extra data, with package prefix.
7566 * @param value The byte array data value.
7567 *
7568 * @return Returns the same Intent object, for chaining multiple calls
7569 * into a single statement.
7570 *
7571 * @see #putExtras
7572 * @see #removeExtra
7573 * @see #getByteArrayExtra(String)
7574 */
7575 public Intent putExtra(String name, byte[] value) {
7576 if (mExtras == null) {
7577 mExtras = new Bundle();
7578 }
7579 mExtras.putByteArray(name, value);
7580 return this;
7581 }
7582
7583 /**
7584 * Add extended data to the intent. The name must include a package
7585 * prefix, for example the app com.android.contacts would use names
7586 * like "com.android.contacts.ShowAll".
7587 *
7588 * @param name The name of the extra data, with package prefix.
7589 * @param value The short array data value.
7590 *
7591 * @return Returns the same Intent object, for chaining multiple calls
7592 * into a single statement.
7593 *
7594 * @see #putExtras
7595 * @see #removeExtra
7596 * @see #getShortArrayExtra(String)
7597 */
7598 public Intent putExtra(String name, short[] value) {
7599 if (mExtras == null) {
7600 mExtras = new Bundle();
7601 }
7602 mExtras.putShortArray(name, value);
7603 return this;
7604 }
7605
7606 /**
7607 * Add extended data to the intent. The name must include a package
7608 * prefix, for example the app com.android.contacts would use names
7609 * like "com.android.contacts.ShowAll".
7610 *
7611 * @param name The name of the extra data, with package prefix.
7612 * @param value The char array data value.
7613 *
7614 * @return Returns the same Intent object, for chaining multiple calls
7615 * into a single statement.
7616 *
7617 * @see #putExtras
7618 * @see #removeExtra
7619 * @see #getCharArrayExtra(String)
7620 */
7621 public Intent putExtra(String name, char[] value) {
7622 if (mExtras == null) {
7623 mExtras = new Bundle();
7624 }
7625 mExtras.putCharArray(name, value);
7626 return this;
7627 }
7628
7629 /**
7630 * Add extended data to the intent. The name must include a package
7631 * prefix, for example the app com.android.contacts would use names
7632 * like "com.android.contacts.ShowAll".
7633 *
7634 * @param name The name of the extra data, with package prefix.
7635 * @param value The int array data value.
7636 *
7637 * @return Returns the same Intent object, for chaining multiple calls
7638 * into a single statement.
7639 *
7640 * @see #putExtras
7641 * @see #removeExtra
7642 * @see #getIntArrayExtra(String)
7643 */
7644 public Intent putExtra(String name, int[] value) {
7645 if (mExtras == null) {
7646 mExtras = new Bundle();
7647 }
7648 mExtras.putIntArray(name, value);
7649 return this;
7650 }
7651
7652 /**
7653 * Add extended data to the intent. The name must include a package
7654 * prefix, for example the app com.android.contacts would use names
7655 * like "com.android.contacts.ShowAll".
7656 *
7657 * @param name The name of the extra data, with package prefix.
7658 * @param value The byte array data value.
7659 *
7660 * @return Returns the same Intent object, for chaining multiple calls
7661 * into a single statement.
7662 *
7663 * @see #putExtras
7664 * @see #removeExtra
7665 * @see #getLongArrayExtra(String)
7666 */
7667 public Intent putExtra(String name, long[] value) {
7668 if (mExtras == null) {
7669 mExtras = new Bundle();
7670 }
7671 mExtras.putLongArray(name, value);
7672 return this;
7673 }
7674
7675 /**
7676 * Add extended data to the intent. The name must include a package
7677 * prefix, for example the app com.android.contacts would use names
7678 * like "com.android.contacts.ShowAll".
7679 *
7680 * @param name The name of the extra data, with package prefix.
7681 * @param value The float array data value.
7682 *
7683 * @return Returns the same Intent object, for chaining multiple calls
7684 * into a single statement.
7685 *
7686 * @see #putExtras
7687 * @see #removeExtra
7688 * @see #getFloatArrayExtra(String)
7689 */
7690 public Intent putExtra(String name, float[] value) {
7691 if (mExtras == null) {
7692 mExtras = new Bundle();
7693 }
7694 mExtras.putFloatArray(name, value);
7695 return this;
7696 }
7697
7698 /**
7699 * Add extended data to the intent. The name must include a package
7700 * prefix, for example the app com.android.contacts would use names
7701 * like "com.android.contacts.ShowAll".
7702 *
7703 * @param name The name of the extra data, with package prefix.
7704 * @param value The double array data value.
7705 *
7706 * @return Returns the same Intent object, for chaining multiple calls
7707 * into a single statement.
7708 *
7709 * @see #putExtras
7710 * @see #removeExtra
7711 * @see #getDoubleArrayExtra(String)
7712 */
7713 public Intent putExtra(String name, double[] value) {
7714 if (mExtras == null) {
7715 mExtras = new Bundle();
7716 }
7717 mExtras.putDoubleArray(name, value);
7718 return this;
7719 }
7720
7721 /**
7722 * Add extended data to the intent. The name must include a package
7723 * prefix, for example the app com.android.contacts would use names
7724 * like "com.android.contacts.ShowAll".
7725 *
7726 * @param name The name of the extra data, with package prefix.
7727 * @param value The String array data value.
7728 *
7729 * @return Returns the same Intent object, for chaining multiple calls
7730 * into a single statement.
7731 *
7732 * @see #putExtras
7733 * @see #removeExtra
7734 * @see #getStringArrayExtra(String)
7735 */
7736 public Intent putExtra(String name, String[] value) {
7737 if (mExtras == null) {
7738 mExtras = new Bundle();
7739 }
7740 mExtras.putStringArray(name, value);
7741 return this;
7742 }
7743
7744 /**
7745 * Add extended data to the intent. The name must include a package
7746 * prefix, for example the app com.android.contacts would use names
7747 * like "com.android.contacts.ShowAll".
7748 *
7749 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007750 * @param value The CharSequence array data value.
7751 *
7752 * @return Returns the same Intent object, for chaining multiple calls
7753 * into a single statement.
7754 *
7755 * @see #putExtras
7756 * @see #removeExtra
7757 * @see #getCharSequenceArrayExtra(String)
7758 */
7759 public Intent putExtra(String name, CharSequence[] value) {
7760 if (mExtras == null) {
7761 mExtras = new Bundle();
7762 }
7763 mExtras.putCharSequenceArray(name, value);
7764 return this;
7765 }
7766
7767 /**
7768 * Add extended data to the intent. The name must include a package
7769 * prefix, for example the app com.android.contacts would use names
7770 * like "com.android.contacts.ShowAll".
7771 *
7772 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007773 * @param value The Bundle data value.
7774 *
7775 * @return Returns the same Intent object, for chaining multiple calls
7776 * into a single statement.
7777 *
7778 * @see #putExtras
7779 * @see #removeExtra
7780 * @see #getBundleExtra(String)
7781 */
7782 public Intent putExtra(String name, Bundle value) {
7783 if (mExtras == null) {
7784 mExtras = new Bundle();
7785 }
7786 mExtras.putBundle(name, value);
7787 return this;
7788 }
7789
7790 /**
7791 * Add extended data to the intent. The name must include a package
7792 * prefix, for example the app com.android.contacts would use names
7793 * like "com.android.contacts.ShowAll".
7794 *
7795 * @param name The name of the extra data, with package prefix.
7796 * @param value The IBinder data value.
7797 *
7798 * @return Returns the same Intent object, for chaining multiple calls
7799 * into a single statement.
7800 *
7801 * @see #putExtras
7802 * @see #removeExtra
7803 * @see #getIBinderExtra(String)
7804 *
7805 * @deprecated
7806 * @hide
7807 */
7808 @Deprecated
7809 public Intent putExtra(String name, IBinder value) {
7810 if (mExtras == null) {
7811 mExtras = new Bundle();
7812 }
7813 mExtras.putIBinder(name, value);
7814 return this;
7815 }
7816
7817 /**
7818 * Copy all extras in 'src' in to this intent.
7819 *
7820 * @param src Contains the extras to copy.
7821 *
7822 * @see #putExtra
7823 */
7824 public Intent putExtras(Intent src) {
7825 if (src.mExtras != null) {
7826 if (mExtras == null) {
7827 mExtras = new Bundle(src.mExtras);
7828 } else {
7829 mExtras.putAll(src.mExtras);
7830 }
7831 }
7832 return this;
7833 }
7834
7835 /**
7836 * Add a set of extended data to the intent. The keys must include a package
7837 * prefix, for example the app com.android.contacts would use names
7838 * like "com.android.contacts.ShowAll".
7839 *
7840 * @param extras The Bundle of extras to add to this intent.
7841 *
7842 * @see #putExtra
7843 * @see #removeExtra
7844 */
7845 public Intent putExtras(Bundle extras) {
7846 if (mExtras == null) {
7847 mExtras = new Bundle();
7848 }
7849 mExtras.putAll(extras);
7850 return this;
7851 }
7852
7853 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007854 * Completely replace the extras in the Intent with the extras in the
7855 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007856 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007857 * @param src The exact extras contained in this Intent are copied
7858 * into the target intent, replacing any that were previously there.
7859 */
7860 public Intent replaceExtras(Intent src) {
7861 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7862 return this;
7863 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007864
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007865 /**
7866 * Completely replace the extras in the Intent with the given Bundle of
7867 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007868 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007869 * @param extras The new set of extras in the Intent, or null to erase
7870 * all extras.
7871 */
7872 public Intent replaceExtras(Bundle extras) {
7873 mExtras = extras != null ? new Bundle(extras) : null;
7874 return this;
7875 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007876
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007877 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007878 * Remove extended data from the intent.
7879 *
7880 * @see #putExtra
7881 */
7882 public void removeExtra(String name) {
7883 if (mExtras != null) {
7884 mExtras.remove(name);
7885 if (mExtras.size() == 0) {
7886 mExtras = null;
7887 }
7888 }
7889 }
7890
7891 /**
7892 * Set special flags controlling how this intent is handled. Most values
7893 * here depend on the type of component being executed by the Intent,
7894 * specifically the FLAG_ACTIVITY_* flags are all for use with
7895 * {@link Context#startActivity Context.startActivity()} and the
7896 * FLAG_RECEIVER_* flags are all for use with
7897 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7898 *
Scott Main7aee61f2011-02-08 11:25:01 -08007899 * <p>See the
7900 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7901 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007902 * the behavior of your application.
7903 *
7904 * @param flags The desired flags.
7905 *
7906 * @return Returns the same Intent object, for chaining multiple calls
7907 * into a single statement.
7908 *
7909 * @see #getFlags
7910 * @see #addFlags
7911 *
7912 * @see #FLAG_GRANT_READ_URI_PERMISSION
7913 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007914 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7915 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007916 * @see #FLAG_DEBUG_LOG_RESOLUTION
7917 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007918 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007919 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007920 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007921 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007922 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7923 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007924 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007925 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007926 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007927 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007928 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007929 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007930 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007931 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7932 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007933 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007934 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007935 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007936 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7937 */
7938 public Intent setFlags(int flags) {
7939 mFlags = flags;
7940 return this;
7941 }
7942
7943 /**
7944 * Add additional flags to the intent (or with existing flags
7945 * value).
7946 *
7947 * @param flags The new flags to set.
7948 *
7949 * @return Returns the same Intent object, for chaining multiple calls
7950 * into a single statement.
7951 *
7952 * @see #setFlags
7953 */
7954 public Intent addFlags(int flags) {
7955 mFlags |= flags;
7956 return this;
7957 }
7958
7959 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007960 * (Usually optional) Set an explicit application package name that limits
7961 * the components this Intent will resolve to. If left to the default
7962 * value of null, all components in all applications will considered.
7963 * If non-null, the Intent can only match the components in the given
7964 * application package.
7965 *
7966 * @param packageName The name of the application package to handle the
7967 * intent, or null to allow any application package.
7968 *
7969 * @return Returns the same Intent object, for chaining multiple calls
7970 * into a single statement.
7971 *
7972 * @see #getPackage
7973 * @see #resolveActivity
7974 */
7975 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007976 if (packageName != null && mSelector != null) {
7977 throw new IllegalArgumentException(
7978 "Can't set package name when selector is already set");
7979 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007980 mPackage = packageName;
7981 return this;
7982 }
7983
7984 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007985 * (Usually optional) Explicitly set the component to handle the intent.
7986 * If left with the default value of null, the system will determine the
7987 * appropriate class to use based on the other fields (action, data,
7988 * type, categories) in the Intent. If this class is defined, the
7989 * specified class will always be used regardless of the other fields. You
7990 * should only set this value when you know you absolutely want a specific
7991 * class to be used; otherwise it is better to let the system find the
7992 * appropriate class so that you will respect the installed applications
7993 * and user preferences.
7994 *
7995 * @param component The name of the application component to handle the
7996 * intent, or null to let the system find one for you.
7997 *
7998 * @return Returns the same Intent object, for chaining multiple calls
7999 * into a single statement.
8000 *
8001 * @see #setClass
8002 * @see #setClassName(Context, String)
8003 * @see #setClassName(String, String)
8004 * @see #getComponent
8005 * @see #resolveActivity
8006 */
8007 public Intent setComponent(ComponentName component) {
8008 mComponent = component;
8009 return this;
8010 }
8011
8012 /**
8013 * Convenience for calling {@link #setComponent} with an
8014 * explicit class name.
8015 *
8016 * @param packageContext A Context of the application package implementing
8017 * this class.
8018 * @param className The name of a class inside of the application package
8019 * that will be used as the component for this Intent.
8020 *
8021 * @return Returns the same Intent object, for chaining multiple calls
8022 * into a single statement.
8023 *
8024 * @see #setComponent
8025 * @see #setClass
8026 */
8027 public Intent setClassName(Context packageContext, String className) {
8028 mComponent = new ComponentName(packageContext, className);
8029 return this;
8030 }
8031
8032 /**
8033 * Convenience for calling {@link #setComponent} with an
8034 * explicit application package name and class name.
8035 *
8036 * @param packageName The name of the package implementing the desired
8037 * component.
8038 * @param className The name of a class inside of the application package
8039 * that will be used as the component for this Intent.
8040 *
8041 * @return Returns the same Intent object, for chaining multiple calls
8042 * into a single statement.
8043 *
8044 * @see #setComponent
8045 * @see #setClass
8046 */
8047 public Intent setClassName(String packageName, String className) {
8048 mComponent = new ComponentName(packageName, className);
8049 return this;
8050 }
8051
8052 /**
8053 * Convenience for calling {@link #setComponent(ComponentName)} with the
8054 * name returned by a {@link Class} object.
8055 *
8056 * @param packageContext A Context of the application package implementing
8057 * this class.
8058 * @param cls The class name to set, equivalent to
8059 * <code>setClassName(context, cls.getName())</code>.
8060 *
8061 * @return Returns the same Intent object, for chaining multiple calls
8062 * into a single statement.
8063 *
8064 * @see #setComponent
8065 */
8066 public Intent setClass(Context packageContext, Class<?> cls) {
8067 mComponent = new ComponentName(packageContext, cls);
8068 return this;
8069 }
8070
8071 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008072 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8073 * used as a hint to the receiver for animations and the like. Null means that there
8074 * is no source bounds.
8075 */
8076 public void setSourceBounds(Rect r) {
8077 if (r != null) {
8078 mSourceBounds = new Rect(r);
8079 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008080 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008081 }
8082 }
8083
Tor Norbyed9273d62013-05-30 15:59:53 -07008084 /** @hide */
8085 @IntDef(flag = true,
8086 value = {
8087 FILL_IN_ACTION,
8088 FILL_IN_DATA,
8089 FILL_IN_CATEGORIES,
8090 FILL_IN_COMPONENT,
8091 FILL_IN_PACKAGE,
8092 FILL_IN_SOURCE_BOUNDS,
8093 FILL_IN_SELECTOR,
8094 FILL_IN_CLIP_DATA
8095 })
8096 @Retention(RetentionPolicy.SOURCE)
8097 public @interface FillInFlags {}
8098
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008099 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008100 * Use with {@link #fillIn} to allow the current action value to be
8101 * overwritten, even if it is already set.
8102 */
8103 public static final int FILL_IN_ACTION = 1<<0;
8104
8105 /**
8106 * Use with {@link #fillIn} to allow the current data or type value
8107 * overwritten, even if it is already set.
8108 */
8109 public static final int FILL_IN_DATA = 1<<1;
8110
8111 /**
8112 * Use with {@link #fillIn} to allow the current categories to be
8113 * overwritten, even if they are already set.
8114 */
8115 public static final int FILL_IN_CATEGORIES = 1<<2;
8116
8117 /**
8118 * Use with {@link #fillIn} to allow the current component value to be
8119 * overwritten, even if it is already set.
8120 */
8121 public static final int FILL_IN_COMPONENT = 1<<3;
8122
8123 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008124 * Use with {@link #fillIn} to allow the current package value to be
8125 * overwritten, even if it is already set.
8126 */
8127 public static final int FILL_IN_PACKAGE = 1<<4;
8128
8129 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008130 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008131 * overwritten, even if it is already set.
8132 */
8133 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8134
8135 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008136 * Use with {@link #fillIn} to allow the current selector to be
8137 * overwritten, even if it is already set.
8138 */
8139 public static final int FILL_IN_SELECTOR = 1<<6;
8140
8141 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008142 * Use with {@link #fillIn} to allow the current ClipData to be
8143 * overwritten, even if it is already set.
8144 */
8145 public static final int FILL_IN_CLIP_DATA = 1<<7;
8146
8147 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008148 * Copy the contents of <var>other</var> in to this object, but only
8149 * where fields are not defined by this object. For purposes of a field
8150 * being defined, the following pieces of data in the Intent are
8151 * considered to be separate fields:
8152 *
8153 * <ul>
8154 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008155 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008156 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8157 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008158 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008159 * <li> component, as set by {@link #setComponent(ComponentName)} or
8160 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008161 * <li> source bounds, as set by {@link #setSourceBounds}.
8162 * <li> selector, as set by {@link #setSelector(Intent)}.
8163 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008164 * <li> each top-level name in the associated extras.
8165 * </ul>
8166 *
8167 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008168 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008169 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8170 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8171 * the restriction where the corresponding field will not be replaced if
8172 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008173 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008174 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8175 * is explicitly specified. The selector will only be copied if
8176 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008177 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008178 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8179 * and Intent B with {action="gotit", data-type="some/thing",
8180 * categories="one","two"}.
8181 *
8182 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8183 * containing: {action="gotit", data-type="some/thing",
8184 * categories="bar"}.
8185 *
8186 * @param other Another Intent whose values are to be used to fill in
8187 * the current one.
8188 * @param flags Options to control which fields can be filled in.
8189 *
8190 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008191 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008192 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8193 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8194 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008195 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008196 @FillInFlags
8197 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008198 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008199 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008200 if (other.mAction != null
8201 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008202 mAction = other.mAction;
8203 changes |= FILL_IN_ACTION;
8204 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008205 if ((other.mData != null || other.mType != null)
8206 && ((mData == null && mType == null)
8207 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008208 mData = other.mData;
8209 mType = other.mType;
8210 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008211 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008212 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008213 if (other.mCategories != null
8214 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008215 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008216 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008217 }
8218 changes |= FILL_IN_CATEGORIES;
8219 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008220 if (other.mPackage != null
8221 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008222 // Only do this if mSelector is not set.
8223 if (mSelector == null) {
8224 mPackage = other.mPackage;
8225 changes |= FILL_IN_PACKAGE;
8226 }
8227 }
8228 // Selector is special: it can only be set if explicitly allowed,
8229 // for the same reason as the component name.
8230 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8231 if (mPackage == null) {
8232 mSelector = new Intent(other.mSelector);
8233 mPackage = null;
8234 changes |= FILL_IN_SELECTOR;
8235 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008236 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008237 if (other.mClipData != null
8238 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8239 mClipData = other.mClipData;
8240 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008241 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008242 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008243 // Component is special: it can -only- be set if explicitly allowed,
8244 // since otherwise the sender could force the intent somewhere the
8245 // originator didn't intend.
8246 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008247 mComponent = other.mComponent;
8248 changes |= FILL_IN_COMPONENT;
8249 }
8250 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008251 if (other.mSourceBounds != null
8252 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8253 mSourceBounds = new Rect(other.mSourceBounds);
8254 changes |= FILL_IN_SOURCE_BOUNDS;
8255 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008256 if (mExtras == null) {
8257 if (other.mExtras != null) {
8258 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008259 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008260 }
8261 } else if (other.mExtras != null) {
8262 try {
8263 Bundle newb = new Bundle(other.mExtras);
8264 newb.putAll(mExtras);
8265 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008266 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008267 } catch (RuntimeException e) {
8268 // Modifying the extras can cause us to unparcel the contents
8269 // of the bundle, and if we do this in the system process that
8270 // may fail. We really should handle this (i.e., the Bundle
8271 // impl shouldn't be on top of a plain map), but for now just
8272 // ignore it and keep the original contents. :(
8273 Log.w("Intent", "Failure filling in extras", e);
8274 }
8275 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008276 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8277 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8278 mContentUserHint = other.mContentUserHint;
8279 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008280 return changes;
8281 }
8282
8283 /**
8284 * Wrapper class holding an Intent and implementing comparisons on it for
8285 * the purpose of filtering. The class implements its
8286 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8287 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8288 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8289 * on the wrapped Intent.
8290 */
8291 public static final class FilterComparison {
8292 private final Intent mIntent;
8293 private final int mHashCode;
8294
8295 public FilterComparison(Intent intent) {
8296 mIntent = intent;
8297 mHashCode = intent.filterHashCode();
8298 }
8299
8300 /**
8301 * Return the Intent that this FilterComparison represents.
8302 * @return Returns the Intent held by the FilterComparison. Do
8303 * not modify!
8304 */
8305 public Intent getIntent() {
8306 return mIntent;
8307 }
8308
8309 @Override
8310 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008311 if (obj instanceof FilterComparison) {
8312 Intent other = ((FilterComparison)obj).mIntent;
8313 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008314 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008315 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008316 }
8317
8318 @Override
8319 public int hashCode() {
8320 return mHashCode;
8321 }
8322 }
8323
8324 /**
8325 * Determine if two intents are the same for the purposes of intent
8326 * resolution (filtering). That is, if their action, data, type,
8327 * class, and categories are the same. This does <em>not</em> compare
8328 * any extra data included in the intents.
8329 *
8330 * @param other The other Intent to compare against.
8331 *
8332 * @return Returns true if action, data, type, class, and categories
8333 * are the same.
8334 */
8335 public boolean filterEquals(Intent other) {
8336 if (other == null) {
8337 return false;
8338 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008339 if (!Objects.equals(this.mAction, other.mAction)) return false;
8340 if (!Objects.equals(this.mData, other.mData)) return false;
8341 if (!Objects.equals(this.mType, other.mType)) return false;
8342 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8343 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8344 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008345
8346 return true;
8347 }
8348
8349 /**
8350 * Generate hash code that matches semantics of filterEquals().
8351 *
8352 * @return Returns the hash value of the action, data, type, class, and
8353 * categories.
8354 *
8355 * @see #filterEquals
8356 */
8357 public int filterHashCode() {
8358 int code = 0;
8359 if (mAction != null) {
8360 code += mAction.hashCode();
8361 }
8362 if (mData != null) {
8363 code += mData.hashCode();
8364 }
8365 if (mType != null) {
8366 code += mType.hashCode();
8367 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008368 if (mPackage != null) {
8369 code += mPackage.hashCode();
8370 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008371 if (mComponent != null) {
8372 code += mComponent.hashCode();
8373 }
8374 if (mCategories != null) {
8375 code += mCategories.hashCode();
8376 }
8377 return code;
8378 }
8379
8380 @Override
8381 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008382 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008383
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008384 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008385 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008386 b.append(" }");
8387
8388 return b.toString();
8389 }
8390
8391 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008392 public String toInsecureString() {
8393 StringBuilder b = new StringBuilder(128);
8394
8395 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008396 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008397 b.append(" }");
8398
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008399 return b.toString();
8400 }
Romain Guy4969af72009-06-17 10:53:19 -07008401
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008402 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008403 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008404 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008405
8406 b.append("Intent { ");
8407 toShortString(b, false, true, true, true);
8408 b.append(" }");
8409
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008410 return b.toString();
8411 }
8412
8413 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008414 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8415 StringBuilder b = new StringBuilder(128);
8416 toShortString(b, secure, comp, extras, clip);
8417 return b.toString();
8418 }
8419
8420 /** @hide */
8421 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8422 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008423 boolean first = true;
8424 if (mAction != null) {
8425 b.append("act=").append(mAction);
8426 first = false;
8427 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008428 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008429 if (!first) {
8430 b.append(' ');
8431 }
8432 first = false;
8433 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008434 for (int i=0; i<mCategories.size(); i++) {
8435 if (i > 0) b.append(',');
8436 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008437 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008438 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008439 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008440 if (mData != null) {
8441 if (!first) {
8442 b.append(' ');
8443 }
8444 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008445 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008446 if (secure) {
8447 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008448 } else {
8449 b.append(mData);
8450 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008451 }
8452 if (mType != null) {
8453 if (!first) {
8454 b.append(' ');
8455 }
8456 first = false;
8457 b.append("typ=").append(mType);
8458 }
8459 if (mFlags != 0) {
8460 if (!first) {
8461 b.append(' ');
8462 }
8463 first = false;
8464 b.append("flg=0x").append(Integer.toHexString(mFlags));
8465 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008466 if (mPackage != null) {
8467 if (!first) {
8468 b.append(' ');
8469 }
8470 first = false;
8471 b.append("pkg=").append(mPackage);
8472 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008473 if (comp && mComponent != null) {
8474 if (!first) {
8475 b.append(' ');
8476 }
8477 first = false;
8478 b.append("cmp=").append(mComponent.flattenToShortString());
8479 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008480 if (mSourceBounds != null) {
8481 if (!first) {
8482 b.append(' ');
8483 }
8484 first = false;
8485 b.append("bnds=").append(mSourceBounds.toShortString());
8486 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008487 if (mClipData != null) {
8488 if (!first) {
8489 b.append(' ');
8490 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008491 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008492 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008493 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008494 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008495 if (mClipData.getDescription() != null) {
8496 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8497 } else {
8498 first = true;
8499 }
8500 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008501 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008502 first = false;
8503 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008504 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008505 if (extras && mExtras != null) {
8506 if (!first) {
8507 b.append(' ');
8508 }
8509 first = false;
8510 b.append("(has extras)");
8511 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008512 if (mContentUserHint != UserHandle.USER_CURRENT) {
8513 if (!first) {
8514 b.append(' ');
8515 }
8516 first = false;
8517 b.append("u=").append(mContentUserHint);
8518 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008519 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008520 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008521 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008522 b.append("}");
8523 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008524 }
8525
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008526 /**
8527 * Call {@link #toUri} with 0 flags.
8528 * @deprecated Use {@link #toUri} instead.
8529 */
8530 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008531 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008532 return toUri(0);
8533 }
8534
8535 /**
8536 * Convert this Intent into a String holding a URI representation of it.
8537 * The returned URI string has been properly URI encoded, so it can be
8538 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8539 * Intent's data as the base URI, with an additional fragment describing
8540 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008541 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008542 * <p>You can convert the returned string back to an Intent with
8543 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008544 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008545 * @param flags Additional operating flags. Either 0,
8546 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008547 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008548 * @return Returns a URI encoding URI string describing the entire contents
8549 * of the Intent.
8550 */
8551 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008552 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008553 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8554 if (mPackage == null) {
8555 throw new IllegalArgumentException(
8556 "Intent must include an explicit package name to build an android-app: "
8557 + this);
8558 }
8559 uri.append("android-app://");
8560 uri.append(mPackage);
8561 String scheme = null;
8562 if (mData != null) {
8563 scheme = mData.getScheme();
8564 if (scheme != null) {
8565 uri.append('/');
8566 uri.append(scheme);
8567 String authority = mData.getEncodedAuthority();
8568 if (authority != null) {
8569 uri.append('/');
8570 uri.append(authority);
8571 String path = mData.getEncodedPath();
8572 if (path != null) {
8573 uri.append(path);
8574 }
8575 String queryParams = mData.getEncodedQuery();
8576 if (queryParams != null) {
8577 uri.append('?');
8578 uri.append(queryParams);
8579 }
8580 String fragment = mData.getEncodedFragment();
8581 if (fragment != null) {
8582 uri.append('#');
8583 uri.append(fragment);
8584 }
8585 }
8586 }
8587 }
8588 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8589 mPackage, flags);
8590 return uri.toString();
8591 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008592 String scheme = null;
8593 if (mData != null) {
8594 String data = mData.toString();
8595 if ((flags&URI_INTENT_SCHEME) != 0) {
8596 final int N = data.length();
8597 for (int i=0; i<N; i++) {
8598 char c = data.charAt(i);
8599 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8600 || c == '.' || c == '-') {
8601 continue;
8602 }
8603 if (c == ':' && i > 0) {
8604 // Valid scheme.
8605 scheme = data.substring(0, i);
8606 uri.append("intent:");
8607 data = data.substring(i+1);
8608 break;
8609 }
Tom Taylord4a47292009-12-21 13:59:18 -08008610
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008611 // No scheme.
8612 break;
8613 }
8614 }
8615 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008616
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008617 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8618 uri.append("intent:");
8619 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008620
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008621 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008622
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008623 return uri.toString();
8624 }
8625
8626 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8627 String defPackage, int flags) {
8628 StringBuilder frag = new StringBuilder(128);
8629
8630 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008631 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008632 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008633 // Note that for now we are not going to try to handle the
8634 // data part; not clear how to represent this as a URI, and
8635 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008636 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8637 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008638 }
8639
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008640 if (frag.length() > 0) {
8641 uri.append("#Intent;");
8642 uri.append(frag);
8643 uri.append("end");
8644 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008645 }
8646
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008647 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8648 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008649 if (scheme != null) {
8650 uri.append("scheme=").append(scheme).append(';');
8651 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008652 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008653 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008654 }
8655 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008656 for (int i=0; i<mCategories.size(); i++) {
8657 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008658 }
8659 }
8660 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008661 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008662 }
8663 if (mFlags != 0) {
8664 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8665 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008666 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008667 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8668 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008669 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008670 uri.append("component=").append(Uri.encode(
8671 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008672 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008673 if (mSourceBounds != null) {
8674 uri.append("sourceBounds=")
8675 .append(Uri.encode(mSourceBounds.flattenToString()))
8676 .append(';');
8677 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008678 if (mExtras != null) {
8679 for (String key : mExtras.keySet()) {
8680 final Object value = mExtras.get(key);
8681 char entryType =
8682 value instanceof String ? 'S' :
8683 value instanceof Boolean ? 'B' :
8684 value instanceof Byte ? 'b' :
8685 value instanceof Character ? 'c' :
8686 value instanceof Double ? 'd' :
8687 value instanceof Float ? 'f' :
8688 value instanceof Integer ? 'i' :
8689 value instanceof Long ? 'l' :
8690 value instanceof Short ? 's' :
8691 '\0';
8692
8693 if (entryType != '\0') {
8694 uri.append(entryType);
8695 uri.append('.');
8696 uri.append(Uri.encode(key));
8697 uri.append('=');
8698 uri.append(Uri.encode(value.toString()));
8699 uri.append(';');
8700 }
8701 }
8702 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008703 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008704
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008705 public int describeContents() {
8706 return (mExtras != null) ? mExtras.describeContents() : 0;
8707 }
8708
8709 public void writeToParcel(Parcel out, int flags) {
8710 out.writeString(mAction);
8711 Uri.writeToParcel(out, mData);
8712 out.writeString(mType);
8713 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008714 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008715 ComponentName.writeToParcel(mComponent, out);
8716
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008717 if (mSourceBounds != null) {
8718 out.writeInt(1);
8719 mSourceBounds.writeToParcel(out, flags);
8720 } else {
8721 out.writeInt(0);
8722 }
8723
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008724 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008725 final int N = mCategories.size();
8726 out.writeInt(N);
8727 for (int i=0; i<N; i++) {
8728 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008729 }
8730 } else {
8731 out.writeInt(0);
8732 }
8733
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008734 if (mSelector != null) {
8735 out.writeInt(1);
8736 mSelector.writeToParcel(out, flags);
8737 } else {
8738 out.writeInt(0);
8739 }
8740
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008741 if (mClipData != null) {
8742 out.writeInt(1);
8743 mClipData.writeToParcel(out, flags);
8744 } else {
8745 out.writeInt(0);
8746 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008747 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008748 out.writeBundle(mExtras);
8749 }
8750
8751 public static final Parcelable.Creator<Intent> CREATOR
8752 = new Parcelable.Creator<Intent>() {
8753 public Intent createFromParcel(Parcel in) {
8754 return new Intent(in);
8755 }
8756 public Intent[] newArray(int size) {
8757 return new Intent[size];
8758 }
8759 };
8760
Dianne Hackborneb034652009-09-07 00:49:58 -07008761 /** @hide */
8762 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008763 readFromParcel(in);
8764 }
8765
8766 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008767 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008768 mData = Uri.CREATOR.createFromParcel(in);
8769 mType = in.readString();
8770 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008771 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008772 mComponent = ComponentName.readFromParcel(in);
8773
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008774 if (in.readInt() != 0) {
8775 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8776 }
8777
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008778 int N = in.readInt();
8779 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008780 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008781 int i;
8782 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008783 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008784 }
8785 } else {
8786 mCategories = null;
8787 }
8788
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008789 if (in.readInt() != 0) {
8790 mSelector = new Intent(in);
8791 }
8792
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008793 if (in.readInt() != 0) {
8794 mClipData = new ClipData(in);
8795 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008796 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008797 mExtras = in.readBundle();
8798 }
8799
8800 /**
8801 * Parses the "intent" element (and its children) from XML and instantiates
8802 * an Intent object. The given XML parser should be located at the tag
8803 * where parsing should start (often named "intent"), from which the
8804 * basic action, data, type, and package and class name will be
8805 * retrieved. The function will then parse in to any child elements,
8806 * looking for <category android:name="xxx"> tags to add categories and
8807 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8808 * to the intent.
8809 *
8810 * @param resources The Resources to use when inflating resources.
8811 * @param parser The XML parser pointing at an "intent" tag.
8812 * @param attrs The AttributeSet interface for retrieving extended
8813 * attribute data at the current <var>parser</var> location.
8814 * @return An Intent object matching the XML data.
8815 * @throws XmlPullParserException If there was an XML parsing error.
8816 * @throws IOException If there was an I/O error.
8817 */
8818 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8819 throws XmlPullParserException, IOException {
8820 Intent intent = new Intent();
8821
8822 TypedArray sa = resources.obtainAttributes(attrs,
8823 com.android.internal.R.styleable.Intent);
8824
8825 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8826
8827 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8828 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8829 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8830
8831 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8832 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8833 if (packageName != null && className != null) {
8834 intent.setComponent(new ComponentName(packageName, className));
8835 }
8836
8837 sa.recycle();
8838
8839 int outerDepth = parser.getDepth();
8840 int type;
8841 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8842 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8843 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8844 continue;
8845 }
8846
8847 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008848 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008849 sa = resources.obtainAttributes(attrs,
8850 com.android.internal.R.styleable.IntentCategory);
8851 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8852 sa.recycle();
8853
8854 if (cat != null) {
8855 intent.addCategory(cat);
8856 }
8857 XmlUtils.skipCurrentTag(parser);
8858
Craig Mautner21d24a22014-04-23 11:45:37 -07008859 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008860 if (intent.mExtras == null) {
8861 intent.mExtras = new Bundle();
8862 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008863 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008864 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008865
8866 } else {
8867 XmlUtils.skipCurrentTag(parser);
8868 }
8869 }
8870
8871 return intent;
8872 }
Nick Pellyccae4122012-01-09 14:12:58 -08008873
Craig Mautner21d24a22014-04-23 11:45:37 -07008874 /** @hide */
8875 public void saveToXml(XmlSerializer out) throws IOException {
8876 if (mAction != null) {
8877 out.attribute(null, ATTR_ACTION, mAction);
8878 }
8879 if (mData != null) {
8880 out.attribute(null, ATTR_DATA, mData.toString());
8881 }
8882 if (mType != null) {
8883 out.attribute(null, ATTR_TYPE, mType);
8884 }
8885 if (mComponent != null) {
8886 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8887 }
8888 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8889
8890 if (mCategories != null) {
8891 out.startTag(null, TAG_CATEGORIES);
8892 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8893 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8894 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008895 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008896 }
8897 }
8898
8899 /** @hide */
8900 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8901 XmlPullParserException {
8902 Intent intent = new Intent();
8903 final int outerDepth = in.getDepth();
8904
8905 int attrCount = in.getAttributeCount();
8906 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8907 final String attrName = in.getAttributeName(attrNdx);
8908 final String attrValue = in.getAttributeValue(attrNdx);
8909 if (ATTR_ACTION.equals(attrName)) {
8910 intent.setAction(attrValue);
8911 } else if (ATTR_DATA.equals(attrName)) {
8912 intent.setData(Uri.parse(attrValue));
8913 } else if (ATTR_TYPE.equals(attrName)) {
8914 intent.setType(attrValue);
8915 } else if (ATTR_COMPONENT.equals(attrName)) {
8916 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8917 } else if (ATTR_FLAGS.equals(attrName)) {
Narayan Kamatha09b4d22016-04-15 18:32:45 +01008918 intent.setFlags(Integer.parseInt(attrValue, 16));
Craig Mautner21d24a22014-04-23 11:45:37 -07008919 } else {
8920 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8921 }
8922 }
8923
8924 int event;
8925 String name;
8926 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8927 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8928 if (event == XmlPullParser.START_TAG) {
8929 name = in.getName();
8930 if (TAG_CATEGORIES.equals(name)) {
8931 attrCount = in.getAttributeCount();
8932 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8933 intent.addCategory(in.getAttributeValue(attrNdx));
8934 }
8935 } else {
8936 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8937 XmlUtils.skipCurrentTag(in);
8938 }
8939 }
8940 }
8941
8942 return intent;
8943 }
8944
Nick Pellyccae4122012-01-09 14:12:58 -08008945 /**
8946 * Normalize a MIME data type.
8947 *
8948 * <p>A normalized MIME type has white-space trimmed,
8949 * content-type parameters removed, and is lower-case.
8950 * This aligns the type with Android best practices for
8951 * intent filtering.
8952 *
8953 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8954 * "text/x-vCard" becomes "text/x-vcard".
8955 *
8956 * <p>All MIME types received from outside Android (such as user input,
8957 * or external sources like Bluetooth, NFC, or the Internet) should
8958 * be normalized before they are used to create an Intent.
8959 *
8960 * @param type MIME data type to normalize
8961 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008962 * @see #setType
8963 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008964 */
8965 public static String normalizeMimeType(String type) {
8966 if (type == null) {
8967 return null;
8968 }
8969
Elliott Hughescb64d432013-08-02 10:00:44 -07008970 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008971
8972 final int semicolonIndex = type.indexOf(';');
8973 if (semicolonIndex != -1) {
8974 type = type.substring(0, semicolonIndex);
8975 }
8976 return type;
8977 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008978
8979 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008980 * Prepare this {@link Intent} to leave an app process.
8981 *
8982 * @hide
8983 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008984 public void prepareToLeaveProcess(Context context) {
8985 final boolean leavingPackage = (mComponent == null)
8986 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8987 prepareToLeaveProcess(leavingPackage);
8988 }
8989
8990 /**
8991 * Prepare this {@link Intent} to leave an app process.
8992 *
8993 * @hide
8994 */
8995 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008996 setAllowFds(false);
8997
8998 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008999 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009000 }
9001 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009002 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009003 }
9004
Jeff Sharkeya8b42782016-01-30 17:58:09 -07009005 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
9006 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07009007 switch (mAction) {
9008 case ACTION_MEDIA_REMOVED:
9009 case ACTION_MEDIA_UNMOUNTED:
9010 case ACTION_MEDIA_CHECKING:
9011 case ACTION_MEDIA_NOFS:
9012 case ACTION_MEDIA_MOUNTED:
9013 case ACTION_MEDIA_SHARED:
9014 case ACTION_MEDIA_UNSHARED:
9015 case ACTION_MEDIA_BAD_REMOVAL:
9016 case ACTION_MEDIA_UNMOUNTABLE:
9017 case ACTION_MEDIA_EJECT:
9018 case ACTION_MEDIA_SCANNER_STARTED:
9019 case ACTION_MEDIA_SCANNER_FINISHED:
9020 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07009021 case ACTION_PACKAGE_NEEDS_VERIFICATION:
9022 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07009023 // Ignore legacy actions
9024 break;
9025 default:
9026 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07009027 }
9028 }
9029 }
9030
9031 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009032 * @hide
9033 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009034 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07009035 // We just entered destination process, so we should be able to read all
9036 // parcelables inside.
9037 setDefusable(true);
9038
9039 if (mSelector != null) {
9040 mSelector.prepareToEnterProcess();
9041 }
9042 if (mClipData != null) {
9043 mClipData.prepareToEnterProcess();
9044 }
9045
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009046 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00009047 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
9048 fixUris(mContentUserHint);
9049 mContentUserHint = UserHandle.USER_CURRENT;
9050 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009051 }
9052 }
9053
9054 /**
9055 * @hide
9056 */
9057 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009058 Uri data = getData();
9059 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009060 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009061 }
9062 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009063 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009064 }
9065 String action = getAction();
9066 if (ACTION_SEND.equals(action)) {
9067 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9068 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009069 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009070 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009071 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009072 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9073 if (streams != null) {
9074 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9075 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009076 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009077 }
9078 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9079 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009080 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9081 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9082 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9083 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9084 if (output != null) {
9085 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9086 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009087 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009088 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009089
9090 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009091 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009092 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9093 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009094 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009095 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009096 * @hide
9097 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009098 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009099 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009100 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009101
9102 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009103 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009104
9105 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009106 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009107 // Inspect contained intents to see if we need to migrate extras. We
9108 // don't promote ClipData to the parent, since ChooserActivity will
9109 // already start the picked item as the caller, and we can't combine
9110 // the flags in a safe way.
9111
9112 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009113 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009114 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9115 if (intent != null) {
9116 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009117 }
9118 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009119 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009120 try {
9121 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9122 if (intents != null) {
9123 for (int i = 0; i < intents.length; i++) {
9124 final Intent intent = (Intent) intents[i];
9125 if (intent != null) {
9126 migrated |= intent.migrateExtraStreamToClipData();
9127 }
9128 }
9129 }
9130 } catch (ClassCastException e) {
9131 }
9132 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009133
9134 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009135 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009136 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9137 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9138 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9139 if (stream != null || text != null || htmlText != null) {
9140 final ClipData clipData = new ClipData(
9141 null, new String[] { getType() },
9142 new ClipData.Item(text, htmlText, null, stream));
9143 setClipData(clipData);
9144 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009145 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009146 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009147 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009148 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009149
9150 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009151 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009152 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9153 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9154 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9155 int num = -1;
9156 if (streams != null) {
9157 num = streams.size();
9158 }
9159 if (texts != null) {
9160 if (num >= 0 && num != texts.size()) {
9161 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009162 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009163 }
9164 num = texts.size();
9165 }
9166 if (htmlTexts != null) {
9167 if (num >= 0 && num != htmlTexts.size()) {
9168 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009169 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009170 }
9171 num = htmlTexts.size();
9172 }
9173 if (num > 0) {
9174 final ClipData clipData = new ClipData(
9175 null, new String[] { getType() },
9176 makeClipItem(streams, texts, htmlTexts, 0));
9177
9178 for (int i = 1; i < num; i++) {
9179 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9180 }
9181
9182 setClipData(clipData);
9183 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009184 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009185 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009186 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009187 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009188 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9189 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9190 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9191 final Uri output;
9192 try {
9193 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9194 } catch (ClassCastException e) {
9195 return false;
9196 }
9197 if (output != null) {
9198 setClipData(ClipData.newRawUri("", output));
9199 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9200 return true;
9201 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009202 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009203
9204 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009205 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009206
9207 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9208 ArrayList<String> htmlTexts, int which) {
9209 Uri uri = streams != null ? streams.get(which) : null;
9210 CharSequence text = texts != null ? texts.get(which) : null;
9211 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9212 return new ClipData.Item(text, htmlText, null, uri);
9213 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009214
9215 /** @hide */
9216 public boolean isDocument() {
9217 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9218 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009219}