blob: 57ab7a2f937cb59d63b6ff7396d7298289e00070 [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 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800768 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700769 *
770 * @see Intent#ACTION_CREATE_SHORTCUT
771 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800772 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
773 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700774 */
775 public static class ShortcutIconResource implements Parcelable {
776 /**
777 * The package name of the application containing the icon.
778 */
779 public String packageName;
780
781 /**
782 * The resource name of the icon, including package, name and type.
783 */
784 public String resourceName;
785
786 /**
787 * Creates a new ShortcutIconResource for the specified context and resource
788 * identifier.
789 *
790 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700791 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700792 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700793 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700794 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700795 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700796 ShortcutIconResource icon = new ShortcutIconResource();
797 icon.packageName = context.getPackageName();
798 icon.resourceName = context.getResources().getResourceName(resourceId);
799 return icon;
800 }
801
802 /**
803 * Used to read a ShortcutIconResource from a Parcel.
804 */
805 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
806 new Parcelable.Creator<ShortcutIconResource>() {
807
808 public ShortcutIconResource createFromParcel(Parcel source) {
809 ShortcutIconResource icon = new ShortcutIconResource();
810 icon.packageName = source.readString();
811 icon.resourceName = source.readString();
812 return icon;
813 }
814
815 public ShortcutIconResource[] newArray(int size) {
816 return new ShortcutIconResource[size];
817 }
818 };
819
820 /**
821 * No special parcel contents.
822 */
823 public int describeContents() {
824 return 0;
825 }
826
827 public void writeToParcel(Parcel dest, int flags) {
828 dest.writeString(packageName);
829 dest.writeString(resourceName);
830 }
831
832 @Override
833 public String toString() {
834 return resourceName;
835 }
836 }
837
838 /**
839 * Activity Action: Display an activity chooser, allowing the user to pick
840 * what they want to before proceeding. This can be used as an alternative
841 * to the standard activity picker that is displayed by the system when
842 * you try to start an activity with multiple possible matches, with these
843 * differences in behavior:
844 * <ul>
845 * <li>You can specify the title that will appear in the activity chooser.
846 * <li>The user does not have the option to make one of the matching
847 * activities a preferred activity, and all possible activities will
848 * always be shown even if one of them is currently marked as the
849 * preferred activity.
850 * </ul>
851 * <p>
852 * This action should be used when the user will naturally expect to
853 * select an activity in order to proceed. An example if when not to use
854 * it is when the user clicks on a "mailto:" link. They would naturally
855 * expect to go directly to their mail app, so startActivity() should be
856 * called directly: it will
857 * either launch the current preferred app, or put up a dialog allowing the
858 * user to pick an app to use and optionally marking that as preferred.
859 * <p>
860 * In contrast, if the user is selecting a menu item to send a picture
861 * they are viewing to someone else, there are many different things they
862 * may want to do at this point: send it through e-mail, upload it to a
863 * web service, etc. In this case the CHOOSER action should be used, to
864 * always present to the user a list of the things they can do, with a
865 * nice title given by the caller such as "Send this photo with:".
866 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700867 * If you need to grant URI permissions through a chooser, you must specify
868 * the permissions to be granted on the ACTION_CHOOSER Intent
869 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
870 * {@link #setClipData} to specify the URIs to be granted as well as
871 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
872 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
873 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700874 * As a convenience, an Intent of this form can be created with the
875 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700876 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700878 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
879 * and can optionally have a {@link #EXTRA_TITLE} field containing the
880 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881 * <p>
882 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 */
884 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
885 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
886
887 /**
888 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
889 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700890 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
891 * target intent, also optionally supplying a title. If the target
892 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
893 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
894 * set in the returned chooser intent, with its ClipData set appropriately:
895 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500896 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700897 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700898 * @param target The Intent that the user will be selecting an activity
899 * to perform.
900 * @param title Optional title that will be displayed in the chooser.
901 * @return Return a new Intent object that you can hand to
902 * {@link Context#startActivity(Intent) Context.startActivity()} and
903 * related methods.
904 */
905 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700906 return createChooser(target, title, null);
907 }
908
909 /**
910 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
911 *
912 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
913 * target intent, also optionally supplying a title. If the target
914 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
915 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
916 * set in the returned chooser intent, with its ClipData set appropriately:
917 * either a direct reflection of {@link #getClipData()} if that is non-null,
918 * or a new ClipData built from {@link #getData()}.</p>
919 *
920 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
921 * when the user makes a choice. This can be useful if the calling application wants
922 * to remember the last chosen target and surface it as a more prominent or one-touch
923 * affordance elsewhere in the UI for next time.</p>
924 *
925 * @param target The Intent that the user will be selecting an activity
926 * to perform.
927 * @param title Optional title that will be displayed in the chooser.
928 * @param sender Optional IntentSender to be called when a choice is made.
929 * @return Return a new Intent object that you can hand to
930 * {@link Context#startActivity(Intent) Context.startActivity()} and
931 * related methods.
932 */
933 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 Intent intent = new Intent(ACTION_CHOOSER);
935 intent.putExtra(EXTRA_INTENT, target);
936 if (title != null) {
937 intent.putExtra(EXTRA_TITLE, title);
938 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700939
Adam Powell0b3c1122014-10-09 12:50:14 -0700940 if (sender != null) {
941 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
942 }
943
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700944 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700945 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
946 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
947 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700948 if (permFlags != 0) {
949 ClipData targetClipData = target.getClipData();
950 if (targetClipData == null && target.getData() != null) {
951 ClipData.Item item = new ClipData.Item(target.getData());
952 String[] mimeTypes;
953 if (target.getType() != null) {
954 mimeTypes = new String[] { target.getType() };
955 } else {
956 mimeTypes = new String[] { };
957 }
958 targetClipData = new ClipData(null, mimeTypes, item);
959 }
960 if (targetClipData != null) {
961 intent.setClipData(targetClipData);
962 intent.addFlags(permFlags);
963 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700964 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700965
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700966 return intent;
967 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700968
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700969 /**
970 * Activity Action: Allow the user to select a particular kind of data and
971 * return it. This is different than {@link #ACTION_PICK} in that here we
972 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800973 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700974 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900975 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700976 * etc.
977 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900978 * 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 -0700979 * of data, such as a person contact, you set the MIME type to the kind of
980 * data you want and launch it with {@link Context#startActivity(Intent)}.
981 * The system will then launch the best application to select that kind
982 * of data for you.
983 * <p>
984 * You may also be interested in any of a set of types of content the user
985 * can pick. For example, an e-mail application that wants to allow the
986 * user to add an attachment to an e-mail message can use this action to
987 * bring up a list of all of the types of content the user can attach.
988 * <p>
989 * In this case, you should wrap the GET_CONTENT intent with a chooser
990 * (through {@link #createChooser}), which will give the proper interface
991 * for the user to pick how to send your data and allow you to specify
992 * a prompt indicating what they are doing. You will usually specify a
993 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
994 * broad range of content types the user can select from.
995 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900996 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700997 * only pick from data that can be represented as a stream. This is
998 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
999 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001000 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001001 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001002 * is locally available on the device. For example, if this extra is set
1003 * to true then an image picker should not show any pictures that are available
1004 * from a remote server but not already on the local device (thus requiring
1005 * they be downloaded when opened).
1006 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001007 * If the caller can handle multiple returned items (the user performing
1008 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1009 * to indicate this.
1010 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1012 * that no URI is supplied in the intent, as there are no constraints on
1013 * where the returned data originally comes from. You may also include the
1014 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001015 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001016 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1017 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001018 * <p>
1019 * Output: The URI of the item that was picked. This must be a content:
1020 * URI so that any receiver can access it.
1021 */
1022 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1023 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1024 /**
1025 * Activity Action: Dial a number as specified by the data. This shows a
1026 * UI with the number being dialed, allowing the user to explicitly
1027 * initiate the call.
1028 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1029 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1030 * number.
1031 * <p>Output: nothing.
1032 */
1033 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1034 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1035 /**
1036 * Activity Action: Perform a call to someone specified by the data.
1037 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1038 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1039 * number.
1040 * <p>Output: nothing.
1041 *
1042 * <p>Note: there will be restrictions on which applications can initiate a
1043 * call; most applications should use the {@link #ACTION_DIAL}.
1044 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1045 * numbers. Applications can <strong>dial</strong> emergency numbers using
1046 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001047 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001048 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001049 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001050 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001051 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001052 */
1053 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1054 public static final String ACTION_CALL = "android.intent.action.CALL";
1055 /**
1056 * Activity Action: Perform a call to an emergency number specified by the
1057 * data.
1058 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1059 * tel: URI of an explicit phone number.
1060 * <p>Output: nothing.
1061 * @hide
1062 */
1063 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1064 /**
1065 * Activity action: Perform a call to any number (emergency or not)
1066 * specified by the data.
1067 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1068 * tel: URI of an explicit phone number.
1069 * <p>Output: nothing.
1070 * @hide
1071 */
1072 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1073 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001074 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1075 * sending this intent is a no-op.
1076 * <p>Input: No data should be specified. get*Extra may have an optional
1077 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1078 * send the activation result.
1079 * <p>Output: nothing.
1080 * @hide
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1084 "android.intent.action.SIM_ACTIVATION_REQUEST";
1085 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001086 * Activity Action: Send a message to someone specified by the data.
1087 * <p>Input: {@link #getData} is URI describing the target.
1088 * <p>Output: nothing.
1089 */
1090 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1091 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1092 /**
1093 * Activity Action: Deliver some data to someone else. Who the data is
1094 * being delivered to is not specified; it is up to the receiver of this
1095 * action to ask the user where the data should be sent.
1096 * <p>
1097 * When launching a SEND intent, you should usually wrap it in a chooser
1098 * (through {@link #createChooser}), which will give the proper interface
1099 * for the user to pick how to send your data and allow you to specify
1100 * a prompt indicating what they are doing.
1101 * <p>
1102 * Input: {@link #getType} is the MIME type of the data being sent.
1103 * get*Extra can have either a {@link #EXTRA_TEXT}
1104 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1105 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1106 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1107 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001108 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1109 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1110 * your text with HTML formatting.
1111 * <p>
1112 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1113 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1114 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1115 * content: URIs and other advanced features of {@link ClipData}. If
1116 * using this approach, you still must supply the same data through the
1117 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1118 * for compatibility with old applications. If you don't set a ClipData,
1119 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001120 * <p>
1121 * Optional standard extras, which may be interpreted by some recipients as
1122 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1123 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1124 * <p>
1125 * Output: nothing.
1126 */
1127 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1128 public static final String ACTION_SEND = "android.intent.action.SEND";
1129 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001130 * Activity Action: Deliver multiple data to someone else.
1131 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001132 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001133 * <p>
1134 * Input: {@link #getType} is the MIME type of the data being sent.
1135 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001136 * #EXTRA_STREAM} field, containing the data to be sent. If using
1137 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1138 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001139 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001140 * Multiple types are supported, and receivers should handle mixed types
1141 * whenever possible. The right way for the receiver to check them is to
1142 * use the content resolver on each URI. The intent sender should try to
1143 * put the most concrete mime type in the intent type, but it can fall
1144 * back to {@literal <type>/*} or {@literal *}/* as needed.
1145 * <p>
1146 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1147 * be image/jpg, but if you are sending image/jpg and image/png, then the
1148 * intent's type should be image/*.
1149 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001150 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1151 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1152 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1153 * content: URIs and other advanced features of {@link ClipData}. If
1154 * using this approach, you still must supply the same data through the
1155 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1156 * for compatibility with old applications. If you don't set a ClipData,
1157 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1158 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001159 * Optional standard extras, which may be interpreted by some recipients as
1160 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1161 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1162 * <p>
1163 * Output: nothing.
1164 */
1165 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1166 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1167 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001168 * Activity Action: Handle an incoming phone call.
1169 * <p>Input: nothing.
1170 * <p>Output: nothing.
1171 */
1172 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1173 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1174 /**
1175 * Activity Action: Insert an empty item into the given container.
1176 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1177 * in which to place the data.
1178 * <p>Output: URI of the new data that was created.
1179 */
1180 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1181 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1182 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001183 * Activity Action: Create a new item in the given container, initializing it
1184 * from the current contents of the clipboard.
1185 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1186 * in which to place the data.
1187 * <p>Output: URI of the new data that was created.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1191 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001192 * Activity Action: Delete the given data from its container.
1193 * <p>Input: {@link #getData} is URI of data to be deleted.
1194 * <p>Output: nothing.
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1198 /**
1199 * Activity Action: Run the data, whatever that means.
1200 * <p>Input: ? (Note: this is currently specific to the test harness.)
1201 * <p>Output: nothing.
1202 */
1203 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1204 public static final String ACTION_RUN = "android.intent.action.RUN";
1205 /**
1206 * Activity Action: Perform a data synchronization.
1207 * <p>Input: ?
1208 * <p>Output: ?
1209 */
1210 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1211 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1212 /**
1213 * Activity Action: Pick an activity given an intent, returning the class
1214 * selected.
1215 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1216 * used with {@link PackageManager#queryIntentActivities} to determine the
1217 * set of activities from which to pick.
1218 * <p>Output: Class name of the activity that was selected.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1222 /**
1223 * Activity Action: Perform a search.
1224 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1225 * is the text to search for. If empty, simply
1226 * enter your search results Activity with the search UI activated.
1227 * <p>Output: nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1231 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001232 * Activity Action: Start the platform-defined tutorial
1233 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1234 * is the text to search for. If empty, simply
1235 * enter your search results Activity with the search UI activated.
1236 * <p>Output: nothing.
1237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1240 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001241 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001242 * <p>
1243 * Input: {@link android.app.SearchManager#QUERY
1244 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1245 * a url starts with http or https, the site will be opened. If it is plain
1246 * text, Google search will be applied.
1247 * <p>
1248 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001249 */
1250 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1251 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001252
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001253 /**
Jim Miller07994402012-05-02 14:22:27 -07001254 * Activity Action: Perform assist action.
1255 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001256 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1257 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001258 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1259 * information.
Jim Miller07994402012-05-02 14:22:27 -07001260 * Output: nothing.
1261 */
1262 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1263 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001264
1265 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001266 * Activity Action: Perform voice assist action.
1267 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001268 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1269 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001270 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001271 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001272 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001273 */
1274 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1275 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1276
1277 /**
Adam Skory7140a252013-09-11 12:04:58 +01001278 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1279 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001280 */
1281 public static final String EXTRA_ASSIST_PACKAGE
1282 = "android.intent.extra.ASSIST_PACKAGE";
1283
1284 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001285 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1286 * application package at the time the assist was invoked.
1287 */
1288 public static final String EXTRA_ASSIST_UID
1289 = "android.intent.extra.ASSIST_UID";
1290
1291 /**
Adam Skory7140a252013-09-11 12:04:58 +01001292 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1293 * information supplied by the current foreground app at the time of the assist request.
1294 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001295 */
1296 public static final String EXTRA_ASSIST_CONTEXT
1297 = "android.intent.extra.ASSIST_CONTEXT";
1298
Jim Miller07994402012-05-02 14:22:27 -07001299 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001300 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1301 * keyboard as the primary input device for assistance.
1302 */
1303 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1304 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1305
1306 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001307 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1308 * that was used to invoke the assist.
1309 */
1310 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1311 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1312
1313 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 * Activity Action: List all available applications
1315 * <p>Input: Nothing.
1316 * <p>Output: nothing.
1317 */
1318 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1319 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1320 /**
1321 * Activity Action: Show settings for choosing wallpaper
1322 * <p>Input: Nothing.
1323 * <p>Output: Nothing.
1324 */
1325 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1326 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1327
1328 /**
1329 * Activity Action: Show activity for reporting a bug.
1330 * <p>Input: Nothing.
1331 * <p>Output: Nothing.
1332 */
1333 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1334 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1335
1336 /**
1337 * Activity Action: Main entry point for factory tests. Only used when
1338 * the device is booting in factory test node. The implementing package
1339 * must be installed in the system image.
1340 * <p>Input: nothing
1341 * <p>Output: nothing
1342 */
1343 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1344
1345 /**
1346 * Activity Action: The user pressed the "call" button to go to the dialer
1347 * or other appropriate UI for placing a call.
1348 * <p>Input: Nothing.
1349 * <p>Output: Nothing.
1350 */
1351 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1352 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1353
1354 /**
1355 * Activity Action: Start Voice Command.
1356 * <p>Input: Nothing.
1357 * <p>Output: Nothing.
1358 */
1359 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1360 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001361
1362 /**
1363 * Activity Action: Start action associated with long pressing on the
1364 * search key.
1365 * <p>Input: Nothing.
1366 * <p>Output: Nothing.
1367 */
1368 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1369 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001370
Jacek Surazski86b6c532009-05-13 14:38:28 +02001371 /**
1372 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1373 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001374 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001375 * <p>Input: No data is specified. The bug report is passed in using
1376 * an {@link #EXTRA_BUG_REPORT} field.
1377 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001378 *
1379 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001380 */
1381 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1382 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001383
1384 /**
1385 * Activity Action: Show power usage information to the user.
1386 * <p>Input: Nothing.
1387 * <p>Output: Nothing.
1388 */
1389 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1390 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001391
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001392 /**
1393 * Activity Action: Setup wizard to launch after a platform update. This
1394 * activity should have a string meta-data field associated with it,
1395 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1396 * the platform for setup. The activity will be launched only if
1397 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1398 * same value.
1399 * <p>Input: Nothing.
1400 * <p>Output: Nothing.
1401 * @hide
1402 */
1403 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1404 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001405
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001406 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001407 * Activity Action: Show settings for managing network data usage of a
1408 * specific application. Applications should define an activity that offers
1409 * options to control data usage.
1410 */
1411 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1412 public static final String ACTION_MANAGE_NETWORK_USAGE =
1413 "android.intent.action.MANAGE_NETWORK_USAGE";
1414
1415 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001416 * Activity Action: Launch application installer.
1417 * <p>
1418 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001419 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1420 * you can also use "package:<package-name>" to install an application for the
1421 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001422 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1423 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1424 * <p>
1425 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1426 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001427 * <p>
1428 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1429 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1430 * in order to launch the application installer.
1431 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001432 *
1433 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1434 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1435 * @see #EXTRA_RETURN_RESULT
1436 */
1437 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1438 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1439
1440 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001441 * Activity Action: Launch ephemeral installer.
1442 * <p>
1443 * Input: The data must be a http: URI that the ephemeral application is registered
1444 * to handle.
1445 * <p class="note">
1446 * This is a protected intent that can only be sent by the system.
1447 * </p>
1448 *
1449 * @hide
1450 */
1451 @SystemApi
1452 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1453 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1454 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1455
1456 /**
1457 * Service Action: Resolve ephemeral application.
1458 * <p>
1459 * The system will have a persistent connection to this service.
1460 * This is a protected intent that can only be sent by the system.
1461 * </p>
1462 *
1463 * @hide
1464 */
1465 @SystemApi
1466 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1467 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1468 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1469
1470 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001471 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1472 * package. Specifies the installer package name; this package will receive the
1473 * {@link #ACTION_APP_ERROR} intent.
1474 */
1475 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1476 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1477
1478 /**
1479 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1480 * package. Specifies that the application being installed should not be
1481 * treated as coming from an unknown source, but as coming from the app
1482 * invoking the Intent. For this to work you must start the installer with
1483 * startActivityForResult().
1484 */
1485 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1486 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1487
1488 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001489 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1490 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001491 * data field originated from.
1492 */
rich cannings706e8ba2012-08-20 13:20:14 -07001493 public static final String EXTRA_ORIGINATING_URI
1494 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001495
1496 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001497 * This extra can be used with any Intent used to launch an activity, supplying information
1498 * about who is launching that activity. This field contains a {@link android.net.Uri}
1499 * object, typically an http: or https: URI of the web site that the referral came from;
1500 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1501 * a native application that it came from.
1502 *
1503 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1504 * instead of directly retrieving the extra. It is also valid for applications to
1505 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1506 * a string, not a Uri; the field here, if supplied, will always take precedence,
1507 * however.</p>
1508 *
1509 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001510 */
1511 public static final String EXTRA_REFERRER
1512 = "android.intent.extra.REFERRER";
1513
1514 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001515 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1516 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1517 * not be created, in particular when Intent extras are supplied through the
1518 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1519 * schemes.
1520 *
1521 * @see #EXTRA_REFERRER
1522 */
1523 public static final String EXTRA_REFERRER_NAME
1524 = "android.intent.extra.REFERRER_NAME";
1525
1526 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001527 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1528 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1529 * @hide
1530 */
1531 public static final String EXTRA_ORIGINATING_UID
1532 = "android.intent.extra.ORIGINATING_UID";
1533
1534 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001535 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1536 * package. Tells the installer UI to skip the confirmation with the user
1537 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001538 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1539 * will no longer show an interstitial message about updating existing
1540 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001541 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001542 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001543 public static final String EXTRA_ALLOW_REPLACE
1544 = "android.intent.extra.ALLOW_REPLACE";
1545
1546 /**
1547 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1548 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1549 * return to the application the result code of the install/uninstall. The returned result
1550 * code will be {@link android.app.Activity#RESULT_OK} on success or
1551 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1552 */
1553 public static final String EXTRA_RETURN_RESULT
1554 = "android.intent.extra.RETURN_RESULT";
1555
1556 /**
1557 * Package manager install result code. @hide because result codes are not
1558 * yet ready to be exposed.
1559 */
1560 public static final String EXTRA_INSTALL_RESULT
1561 = "android.intent.extra.INSTALL_RESULT";
1562
1563 /**
1564 * Activity Action: Launch application uninstaller.
1565 * <p>
1566 * Input: The data must be a package: URI whose scheme specific part is
1567 * the package name of the current installed package to be uninstalled.
1568 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1569 * <p>
1570 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1571 * succeeded.
1572 */
1573 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1574 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1575
1576 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001577 * Specify whether the package should be uninstalled for all users.
1578 * @hide because these should not be part of normal application flow.
1579 */
1580 public static final String EXTRA_UNINSTALL_ALL_USERS
1581 = "android.intent.extra.UNINSTALL_ALL_USERS";
1582
1583 /**
Suprabh Shukla74a2fe42016-01-27 12:57:24 -08001584 * Specified when the uninstall confirmation dialog is not required to be shown.
1585 * Use with {@link #ACTION_UNINSTALL_PACKAGE}
1586 * @hide
1587 */
1588 public static final String EXTRA_SKIP_UNINSTALL_CONFIRMATION =
1589 "android.intent.extra.SKIP_UNINSTALL_CONFIRMATION";
1590
1591 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001592 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1593 * describing the last run version of the platform that was setup.
1594 * @hide
1595 */
1596 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1597
Svet Ganov3695b8a2015-03-24 16:30:25 -07001598 /**
1599 * Activity action: Launch UI to manage the permissions of an app.
1600 * <p>
1601 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1602 * will be managed by the launched UI.
1603 * </p>
1604 * <p>
1605 * Output: Nothing.
1606 * </p>
1607 *
1608 * @see #EXTRA_PACKAGE_NAME
1609 *
1610 * @hide
1611 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001612 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1613 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1614 "android.intent.action.MANAGE_APP_PERMISSIONS";
1615
1616 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001617 * Activity action: Launch UI to manage permissions.
1618 * <p>
1619 * Input: Nothing.
1620 * </p>
1621 * <p>
1622 * Output: Nothing.
1623 * </p>
1624 *
1625 * @hide
1626 */
Svet Ganov321f0152015-05-16 22:51:50 -07001627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1628 public static final String ACTION_MANAGE_PERMISSIONS =
1629 "android.intent.action.MANAGE_PERMISSIONS";
1630
1631 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001632 * Activity action: Launch UI to review permissions for an app.
1633 * The system uses this intent if permission review for apps not
1634 * supporting the new runtime permissions model is enabled. In
1635 * this mode a permission review is required before any of the
1636 * app components can run.
1637 * <p>
1638 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1639 * permissions will be reviewed (mandatory).
1640 * </p>
1641 * <p>
1642 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1643 * be fired after the permission review (optional).
1644 * </p>
1645 * <p>
1646 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1647 * be invoked after the permission review (optional).
1648 * </p>
1649 * <p>
1650 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1651 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1652 * </p>
1653 * <p>
1654 * Output: Nothing.
1655 * </p>
1656 *
1657 * @see #EXTRA_PACKAGE_NAME
1658 * @see #EXTRA_INTENT
1659 * @see #EXTRA_REMOTE_CALLBACK
1660 * @see #EXTRA_RESULT_NEEDED
1661 *
1662 * @hide
1663 */
1664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1665 public static final String ACTION_REVIEW_PERMISSIONS =
1666 "android.intent.action.REVIEW_PERMISSIONS";
1667
1668 /**
1669 * Intent extra: A callback for reporting remote result as a bundle.
1670 * <p>
1671 * Type: IRemoteCallback
1672 * </p>
1673 *
1674 * @hide
1675 */
1676 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1677
1678 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001679 * Intent extra: An app package name.
1680 * <p>
1681 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001682 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001683 *
1684 * @hide
1685 */
1686 @SystemApi
1687 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1688
1689 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001690 * Intent extra: An extra for specifying whether a result is needed.
1691 * <p>
1692 * Type: boolean
1693 * </p>
1694 *
1695 * @hide
1696 */
1697 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1698
1699 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001700 * Broadcast action that requests current permission granted information. It will respond
1701 * to the request by sending a broadcast with action defined by
1702 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001703 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1704 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1705 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001706 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001707 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1708 * number of permissions requested and the number of granted additional permissions
1709 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001710 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001711 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1712 * of localized permission group names that are granted in
1713 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001714 *
1715 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1716 * permissions and the total number of apps requesting runtime permissions will be the first
1717 * and second elements respectively of an int[] in the response as
1718 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1719 *
1720 * @hide
1721 */
1722 public static final String ACTION_GET_PERMISSIONS_COUNT
1723 = "android.intent.action.GET_PERMISSIONS_COUNT";
1724
1725 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001726 * Broadcast action that requests list of all apps that have runtime permissions. It will
1727 * respond to the request by sending a broadcast with action defined by
1728 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1729 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1730 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1731 * a null upon failure.
1732 *
1733 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1734 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1735 * will contain the list of app labels corresponding ot the apps in the first list.
1736 *
1737 * @hide
1738 */
1739 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1740 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1741
1742 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001743 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1744 * @hide
1745 */
1746 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1747 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1748
1749 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001750 * List of CharSequence of localized permission group labels.
1751 * @hide
1752 */
1753 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1754 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1755
1756 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001757 * String list of apps that have one or more runtime permissions.
1758 * @hide
1759 */
1760 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1761 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1762
1763 /**
1764 * String list of app labels for apps that have one or more runtime permissions.
1765 * @hide
1766 */
1767 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1768 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1769
1770 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001771 * Boolean list describing if the app is a system app for apps that have one or more runtime
1772 * permissions.
1773 * @hide
1774 */
1775 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1776 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1777
1778 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001779 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001780 * @hide
1781 */
1782 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1783 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1784
1785 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001786 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1787 * @hide
1788 */
1789 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1790 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1791
1792 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001793 * Activity action: Launch UI to manage which apps have a given permission.
1794 * <p>
1795 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1796 * to which will be managed by the launched UI.
1797 * </p>
1798 * <p>
1799 * Output: Nothing.
1800 * </p>
1801 *
1802 * @see #EXTRA_PERMISSION_NAME
1803 *
1804 * @hide
1805 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001806 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1807 public static final String ACTION_MANAGE_PERMISSION_APPS =
1808 "android.intent.action.MANAGE_PERMISSION_APPS";
1809
1810 /**
1811 * Intent extra: The name of a permission.
1812 * <p>
1813 * Type: String
1814 * </p>
1815 *
1816 * @hide
1817 */
1818 @SystemApi
1819 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1820
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001821 // ---------------------------------------------------------------------
1822 // ---------------------------------------------------------------------
1823 // Standard intent broadcast actions (see action variable).
1824
1825 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001826 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1827 * <p>
1828 * For historical reasons, the name of this broadcast action refers to the power
1829 * state of the screen but it is actually sent in response to changes in the
1830 * overall interactive state of the device.
1831 * </p><p>
1832 * This broadcast is sent when the device becomes non-interactive which may have
1833 * nothing to do with the screen turning off. To determine the
1834 * actual state of the screen, use {@link android.view.Display#getState}.
1835 * </p><p>
1836 * See {@link android.os.PowerManager#isInteractive} for details.
1837 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001838 * You <em>cannot</em> receive this through components declared in
1839 * manifests, only by explicitly registering for it with
1840 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1841 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001848
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001850 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1851 * <p>
1852 * For historical reasons, the name of this broadcast action refers to the power
1853 * state of the screen but it is actually sent in response to changes in the
1854 * overall interactive state of the device.
1855 * </p><p>
1856 * This broadcast is sent when the device becomes interactive which may have
1857 * nothing to do with the screen turning on. To determine the
1858 * actual state of the screen, use {@link android.view.Display#getState}.
1859 * </p><p>
1860 * See {@link android.os.PowerManager#isInteractive} for details.
1861 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001862 * You <em>cannot</em> receive this through components declared in
1863 * manifests, only by explicitly registering for it with
1864 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1865 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001866 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001867 * <p class="note">This is a protected intent that can only be sent
1868 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001869 */
1870 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1871 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001872
1873 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001874 * Broadcast Action: Sent after the system stops dreaming.
1875 *
1876 * <p class="note">This is a protected intent that can only be sent by the system.
1877 * It is only sent to registered receivers.</p>
1878 */
1879 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1880 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1881
1882 /**
1883 * Broadcast Action: Sent after the system starts dreaming.
1884 *
1885 * <p class="note">This is a protected intent that can only be sent by the system.
1886 * It is only sent to registered receivers.</p>
1887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1889 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1890
1891 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001892 * 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 -07001893 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001894 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001895 * <p class="note">This is a protected intent that can only be sent
1896 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001899 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001900
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 /**
1902 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001903 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001904 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001905 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1906 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001907 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001908 * <p class="note">This is a protected intent that can only be sent
1909 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1912 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1913 /**
1914 * Broadcast Action: The time was set.
1915 */
1916 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1917 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1918 /**
1919 * Broadcast Action: The date has changed.
1920 */
1921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1923 /**
1924 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1925 * <ul>
1926 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1927 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001928 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001929 * <p class="note">This is a protected intent that can only be sent
1930 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001931 */
1932 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1933 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1934 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001935 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1936 * DNS entries should be tossed.
1937 * @hide
1938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1940 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1941 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 * Alarm Changed Action: This is broadcast when the AlarmClock
1943 * application's alarm is set or unset. It is used by the
1944 * AlarmClock application and the StatusBar service.
1945 * @hide
1946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1948 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001949
1950 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001951 * Broadcast Action: This is broadcast once, after the user has finished
1952 * booting, but while still in the "locked" state. It can be used to perform
1953 * application-specific initialization, such as installing alarms. You must
1954 * hold the {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED}
1955 * permission in order to receive this broadcast.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001956 * <p>
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001957 * This broadcast is sent immediately at boot by all devices (regardless of
1958 * direct boot support) running {@link android.os.Build.VERSION_CODES#N} or
1959 * higher. Upon receipt of this broadcast, the user is still locked and only
1960 * device-protected storage can be accessed safely. If you want to access
1961 * credential-protected storage, you need to wait for the user to be
1962 * unlocked (typically by entering their lock pattern or PIN for the first
1963 * time), after which the {@link #ACTION_USER_UNLOCKED} and
1964 * {@link #ACTION_BOOT_COMPLETED} broadcasts are sent.
1965 * <p>
1966 * To receive this broadcast, your receiver component must be marked as
1967 * being {@link ComponentInfo#directBootAware}.
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001968 * <p class="note">
1969 * This is a protected intent that can only be sent by the system.
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001970 *
1971 * @see Context#createDeviceProtectedStorageContext()
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001972 */
1973 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1974 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001976 /**
Jeff Sharkeycf3f0a12016-03-17 19:57:58 -06001977 * Broadcast Action: This is broadcast once, after the user has finished
1978 * booting. It can be used to perform application-specific initialization,
1979 * such as installing alarms. You must hold the
1980 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1981 * order to receive this broadcast.
1982 * <p>
1983 * This broadcast is sent at boot by all devices (both with and without
1984 * direct boot support). Upon receipt of this broadcast, the user is
1985 * unlocked and both device-protected and credential-protected storage can
1986 * accessed safely.
1987 * <p>
1988 * If you need to run while the user is still locked (before they've entered
1989 * their lock pattern or PIN for the first time), you can listen for the
1990 * {@link #ACTION_LOCKED_BOOT_COMPLETED} broadcast.
1991 * <p class="note">
1992 * This is a protected intent that can only be sent by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001996
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001997 /**
1998 * Broadcast Action: This is broadcast when a user action should request a
1999 * temporary system dialog to dismiss. Some examples of temporary system
2000 * dialogs are the notification window-shade and the recent tasks dialog.
2001 */
2002 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
2003 /**
2004 * Broadcast Action: Trigger the download and eventual installation
2005 * of a package.
2006 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08002007 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002008 * <p class="note">This is a protected intent that can only be sent
2009 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002010 *
2011 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07002013 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
2016 /**
2017 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002018 * device. The data contains the name of the package. Note that the
2019 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002020 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002021 * <ul>
2022 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2023 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2024 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2025 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002026 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002027 * <p class="note">This is a protected intent that can only be sent
2028 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002029 */
2030 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2031 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2032 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002033 * Broadcast Action: A new version of an application package has been
2034 * installed, replacing an existing version that was previously installed.
2035 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002036 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002037 * <ul>
2038 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2039 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002040 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002041 * <p class="note">This is a protected intent that can only be sent
2042 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2046 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002047 * Broadcast Action: A new version of your application has been installed
2048 * over an existing one. This is only sent to the application that was
2049 * replaced. It does not contain any additional data; to receive it, just
2050 * use an intent filter for this action.
2051 *
2052 * <p class="note">This is a protected intent that can only be sent
2053 * by the system.
2054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2056 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2057 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002058 * Broadcast Action: An existing application package has been removed from
2059 * the device. The data contains the name of the package. The package
2060 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 * <ul>
2062 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2063 * to the package.
2064 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2065 * application -- data and code -- is being removed.
2066 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2067 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2068 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002069 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002070 * <p class="note">This is a protected intent that can only be sent
2071 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 */
2073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2074 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2075 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002076 * Broadcast Action: An existing application package has been completely
2077 * removed from the device. The data contains the name of the package.
2078 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2079 * {@link #EXTRA_DATA_REMOVED} is true and
2080 * {@link #EXTRA_REPLACING} is false of that broadcast.
2081 *
2082 * <ul>
2083 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2084 * to the package.
2085 * </ul>
2086 *
2087 * <p class="note">This is a protected intent that can only be sent
2088 * by the system.
2089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_PACKAGE_FULLY_REMOVED
2092 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2093 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002094 * Broadcast Action: An existing application package has been changed (e.g.
2095 * a component has been enabled or disabled). The data contains the name of
2096 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002097 * <ul>
2098 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002099 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002100 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002101 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2102 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002103 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002104 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002105 * <p class="note">This is a protected intent that can only be sent
2106 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002107 */
2108 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2109 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2110 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002111 * @hide
2112 * Broadcast Action: Ask system services if there is any reason to
2113 * restart the given package. The data contains the name of the
2114 * package.
2115 * <ul>
2116 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2117 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2118 * </ul>
2119 *
2120 * <p class="note">This is a protected intent that can only be sent
2121 * by the system.
2122 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002123 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2125 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2126 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002127 * Broadcast Action: The user has restarted a package, and all of its
2128 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002129 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002130 * be removed. Note that the restarted package does <em>not</em>
2131 * receive this broadcast.
2132 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133 * <ul>
2134 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2135 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002136 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002137 * <p class="note">This is a protected intent that can only be sent
2138 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002139 */
2140 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2141 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2142 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002143 * Broadcast Action: The user has cleared the data of a package. This should
2144 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002145 * its persistent data is erased and this broadcast sent.
2146 * Note that the cleared package does <em>not</em>
2147 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 * <ul>
2149 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2150 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002151 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002152 * <p class="note">This is a protected intent that can only be sent
2153 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002154 */
2155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2156 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2157 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002158 * Broadcast Action: Packages have been suspended.
2159 * <p>Includes the following extras:
2160 * <ul>
2161 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2162 * </ul>
2163 *
2164 * <p class="note">This is a protected intent that can only be sent
2165 * by the system. It is only sent to registered receivers.
2166 */
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2169 /**
2170 * Broadcast Action: Packages have been unsuspended.
2171 * <p>Includes the following extras:
2172 * <ul>
2173 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2174 * </ul>
2175 *
2176 * <p class="note">This is a protected intent that can only be sent
2177 * by the system. It is only sent to registered receivers.
2178 */
2179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2180 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2181 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002182 * Broadcast Action: A user ID has been removed from the system. The user
2183 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002184 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002185 * <p class="note">This is a protected intent that can only be sent
2186 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2189 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002190
2191 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002192 * Broadcast Action: Sent to the installer package of an application
2193 * when that application is first launched (that is the first time it
2194 * is moved out of the stopped state). The data contains the name of the package.
2195 *
2196 * <p class="note">This is a protected intent that can only be sent
2197 * by the system.
2198 */
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2201
2202 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002203 * Broadcast Action: Sent to the system package verifier when a package
2204 * needs to be verified. The data contains the package URI.
2205 * <p class="note">
2206 * This is a protected intent that can only be sent by the system.
2207 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002208 */
2209 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2210 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2211
2212 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002213 * Broadcast Action: Sent to the system package verifier when a package is
2214 * verified. The data contains the package URI.
2215 * <p class="note">
2216 * This is a protected intent that can only be sent by the system.
2217 */
2218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2219 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2220
2221 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002222 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2223 * needs to be verified. The data contains the filter data hosts to be verified against.
2224 * <p class="note">
2225 * This is a protected intent that can only be sent by the system.
2226 * </p>
2227 *
2228 * @hide
2229 */
2230 @SystemApi
2231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2232 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2233
2234 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002235 * Broadcast Action: Resources for a set of packages (which were
2236 * previously unavailable) are currently
2237 * available since the media on which they exist is available.
2238 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2239 * list of packages whose availability changed.
2240 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2241 * list of uids of packages whose availability changed.
2242 * Note that the
2243 * packages in this list do <em>not</em> receive this broadcast.
2244 * The specified set of packages are now available on the system.
2245 * <p>Includes the following extras:
2246 * <ul>
2247 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2248 * whose resources(were previously unavailable) are currently available.
2249 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2250 * packages whose resources(were previously unavailable)
2251 * are currently available.
2252 * </ul>
2253 *
2254 * <p class="note">This is a protected intent that can only be sent
2255 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002256 */
2257 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002258 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2259 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002260
2261 /**
2262 * Broadcast Action: Resources for a set of packages are currently
2263 * unavailable since the media on which they exist is unavailable.
2264 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2265 * list of packages whose availability changed.
2266 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2267 * list of uids of packages whose availability changed.
2268 * The specified set of packages can no longer be
2269 * launched and are practically unavailable on the system.
2270 * <p>Inclues the following extras:
2271 * <ul>
2272 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2273 * whose resources are no longer available.
2274 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2275 * whose resources are no longer available.
2276 * </ul>
2277 *
2278 * <p class="note">This is a protected intent that can only be sent
2279 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002280 */
2281 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002282 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002283 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002284
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002285 /**
2286 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002287 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002288 * This should <em>only</em> be used to determine when the wallpaper
2289 * has changed to show the new wallpaper to the user. You should certainly
2290 * never, in response to this, change the wallpaper or other attributes of
2291 * it such as the suggested size. That would be crazy, right? You'd cause
2292 * all kinds of loops, especially if other apps are doing similar things,
2293 * right? Of course. So please don't do this.
2294 *
2295 * @deprecated Modern applications should use
2296 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2297 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2298 * shown behind their UI, rather than watching for this broadcast and
2299 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002301 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2303 /**
2304 * Broadcast Action: The current device {@link android.content.res.Configuration}
2305 * (orientation, locale, etc) has changed. When such a change happens, the
2306 * UIs (view hierarchy) will need to be rebuilt based on this new
2307 * information; for the most part, applications don't need to worry about
2308 * this, because the system will take care of stopping and restarting the
2309 * application to make sure it sees the new changes. Some system code that
2310 * can not be restarted will need to watch for this action and handle it
2311 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002312 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002313 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002314 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002315 * in manifests, only by explicitly registering for it with
2316 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2317 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002318 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002319 * <p class="note">This is a protected intent that can only be sent
2320 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 *
2322 * @see android.content.res.Configuration
2323 */
2324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2325 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2326 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002327 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002328 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002329 * <p class="note">This is a protected intent that can only be sent
2330 * by the system.
2331 */
2332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2333 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2334 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002335 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2336 * charging state, level, and other information about the battery.
2337 * See {@link android.os.BatteryManager} for documentation on the
2338 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002339 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002340 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002341 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002342 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002343 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002344 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2345 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2346 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2347 * broadcasts that are sent and can be received through manifest
2348 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002349 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002350 * <p class="note">This is a protected intent that can only be sent
2351 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002352 */
2353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2354 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2355 /**
2356 * Broadcast Action: Indicates low battery condition on the device.
2357 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002358 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002359 * <p class="note">This is a protected intent that can only be sent
2360 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002361 */
2362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2363 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2364 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002365 * Broadcast Action: Indicates the battery is now okay after being low.
2366 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2367 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002369 * <p class="note">This is a protected intent that can only be sent
2370 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002371 */
2372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2373 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2374 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002375 * Broadcast Action: External power has been connected to the device.
2376 * This is intended for applications that wish to register specifically to this notification.
2377 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2378 * stay active to receive this notification. This action can be used to implement actions
2379 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002380 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002381 * <p class="note">This is a protected intent that can only be sent
2382 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002383 */
2384 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002385 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002386 /**
2387 * Broadcast Action: External power has been removed from the device.
2388 * This is intended for applications that wish to register specifically to this notification.
2389 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2390 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002391 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002392 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002393 * <p class="note">This is a protected intent that can only be sent
2394 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002397 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002398 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002399 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002400 * Broadcast Action: Device is shutting down.
2401 * This is broadcast when the device is being shut down (completely turned
2402 * off, not sleeping). Once the broadcast is complete, the final shutdown
2403 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002404 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002405 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002406 * <p class="note">This is a protected intent that can only be sent
2407 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002408 * <p>May include the following extras:
2409 * <ul>
2410 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2411 * shutdown is only for userspace processes. If not set, assumed to be false.
2412 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002413 */
2414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002415 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002416 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002417 * Activity Action: Start this activity to request system shutdown.
2418 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002419 * to request confirmation from the user before shutting down. The optional boolean
2420 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2421 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002422 *
2423 * <p class="note">This is a protected intent that can only be sent
2424 * by the system.
2425 *
2426 * {@hide}
2427 */
2428 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2429 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002430 * Broadcast Action: A sticky broadcast that indicates low memory
2431 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002432 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002433 * <p class="note">This is a protected intent that can only be sent
2434 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435 */
2436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2437 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2438 /**
2439 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002440 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002441 * <p class="note">This is a protected intent that can only be sent
2442 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002443 */
2444 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2445 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2446 /**
Jake Hambybb371632010-08-23 18:16:48 -07002447 * Broadcast Action: A sticky broadcast that indicates a memory full
2448 * condition on the device. This is intended for activities that want
2449 * to be able to fill the data partition completely, leaving only
2450 * enough free space to prevent system-wide SQLite failures.
2451 *
2452 * <p class="note">This is a protected intent that can only be sent
2453 * by the system.
2454 *
2455 * {@hide}
2456 */
2457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2458 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2459 /**
2460 * Broadcast Action: Indicates memory full condition on the device
2461 * no longer exists.
2462 *
2463 * <p class="note">This is a protected intent that can only be sent
2464 * by the system.
2465 *
2466 * {@hide}
2467 */
2468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2469 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2470 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002471 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2472 * and package management should be started.
2473 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2474 * notification.
2475 */
2476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2477 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2478 /**
2479 * Broadcast Action: The device has entered USB Mass Storage mode.
2480 * This is used mainly for the USB Settings panel.
2481 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2482 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002483 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002485 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002486 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2487
2488 /**
2489 * Broadcast Action: The device has exited USB Mass Storage mode.
2490 * This is used mainly for the USB Settings panel.
2491 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2492 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002493 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002494 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002495 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2497
2498 /**
2499 * Broadcast Action: External media has been removed.
2500 * The path to the mount point for the removed media is contained in the Intent.mData field.
2501 */
2502 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2503 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2504
2505 /**
2506 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002507 * 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 -07002508 */
2509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2510 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2511
2512 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002513 * Broadcast Action: External media is present, and being disk-checked
2514 * 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 -08002515 */
2516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2517 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2518
2519 /**
2520 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2521 * 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 -08002522 */
2523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2524 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2525
2526 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002527 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002528 * 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 -07002529 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2530 * media was mounted read only.
2531 */
2532 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2533 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2534
2535 /**
2536 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002537 * 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 -07002538 */
2539 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2540 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2541
2542 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002543 * Broadcast Action: External media is no longer being shared via USB mass storage.
2544 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2545 *
2546 * @hide
2547 */
2548 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2549
2550 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2552 * The path to the mount point for the removed media is contained in the Intent.mData field.
2553 */
2554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2555 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2556
2557 /**
2558 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002559 * 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 -07002560 */
2561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2562 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2563
2564 /**
2565 * Broadcast Action: User has expressed the desire to remove the external storage media.
2566 * Applications should close all files they have open within the mount point when they receive this intent.
2567 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2568 */
2569 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2570 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2571
2572 /**
2573 * Broadcast Action: The media scanner has started scanning a directory.
2574 * The path to the directory being scanned is contained in the Intent.mData field.
2575 */
2576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2577 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2578
2579 /**
2580 * Broadcast Action: The media scanner has finished scanning a directory.
2581 * The path to the scanned directory is contained in the Intent.mData field.
2582 */
2583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2584 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2585
2586 /**
2587 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2588 * The path to the file is contained in the Intent.mData field.
2589 */
2590 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2591 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2592
2593 /**
2594 * Broadcast Action: The "Media Button" was pressed. Includes a single
2595 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2596 * caused the broadcast.
2597 */
2598 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2599 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2600
2601 /**
2602 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2603 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2604 * caused the broadcast.
2605 */
2606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2607 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2608
2609 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2610 // location; they are not general-purpose actions.
2611
2612 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002613 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002614 */
2615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2616 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2617 "android.intent.action.GTALK_CONNECTED";
2618
2619 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002620 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 */
2622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2623 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2624 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002625
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002626 /**
2627 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002628 */
2629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2630 public static final String ACTION_INPUT_METHOD_CHANGED =
2631 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002632
2633 /**
2634 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2635 * more radios have been turned off or on. The intent will have the following extra value:</p>
2636 * <ul>
2637 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2638 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2639 * turned off</li>
2640 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002641 *
Peng Xua35b5532016-01-20 00:05:45 -08002642 * <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 -07002643 */
2644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2645 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2646
2647 /**
2648 * Broadcast Action: Some content providers have parts of their namespace
2649 * where they publish new events or items that the user may be especially
2650 * interested in. For these things, they may broadcast this action when the
2651 * set of interesting items change.
2652 *
2653 * For example, GmailProvider sends this notification when the set of unread
2654 * mail in the inbox changes.
2655 *
2656 * <p>The data of the intent identifies which part of which provider
2657 * changed. When queried through the content resolver, the data URI will
2658 * return the data set in question.
2659 *
2660 * <p>The intent will have the following extra values:
2661 * <ul>
2662 * <li><em>count</em> - The number of items in the data set. This is the
2663 * same as the number of items in the cursor returned by querying the
2664 * data URI. </li>
2665 * </ul>
2666 *
2667 * This intent will be sent at boot (if the count is non-zero) and when the
2668 * data set changes. It is possible for the data set to change without the
2669 * count changing (for example, if a new unread message arrives in the same
2670 * sync operation in which a message is archived). The phone should still
2671 * ring/vibrate/etc as normal in this case.
2672 */
2673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2674 public static final String ACTION_PROVIDER_CHANGED =
2675 "android.intent.action.PROVIDER_CHANGED";
2676
2677 /**
2678 * Broadcast Action: Wired Headset plugged in or unplugged.
2679 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002680 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2681 * and documentation.
2682 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002683 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002684 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002685 */
2686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002687 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002688
2689 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002690 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2691 * <ul>
2692 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2693 * </ul>
2694 *
2695 * <p class="note">This is a protected intent that can only be sent
2696 * by the system.
2697 *
2698 * @hide
2699 */
2700 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2701 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2702 = "android.intent.action.ADVANCED_SETTINGS";
2703
2704 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002705 * Broadcast Action: Sent after application restrictions are changed.
2706 *
2707 * <p class="note">This is a protected intent that can only be sent
2708 * by the system.</p>
2709 */
2710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2711 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2712 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2713
2714 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002715 * Broadcast Action: An outgoing call is about to be placed.
2716 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002717 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002718 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002719 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 * the phone number originally intended to be dialed.</li>
2721 * </ul>
2722 * <p>Once the broadcast is finished, the resultData is used as the actual
2723 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002724 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002725 * outgoing call in turn: for example, a parental control application
2726 * might verify that the user is authorized to place the call at that
2727 * time, then a number-rewriting application might add an area code if
2728 * one was not specified.</p>
2729 * <p>For consistency, any receiver whose purpose is to prohibit phone
2730 * calls should have a priority of 0, to ensure it will see the final
2731 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002732 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002733 * should have a positive priority.
2734 * Negative priorities are reserved for the system for this broadcast;
2735 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002736 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2737 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002738 * <p>Emergency calls cannot be intercepted using this mechanism, and
2739 * other calls cannot be modified to call emergency numbers using this
2740 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002741 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2742 * call to use their own service instead. Those apps should first prevent
2743 * the call from being placed by setting resultData to <code>null</code>
2744 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002745 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2747 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002748 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002749 * <p class="note">This is a protected intent that can only be sent
2750 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002751 */
2752 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2753 public static final String ACTION_NEW_OUTGOING_CALL =
2754 "android.intent.action.NEW_OUTGOING_CALL";
2755
2756 /**
2757 * Broadcast Action: Have the device reboot. This is only for use by
2758 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002759 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002760 * <p class="note">This is a protected intent that can only be sent
2761 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002762 */
2763 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2764 public static final String ACTION_REBOOT =
2765 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002766
Wei Huang97ecc9c2009-05-11 17:44:20 -07002767 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002768 * Broadcast Action: A sticky broadcast for changes in the physical
2769 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002770 *
2771 * <p>The intent will have the following extra values:
2772 * <ul>
2773 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002774 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002775 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002776 * <p>This is intended for monitoring the current physical dock state.
2777 * See {@link android.app.UiModeManager} for the normal API dealing with
2778 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002779 */
2780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2781 public static final String ACTION_DOCK_EVENT =
2782 "android.intent.action.DOCK_EVENT";
2783
2784 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002785 * Broadcast Action: A broadcast when idle maintenance can be started.
2786 * This means that the user is not interacting with the device and is
2787 * not expected to do so soon. Typical use of the idle maintenance is
2788 * to perform somehow expensive tasks that can be postponed at a moment
2789 * when they will not degrade user experience.
2790 * <p>
2791 * <p class="note">In order to keep the device responsive in case of an
2792 * unexpected user interaction, implementations of a maintenance task
2793 * should be interruptible. In such a scenario a broadcast with action
2794 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2795 * should not do the maintenance work in
2796 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2797 * maintenance service by {@link Context#startService(Intent)}. Also
2798 * you should hold a wake lock while your maintenance service is running
2799 * to prevent the device going to sleep.
2800 * </p>
2801 * <p>
2802 * <p class="note">This is a protected intent that can only be sent by
2803 * the system.
2804 * </p>
2805 *
2806 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002807 *
2808 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002809 */
2810 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2811 public static final String ACTION_IDLE_MAINTENANCE_START =
2812 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2813
2814 /**
2815 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2816 * This means that the user was not interacting with the device as a result
2817 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2818 * was sent and now the user started interacting with the device. Typical
2819 * use of the idle maintenance is to perform somehow expensive tasks that
2820 * can be postponed at a moment when they will not degrade user experience.
2821 * <p>
2822 * <p class="note">In order to keep the device responsive in case of an
2823 * unexpected user interaction, implementations of a maintenance task
2824 * should be interruptible. Hence, on receiving a broadcast with this
2825 * action, the maintenance task should be interrupted as soon as possible.
2826 * In other words, you should not do the maintenance work in
2827 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2828 * maintenance service that was started on receiving of
2829 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2830 * lock you acquired when your maintenance service started.
2831 * </p>
2832 * <p class="note">This is a protected intent that can only be sent
2833 * by the system.
2834 *
2835 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002836 *
2837 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002838 */
2839 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2840 public static final String ACTION_IDLE_MAINTENANCE_END =
2841 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2842
2843 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002844 * Broadcast Action: a remote intent is to be broadcasted.
2845 *
2846 * A remote intent is used for remote RPC between devices. The remote intent
2847 * is serialized and sent from one device to another device. The receiving
2848 * device parses the remote intent and broadcasts it. Note that anyone can
2849 * broadcast a remote intent. However, if the intent receiver of the remote intent
2850 * does not trust intent broadcasts from arbitrary intent senders, it should require
2851 * the sender to hold certain permissions so only trusted sender's broadcast will be
2852 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002853 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002854 */
2855 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002856 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002857
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002858 /**
2859 * Broadcast Action: hook for permforming cleanup after a system update.
2860 *
2861 * The broadcast is sent when the system is booting, before the
2862 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2863 * image. A receiver for this should do its work and then disable itself
2864 * so that it does not get run again at the next boot.
2865 * @hide
2866 */
2867 public static final String ACTION_PRE_BOOT_COMPLETED =
2868 "android.intent.action.PRE_BOOT_COMPLETED";
2869
Amith Yamasani13593602012-03-22 16:16:17 -07002870 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002871 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002872 * on restricted users. The broadcast intent contains an extra
2873 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2874 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2875 * String[] depending on the restriction type.<p/>
2876 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002877 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2878 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2879 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002880 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2881 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002882 * @see RestrictionEntry
2883 */
2884 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2885 "android.intent.action.GET_RESTRICTION_ENTRIES";
2886
2887 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002888 * Sent the first time a user is starting, to allow system apps to
2889 * perform one time initialization. (This will not be seen by third
2890 * party applications because a newly initialized user does not have any
2891 * third party applications installed for it.) This is sent early in
2892 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002893 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2894 * broadcast, since it is part of a visible user interaction; be as quick
2895 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002896 */
2897 public static final String ACTION_USER_INITIALIZE =
2898 "android.intent.action.USER_INITIALIZE";
2899
2900 /**
2901 * Sent when a user switch is happening, causing the process's user to be
2902 * brought to the foreground. This is only sent to receivers registered
2903 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2904 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002905 * foreground. This is sent as a foreground
2906 * broadcast, since it is part of a visible user interaction; be as quick
2907 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002908 */
2909 public static final String ACTION_USER_FOREGROUND =
2910 "android.intent.action.USER_FOREGROUND";
2911
2912 /**
2913 * Sent when a user switch is happening, causing the process's user to be
2914 * sent to the background. This is only sent to receivers registered
2915 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2916 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002917 * background. This is sent as a foreground
2918 * broadcast, since it is part of a visible user interaction; be as quick
2919 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002920 */
2921 public static final String ACTION_USER_BACKGROUND =
2922 "android.intent.action.USER_BACKGROUND";
2923
2924 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002925 * Broadcast sent to the system when a user is added. Carries an extra
2926 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2927 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002928 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002929 * @hide
2930 */
2931 public static final String ACTION_USER_ADDED =
2932 "android.intent.action.USER_ADDED";
2933
2934 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002935 * Broadcast sent by the system when a user is started. Carries an extra
2936 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002937 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002938 * that has been started. This is sent as a foreground
2939 * broadcast, since it is part of a visible user interaction; be as quick
2940 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002941 * @hide
2942 */
2943 public static final String ACTION_USER_STARTED =
2944 "android.intent.action.USER_STARTED";
2945
2946 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002947 * Broadcast sent when a user is in the process of starting. Carries an extra
2948 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2949 * sent to registered receivers, not manifest receivers. It is sent to all
2950 * users (including the one that is being started). You must hold
2951 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2952 * this broadcast. This is sent as a background broadcast, since
2953 * its result is not part of the primary UX flow; to safely keep track of
2954 * started/stopped state of a user you can use this in conjunction with
2955 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2956 * other user state broadcasts since those are foreground broadcasts so can
2957 * execute in a different order.
2958 * @hide
2959 */
2960 public static final String ACTION_USER_STARTING =
2961 "android.intent.action.USER_STARTING";
2962
2963 /**
2964 * Broadcast sent when a user is going to be stopped. Carries an extra
2965 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2966 * sent to registered receivers, not manifest receivers. It is sent to all
2967 * users (including the one that is being stopped). You must hold
2968 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2969 * this broadcast. The user will not stop until all receivers have
2970 * handled the broadcast. This is sent as a background broadcast, since
2971 * its result is not part of the primary UX flow; to safely keep track of
2972 * started/stopped state of a user you can use this in conjunction with
2973 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2974 * other user state broadcasts since those are foreground broadcasts so can
2975 * execute in a different order.
2976 * @hide
2977 */
2978 public static final String ACTION_USER_STOPPING =
2979 "android.intent.action.USER_STOPPING";
2980
2981 /**
2982 * Broadcast sent to the system when a user is stopped. Carries an extra
2983 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2984 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2985 * specific package. This is only sent to registered receivers, not manifest
2986 * receivers. It is sent to all running users <em>except</em> the one that
2987 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002988 * @hide
2989 */
2990 public static final String ACTION_USER_STOPPED =
2991 "android.intent.action.USER_STOPPED";
2992
2993 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002994 * 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 -07002995 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002996 * one that has been removed. The user will not be completely removed until all receivers have
2997 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002998 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002999 * @hide
3000 */
3001 public static final String ACTION_USER_REMOVED =
3002 "android.intent.action.USER_REMOVED";
3003
3004 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003005 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07003006 * the userHandle of the user to become the current one. This is only sent to
3007 * registered receivers, not manifest receivers. It is sent to all running users.
3008 * You must hold
3009 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07003010 * @hide
3011 */
3012 public static final String ACTION_USER_SWITCHED =
3013 "android.intent.action.USER_SWITCHED";
3014
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003015 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003016 * Broadcast Action: Sent when the credential-encrypted private storage has
3017 * become unlocked for the target user. This is only sent to registered
3018 * receivers, not manifest receivers.
3019 */
3020 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3021 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3022
3023 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003024 * Broadcast sent to the system when a user's information changes. Carries an extra
3025 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003026 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003027 * @hide
3028 */
3029 public static final String ACTION_USER_INFO_CHANGED =
3030 "android.intent.action.USER_INFO_CHANGED";
3031
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003032 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003033 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3034 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003035 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3036 * that need to display merged content across both primary and managed profiles need to
3037 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003038 * not manifest receivers.
3039 */
3040 public static final String ACTION_MANAGED_PROFILE_ADDED =
3041 "android.intent.action.MANAGED_PROFILE_ADDED";
3042
3043 /**
3044 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003045 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3046 * Only applications (for example Launchers) that need to display merged content across both
3047 * primary and managed profiles need to worry about this broadcast. This is only sent to
3048 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003049 */
3050 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3051 "android.intent.action.MANAGED_PROFILE_REMOVED";
3052
3053 /**
Kenny Guyb1b30262016-02-09 16:02:35 +00003054 * Broadcast sent to the primary user when the credential-encrypted private storage for
3055 * an associated managed profile is unlocked. Carries an extra {@link #EXTRA_USER} that
3056 * specifies the UserHandle of the profile that was unlocked. Only applications (for example
3057 * Launchers) that need to display merged content across both primary and managed profiles
3058 * need to worry about this broadcast. This is only sent to registered receivers,
3059 * not manifest receivers.
3060 */
3061 public static final String ACTION_MANAGED_PROFILE_UNLOCKED =
3062 "android.intent.action.MANAGED_PROFILE_UNLOCKED";
3063
3064 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003065 * Broadcast sent to the primary user when an associated managed profile's availability has
Rubin Xuf13c9802016-01-21 18:06:00 +00003066 * changed. This includes when the user toggles the profile's quiet mode. Carries an extra
3067 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3068 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3069 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003070 */
3071 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3072 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3073
3074 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003075 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3076 */
3077 public static final String ACTION_QUICK_CLOCK =
3078 "android.intent.action.QUICK_CLOCK";
3079
Michael Wright0087a142013-02-05 16:29:39 -08003080 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003081 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003082 * @hide
3083 */
3084 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3085 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3086
Justin Kohd378ad72013-04-01 12:18:26 -07003087 /**
3088 * Broadcast Action: A global button was pressed. Includes a single
3089 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3090 * caused the broadcast.
3091 * @hide
3092 */
3093 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3094
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003095 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003096 * Broadcast Action: Sent when media resource is granted.
3097 * <p>
3098 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3099 * granted.
3100 * </p>
3101 * <p class="note">
3102 * This is a protected intent that can only be sent by the system.
3103 * </p>
3104 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003105 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003106 * </p>
3107 *
3108 * @hide
3109 */
3110 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3111 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3112
3113 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003114 * Activity Action: Allow the user to select and return one or more existing
3115 * documents. When invoked, the system will display the various
3116 * {@link DocumentsProvider} instances installed on the device, letting the
3117 * user interactively navigate through them. These documents include local
3118 * media, such as photos and video, and documents provided by installed
3119 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003120 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003121 * Each document is represented as a {@code content://} URI backed by a
3122 * {@link DocumentsProvider}, which can be opened as a stream with
3123 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3124 * {@link android.provider.DocumentsContract.Document} metadata.
3125 * <p>
3126 * All selected documents are returned to the calling application with
3127 * persistable read and write permission grants. If you want to maintain
3128 * access to the documents across device reboots, you need to explicitly
3129 * take the persistable permissions using
3130 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3131 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003132 * Callers must indicate the acceptable document MIME types through
3133 * {@link #setType(String)}. For example, to select photos, use
3134 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3135 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3136 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003137 * <p>
3138 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003139 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3140 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003141 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003142 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3143 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003144 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003145 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003146 * Output: The URI of the item that was picked, returned in
3147 * {@link #getData()}. This must be a {@code content://} URI so that any
3148 * receiver can access it. If multiple documents were selected, they are
3149 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003150 *
3151 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003152 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003153 * @see #ACTION_CREATE_DOCUMENT
3154 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003155 */
3156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3157 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3158
3159 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003160 * Activity Action: Allow the user to create a new document. When invoked,
3161 * the system will display the various {@link DocumentsProvider} instances
3162 * installed on the device, letting the user navigate through them. The
3163 * returned document may be a newly created document with no content, or it
3164 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003165 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003166 * Each document is represented as a {@code content://} URI backed by a
3167 * {@link DocumentsProvider}, which can be opened as a stream with
3168 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3169 * {@link android.provider.DocumentsContract.Document} metadata.
3170 * <p>
3171 * Callers must indicate the concrete MIME type of the document being
3172 * created by setting {@link #setType(String)}. This MIME type cannot be
3173 * changed after the document is created.
3174 * <p>
3175 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3176 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003177 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003178 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3179 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003180 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003181 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003182 * Output: The URI of the item that was created. This must be a
3183 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003184 *
3185 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003186 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003187 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003188 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003189 */
3190 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3191 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3192
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003193 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003194 * Activity Action: Allow the user to pick a directory subtree. When
3195 * invoked, the system will display the various {@link DocumentsProvider}
3196 * instances installed on the device, letting the user navigate through
3197 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003198 * <p>
3199 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003200 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3201 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3202 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003203 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003204 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003205 *
3206 * @see DocumentsContract
3207 */
3208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003209 public static final String
3210 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003211
Felipe Lemec7b1f892016-01-15 15:02:31 -08003212 /**
Peng Xua35b5532016-01-20 00:05:45 -08003213 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3214 * exisiting sensor being disconnected.
3215 *
3216 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3217 *
3218 * {@hide}
3219 */
3220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3221 public static final String
3222 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3223
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003224 /** {@hide} */
3225 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3226
Christopher Tate6597e342015-02-17 12:15:25 -08003227 /**
3228 * Broadcast action: report that a settings element is being restored from backup. The intent
3229 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3230 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3231 * is the value of that settings entry prior to the restore operation. All of these values are
3232 * represented as strings.
3233 *
3234 * <p>This broadcast is sent only for settings provider entries known to require special handling
3235 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3236 * the provider's backup agent implementation.
3237 *
3238 * @see #EXTRA_SETTING_NAME
3239 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3240 * @see #EXTRA_SETTING_NEW_VALUE
3241 * {@hide}
3242 */
3243 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3244
3245 /** {@hide} */
3246 public static final String EXTRA_SETTING_NAME = "setting_name";
3247 /** {@hide} */
3248 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3249 /** {@hide} */
3250 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3251
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003252 /**
3253 * Activity Action: Process a piece of text.
3254 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3255 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3256 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3257 */
3258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3259 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3260 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003261 * The name of the extra used to define the text to be processed, as a
3262 * CharSequence. Note that this may be a styled CharSequence, so you must use
3263 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003264 */
3265 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3266 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003267 * The name of the boolean extra used to define if the processed text will be used as read-only.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003268 */
3269 public static final String EXTRA_PROCESS_TEXT_READONLY =
3270 "android.intent.extra.PROCESS_TEXT_READONLY";
3271
Bryce Leebc58f592015-09-25 16:43:01 -07003272 /**
3273 * Broadcast action: reports when a new thermal event has been reached. When the device
3274 * is reaching its maximum temperatue, the thermal level reported
3275 * {@hide}
3276 */
3277 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3278 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3279
3280 /** {@hide} */
3281 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3282
3283 /**
3284 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003285 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003286 * {@hide}
3287 */
3288 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3289
3290 /**
3291 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003292 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003293 * {@hide}
3294 */
3295 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3296
3297 /**
3298 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003299 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003300 * {@hide}
3301 */
3302 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3303
3304
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003305 // ---------------------------------------------------------------------
3306 // ---------------------------------------------------------------------
3307 // Standard intent categories (see addCategory()).
3308
3309 /**
3310 * Set if the activity should be an option for the default action
3311 * (center press) to perform on a piece of data. Setting this will
3312 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003313 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003314 * Intent when initiating an action -- it is for use in intent filters
3315 * specified in packages.
3316 */
3317 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3318 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3319 /**
3320 * Activities that can be safely invoked from a browser must support this
3321 * category. For example, if the user is viewing a web page or an e-mail
3322 * and clicks on a link in the text, the Intent generated execute that
3323 * link will require the BROWSABLE category, so that only activities
3324 * supporting this category will be considered as possible actions. By
3325 * supporting this category, you are promising that there is nothing
3326 * damaging (without user intervention) that can happen by invoking any
3327 * matching Intent.
3328 */
3329 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3330 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3331 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003332 * Categories for activities that can participate in voice interaction.
3333 * An activity that supports this category must be prepared to run with
3334 * no UI shown at all (though in some case it may have a UI shown), and
3335 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3336 */
3337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3338 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3339 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003340 * Set if the activity should be considered as an alternative action to
3341 * the data the user is currently viewing. See also
3342 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3343 * applies to the selection in a list of items.
3344 *
3345 * <p>Supporting this category means that you would like your activity to be
3346 * displayed in the set of alternative things the user can do, usually as
3347 * part of the current activity's options menu. You will usually want to
3348 * include a specific label in the &lt;intent-filter&gt; of this action
3349 * describing to the user what it does.
3350 *
3351 * <p>The action of IntentFilter with this category is important in that it
3352 * describes the specific action the target will perform. This generally
3353 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3354 * a specific name such as "com.android.camera.action.CROP. Only one
3355 * alternative of any particular action will be shown to the user, so using
3356 * a specific action like this makes sure that your alternative will be
3357 * displayed while also allowing other applications to provide their own
3358 * overrides of that particular action.
3359 */
3360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3361 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3362 /**
3363 * Set if the activity should be considered as an alternative selection
3364 * action to the data the user has currently selected. This is like
3365 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3366 * of items from which the user can select, giving them alternatives to the
3367 * default action that will be performed on it.
3368 */
3369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3370 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3371 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003372 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003373 */
3374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3375 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3376 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003377 * Should be displayed in the top-level launcher.
3378 */
3379 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3380 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3381 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003382 * Indicates an activity optimized for Leanback mode, and that should
3383 * be displayed in the Leanback launcher.
3384 */
3385 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3386 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3387 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003388 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3389 * @hide
3390 */
3391 @SystemApi
3392 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3393 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003394 * Provides information about the package it is in; typically used if
3395 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3396 * a front-door to the user without having to be shown in the all apps list.
3397 */
3398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3399 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003401 * This is the home activity, that is the first activity that is displayed
3402 * when the device boots.
3403 */
3404 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3405 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3406 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003407 * This is the home activity that is displayed when the device is finished setting up and ready
3408 * for use.
3409 * @hide
3410 */
3411 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3412 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3413 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003414 * This is the setup wizard activity, that is the first activity that is displayed
3415 * when the user sets up the device for the first time.
3416 * @hide
3417 */
3418 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3419 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3420 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 * This activity is a preference panel.
3422 */
3423 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3424 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3425 /**
3426 * This activity is a development preference panel.
3427 */
3428 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3429 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3430 /**
3431 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003432 */
3433 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3434 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3435 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003436 * This activity allows the user to browse and download new applications.
3437 */
3438 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3439 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3440 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441 * This activity may be exercised by the monkey or other automated test tools.
3442 */
3443 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3444 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3445 /**
3446 * To be used as a test (not part of the normal user experience).
3447 */
3448 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3449 /**
3450 * To be used as a unit test (run through the Test Harness).
3451 */
3452 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3453 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003454 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003455 * experience).
3456 */
3457 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003459 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003460 * Used to indicate that an intent only wants URIs that can be opened with
3461 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3462 * must support at least the columns defined in {@link OpenableColumns} when
3463 * queried.
3464 *
3465 * @see #ACTION_GET_CONTENT
3466 * @see #ACTION_OPEN_DOCUMENT
3467 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 */
3469 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3470 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3471
3472 /**
3473 * To be used as code under test for framework instrumentation tests.
3474 */
3475 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3476 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003477 /**
3478 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003479 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3480 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003481 */
3482 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3483 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3484 /**
3485 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003486 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3487 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003488 */
3489 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3490 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003491 /**
3492 * An activity to run when device is inserted into a analog (low end) dock.
3493 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3494 * information, see {@link android.app.UiModeManager}.
3495 */
3496 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3497 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3498
3499 /**
3500 * An activity to run when device is inserted into a digital (high end) dock.
3501 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3502 * information, see {@link android.app.UiModeManager}.
3503 */
3504 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3505 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003506
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003507 /**
3508 * Used to indicate that the activity can be used in a car environment.
3509 */
3510 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3511 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3512
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003513 // ---------------------------------------------------------------------
3514 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003515 // Application launch intent categories (see addCategory()).
3516
3517 /**
3518 * Used with {@link #ACTION_MAIN} to launch the browser application.
3519 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003520 * <p>NOTE: This should not be used as the primary key of an Intent,
3521 * since it will not result in the app launching with the correct
3522 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003523 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003524 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003525 */
3526 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3527 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3528
3529 /**
3530 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3531 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003532 * <p>NOTE: This should not be used as the primary key of an Intent,
3533 * since it will not result in the app launching with the correct
3534 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003535 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003536 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003537 */
3538 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3539 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3540
3541 /**
3542 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3543 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003544 * <p>NOTE: This should not be used as the primary key of an Intent,
3545 * since it will not result in the app launching with the correct
3546 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003547 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003548 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003549 */
3550 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3551 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3552
3553 /**
3554 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3555 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003556 * <p>NOTE: This should not be used as the primary key of an Intent,
3557 * since it will not result in the app launching with the correct
3558 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003559 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003560 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003561 */
3562 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3563 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3564
3565 /**
3566 * Used with {@link #ACTION_MAIN} to launch the email application.
3567 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003568 * <p>NOTE: This should not be used as the primary key of an Intent,
3569 * since it will not result in the app launching with the correct
3570 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003571 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003572 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003573 */
3574 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3575 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3576
3577 /**
3578 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3579 * The activity should be able to view and manipulate image and video files
3580 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003581 * <p>NOTE: This should not be used as the primary key of an Intent,
3582 * since it will not result in the app launching with the correct
3583 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003584 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003585 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003586 */
3587 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3588 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3589
3590 /**
3591 * Used with {@link #ACTION_MAIN} to launch the maps application.
3592 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003593 * <p>NOTE: This should not be used as the primary key of an Intent,
3594 * since it will not result in the app launching with the correct
3595 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003596 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003597 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003598 */
3599 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3600 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3601
3602 /**
3603 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3604 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003605 * <p>NOTE: This should not be used as the primary key of an Intent,
3606 * since it will not result in the app launching with the correct
3607 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003608 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003609 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003610 */
3611 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3612 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3613
3614 /**
3615 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003616 * The activity should be able to play, browse, or manipulate music files
3617 * stored on the device.
3618 * <p>NOTE: This should not be used as the primary key of an Intent,
3619 * since it will not result in the app launching with the correct
3620 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003621 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003622 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003623 */
3624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3625 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3626
3627 // ---------------------------------------------------------------------
3628 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629 // Standard extra data keys.
3630
3631 /**
3632 * The initial data to place in a newly created record. Use with
3633 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3634 * fields as would be given to the underlying ContentProvider.insert()
3635 * call.
3636 */
3637 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3638
3639 /**
3640 * A constant CharSequence that is associated with the Intent, used with
3641 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3642 * this may be a styled CharSequence, so you must use
3643 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3644 * retrieve it.
3645 */
3646 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3647
3648 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003649 * A constant String that is associated with the Intent, used with
3650 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3651 * as HTML formatted text. Note that you <em>must</em> also supply
3652 * {@link #EXTRA_TEXT}.
3653 */
3654 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3655
3656 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 * A content: URI holding a stream of data associated with the Intent,
3658 * used with {@link #ACTION_SEND} to supply the data being sent.
3659 */
3660 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3661
3662 /**
3663 * A String[] holding e-mail addresses that should be delivered to.
3664 */
3665 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3666
3667 /**
3668 * A String[] holding e-mail addresses that should be carbon copied.
3669 */
3670 public static final String EXTRA_CC = "android.intent.extra.CC";
3671
3672 /**
3673 * A String[] holding e-mail addresses that should be blind carbon copied.
3674 */
3675 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3676
3677 /**
3678 * A constant string holding the desired subject line of a message.
3679 */
3680 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3681
3682 /**
3683 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003684 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003685 */
3686 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3687
3688 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003689 * An int representing the user id to be used.
3690 *
3691 * @hide
3692 */
3693 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3694
3695 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003696 * An int representing the task id to be retrieved. This is used when a launch from recents is
3697 * intercepted by another action such as credentials confirmation to remember which task should
3698 * be resumed when complete.
3699 *
3700 * @hide
3701 */
3702 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3703
3704 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003705 * An Intent[] describing additional, alternate choices you would like shown with
3706 * {@link #ACTION_CHOOSER}.
3707 *
3708 * <p>An app may be capable of providing several different payload types to complete a
3709 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3710 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3711 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3712 * photo data or a hosted link where the photos can be viewed.</p>
3713 *
3714 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3715 * first/primary/preferred intent in the set. Additional intents specified in
3716 * this extra are ordered; by default intents that appear earlier in the array will be
3717 * preferred over intents that appear later in the array as matches for the same
3718 * target component. To alter this preference, a calling app may also supply
3719 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3720 */
3721 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3722
3723 /**
3724 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3725 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3726 *
3727 * <p>An app preparing an action for another app to complete may wish to allow the user to
3728 * disambiguate between several options for completing the action based on the chosen target
3729 * or otherwise refine the action before it is invoked.
3730 * </p>
3731 *
3732 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3733 * <ul>
3734 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3735 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3736 * chosen target beyond the first</li>
3737 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3738 * should fill in and send once the disambiguation is complete</li>
3739 * </ul>
3740 */
3741 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3742 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3743
3744 /**
3745 * A {@link ResultReceiver} used to return data back to the sender.
3746 *
3747 * <p>Used to complete an app-specific
3748 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3749 *
3750 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3751 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3752 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3753 * when the user selects a target component from the chooser. It is up to the recipient
3754 * to send a result to this ResultReceiver to signal that disambiguation is complete
3755 * and that the chooser should invoke the user's choice.</p>
3756 *
3757 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3758 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3759 * to match and fill in the final Intent or ChooserTarget before starting it.
3760 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3761 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3762 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3763 *
3764 * <p>The result code passed to the ResultReceiver should be
3765 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3766 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3767 * the chooser should finish without starting a target.</p>
3768 */
3769 public static final String EXTRA_RESULT_RECEIVER
3770 = "android.intent.extra.RESULT_RECEIVER";
3771
3772 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003773 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003774 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003775 */
3776 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3777
3778 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003779 * A Parcelable[] of {@link Intent} or
3780 * {@link android.content.pm.LabeledIntent} objects as set with
3781 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3782 * a the front of the list of choices, when shown to the user with a
3783 * {@link #ACTION_CHOOSER}.
3784 */
3785 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3786
3787 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003788 * A {@link IntentSender} to start after ephemeral installation success.
3789 * @hide
3790 */
3791 @SystemApi
3792 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3793
3794 /**
3795 * A {@link IntentSender} to start after ephemeral installation failure.
3796 * @hide
3797 */
3798 @SystemApi
3799 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3800
3801 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003802 * A Bundle forming a mapping of potential target package names to different extras Bundles
3803 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3804 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3805 * be currently installed on the device.
3806 *
3807 * <p>An application may choose to provide alternate extras for the case where a user
3808 * selects an activity from a predetermined set of target packages. If the activity
3809 * the user selects from the chooser belongs to a package with its package name as
3810 * a key in this bundle, the corresponding extras for that package will be merged with
3811 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3812 * extra has the same key as an extra already present in the intent it will overwrite
3813 * the extra from the intent.</p>
3814 *
3815 * <p><em>Examples:</em>
3816 * <ul>
3817 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3818 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3819 * parameters for that target.</li>
3820 * <li>An application may offer additional metadata for known targets of a given intent
3821 * to pass along information only relevant to that target such as account or content
3822 * identifiers already known to that application.</li>
3823 * </ul></p>
3824 */
3825 public static final String EXTRA_REPLACEMENT_EXTRAS =
3826 "android.intent.extra.REPLACEMENT_EXTRAS";
3827
3828 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003829 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3830 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3831 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3832 * {@link ComponentName} of the chosen component.
3833 *
3834 * <p>In some situations this callback may never come, for example if the user abandons
3835 * the chooser, switches to another task or any number of other reasons. Apps should not
3836 * be written assuming that this callback will always occur.</p>
3837 */
3838 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3839 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3840
3841 /**
3842 * The {@link ComponentName} chosen by the user to complete an action.
3843 *
3844 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3845 */
3846 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3847
3848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003849 * A {@link android.view.KeyEvent} object containing the event that
3850 * triggered the creation of the Intent it is in.
3851 */
3852 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3853
3854 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003855 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3856 * before shutting down.
3857 *
3858 * {@hide}
3859 */
3860 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3861
3862 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003863 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3864 * requested by the user.
3865 *
3866 * {@hide}
3867 */
3868 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3869 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3870
3871 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003872 * 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 -07003873 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3874 * of restarting the application.
3875 */
3876 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3877
3878 /**
3879 * A String holding the phone number originally entered in
3880 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3881 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3882 */
3883 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003885 /**
3886 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3887 * intents to supply the uid the package had been assigned. Also an optional
3888 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3889 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3890 * purpose.
3891 */
3892 public static final String EXTRA_UID = "android.intent.extra.UID";
3893
3894 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003895 * @hide String array of package names.
3896 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003897 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003898 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3899
3900 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003901 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3902 * intents to indicate whether this represents a full uninstall (removing
3903 * both the code and its data) or a partial uninstall (leaving its data,
3904 * implying that this is an update).
3905 */
3906 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003907
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003908 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003909 * @hide
3910 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3911 * intents to indicate that at this point the package has been removed for
3912 * all users on the device.
3913 */
3914 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3915 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3916
3917 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003918 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3919 * intents to indicate that this is a replacement of the package, so this
3920 * broadcast will immediately be followed by an add broadcast for a
3921 * different version of the same package.
3922 */
3923 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003926 * Used as an int extra field in {@link android.app.AlarmManager} intents
3927 * to tell the application being invoked how many pending alarms are being
3928 * delievered with the intent. For one-shot alarms this will always be 1.
3929 * For recurring alarms, this might be greater than 1 if the device was
3930 * asleep or powered off at the time an earlier alarm would have been
3931 * delivered.
3932 */
3933 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003934
Jacek Surazski86b6c532009-05-13 14:38:28 +02003935 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003936 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3937 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003938 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3939 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003940 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3941 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3942 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003943 */
3944 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3945
3946 /**
3947 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3948 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003949 */
3950 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3951
3952 /**
3953 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3954 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003955 */
3956 public static final int EXTRA_DOCK_STATE_DESK = 1;
3957
3958 /**
3959 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3960 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003961 */
3962 public static final int EXTRA_DOCK_STATE_CAR = 2;
3963
3964 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003965 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3966 * to represent that the phone is in a analog (low end) dock.
3967 */
3968 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3969
3970 /**
3971 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3972 * to represent that the phone is in a digital (high end) dock.
3973 */
3974 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3975
3976 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003977 * Boolean that can be supplied as meta-data with a dock activity, to
3978 * indicate that the dock should take over the home key when it is active.
3979 */
3980 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003981
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003982 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003983 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3984 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003985 */
3986 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3987
3988 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003989 * Used in the extra field in the remote intent. It's astring token passed with the
3990 * remote intent.
3991 */
3992 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3993 "android.intent.extra.remote_intent_token";
3994
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003995 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003996 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003997 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003998 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003999 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004000 "android.intent.extra.changed_component_name";
4001
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004002 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004003 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004004 * and contains a string array of all of the components that have changed. If
4005 * the state of the overall package has changed, then it will contain an entry
4006 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004007 */
4008 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4009 "android.intent.extra.changed_component_name_list";
4010
4011 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004012 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004013 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004014 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4015 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4016 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004017 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004018 */
4019 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4020 "android.intent.extra.changed_package_list";
4021
4022 /**
4023 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004024 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4025 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004026 * and contains an integer array of uids of all of the components
4027 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004028 */
4029 public static final String EXTRA_CHANGED_UID_LIST =
4030 "android.intent.extra.changed_uid_list";
4031
4032 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004033 * @hide
4034 * Magic extra system code can use when binding, to give a label for
4035 * who it is that has bound to a service. This is an integer giving
4036 * a framework string resource that can be displayed to the user.
4037 */
4038 public static final String EXTRA_CLIENT_LABEL =
4039 "android.intent.extra.client_label";
4040
4041 /**
4042 * @hide
4043 * Magic extra system code can use when binding, to give a PendingIntent object
4044 * that can be launched for the user to disable the system's use of this
4045 * service.
4046 */
4047 public static final String EXTRA_CLIENT_INTENT =
4048 "android.intent.extra.client_intent";
4049
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004050 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004051 * Extra used to indicate that an intent should only return data that is on
4052 * the local device. This is a boolean extra; the default is false. If true,
4053 * an implementation should only allow the user to select data that is
4054 * already on the device, not requiring it be downloaded from a remote
4055 * service when opened.
4056 *
4057 * @see #ACTION_GET_CONTENT
4058 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004059 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004060 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004061 */
4062 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004063 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004064
Amith Yamasani13593602012-03-22 16:16:17 -07004065 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004066 * Extra used to indicate that an intent can allow the user to select and
4067 * return multiple items. This is a boolean extra; the default is false. If
4068 * true, an implementation is allowed to present the user with a UI where
4069 * they can pick multiple items that are all returned to the caller. When
4070 * this happens, they should be returned as the {@link #getClipData()} part
4071 * of the result Intent.
4072 *
4073 * @see #ACTION_GET_CONTENT
4074 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004075 */
4076 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004077 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004078
4079 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004080 * The integer userHandle carried with broadcast intents related to addition, removal and
4081 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4082 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4083 *
Amith Yamasani13593602012-03-22 16:16:17 -07004084 * @hide
4085 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004086 public static final String EXTRA_USER_HANDLE =
4087 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004088
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004089 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004090 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4091 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4092 */
4093 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004094 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004095
4096 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004097 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004098 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4099 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004100 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004101 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4102
4103 /**
4104 * Extra sent in the intent to the BroadcastReceiver that handles
4105 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4106 * the restrictions as key/value pairs.
4107 */
4108 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4109 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004110
Amith Yamasani86118ba2013-03-28 14:33:16 -07004111 /**
4112 * Extra used in the response from a BroadcastReceiver that handles
4113 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4114 */
4115 public static final String EXTRA_RESTRICTIONS_INTENT =
4116 "android.intent.extra.restrictions_intent";
4117
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004118 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004119 * Extra used to communicate a set of acceptable MIME types. The type of the
4120 * extra is {@code String[]}. Values may be a combination of concrete MIME
4121 * types (such as "image/png") and/or partial MIME types (such as
4122 * "audio/*").
4123 *
4124 * @see #ACTION_GET_CONTENT
4125 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004126 */
4127 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4128
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004129 /**
4130 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4131 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004132 * When this is true, hardware devices can use this information to determine that
4133 * they shouldn't do a complete shutdown of their device since this is not a
4134 * complete shutdown down to the kernel, but only user space restarting.
4135 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004136 */
4137 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4138 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4139
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004140 /**
4141 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4142 * user has set their time format preferences to the 24 hour format.
4143 *
4144 * @hide for internal use only.
4145 */
4146 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4147 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4148
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004149 /** {@hide} */
4150 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4151
Rubin Xue8490f12015-06-25 12:17:48 +01004152 /** {@hide} */
4153 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4154
Santos Cordon15a13782015-03-31 18:32:31 -07004155 /**
4156 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4157 * activation request.
4158 * TODO: Add information about the structure and response data used with the pending intent.
4159 * @hide
4160 */
4161 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4162 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4163
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004164 /**
4165 * Optional index with semantics depending on the intent action.
Tomasz Mikolajewskife023132016-03-10 17:42:35 +09004166 *
4167 * <p>The value must be an integer greater or equal to 0.
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004168 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004169 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4170
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004171 /**
4172 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4173 */
4174 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004175
4176 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004177 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004178 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004179 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4180 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004181 *
4182 * @hide
4183 */
4184 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4185 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4186
4187 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004188 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004189 * to represent that a video codec is allowed to use.
4190 *
4191 * @hide
4192 */
4193 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4194
4195 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004196 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004197 * to represent that a audio codec is allowed to use.
4198 *
4199 * @hide
4200 */
4201 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4202
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004203 // ---------------------------------------------------------------------
4204 // ---------------------------------------------------------------------
4205 // Intent flags (see mFlags variable).
4206
Tor Norbyed9273d62013-05-30 15:59:53 -07004207 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004208 @IntDef(flag = true, value = {
4209 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4210 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004211 @Retention(RetentionPolicy.SOURCE)
4212 public @interface GrantUriMode {}
4213
Jeff Sharkey846318a2014-04-04 12:12:41 -07004214 /** @hide */
4215 @IntDef(flag = true, value = {
4216 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4217 @Retention(RetentionPolicy.SOURCE)
4218 public @interface AccessUriMode {}
4219
4220 /**
4221 * Test if given mode flags specify an access mode, which must be at least
4222 * read and/or write.
4223 *
4224 * @hide
4225 */
4226 public static boolean isAccessUriMode(int modeFlags) {
4227 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4228 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4229 }
4230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004231 /**
4232 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004233 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004234 * specified in its ClipData. When applying to an Intent's ClipData,
4235 * all URIs as well as recursive traversals through data or other ClipData
4236 * in Intent items will be granted; only the grant flags of the top-level
4237 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004238 */
4239 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4240 /**
4241 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004242 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004243 * specified in its ClipData. When applying to an Intent's ClipData,
4244 * all URIs as well as recursive traversals through data or other ClipData
4245 * in Intent items will be granted; only the grant flags of the top-level
4246 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004247 */
4248 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4249 /**
4250 * Can be set by the caller to indicate that this Intent is coming from
4251 * a background operation, not from direct user interaction.
4252 */
4253 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4254 /**
4255 * A flag you can enable for debugging: when set, log messages will be
4256 * printed during the resolution of this intent to show you what has
4257 * been found to create the final resolved list.
4258 */
4259 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004260 /**
4261 * If set, this intent will not match any components in packages that
4262 * are currently stopped. If this is not set, then the default behavior
4263 * is to include such applications in the result.
4264 */
4265 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4266 /**
4267 * If set, this intent will always match any components in packages that
4268 * are currently stopped. This is the default behavior when
4269 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4270 * flags are set, this one wins (it allows overriding of exclude for
4271 * places where the framework may automatically set the exclude flag).
4272 */
4273 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004274
4275 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004276 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004277 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004278 * persisted across device reboots until explicitly revoked with
4279 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4280 * grant for possible persisting; the receiving application must call
4281 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4282 * actually persist.
4283 *
4284 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4285 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4286 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004287 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004288 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004289 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004290
4291 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004292 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4293 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4294 * applies to any URI that is a prefix match against the original granted
4295 * URI. (Without this flag, the URI must match exactly for access to be
4296 * granted.) Another URI is considered a prefix match only when scheme,
4297 * authority, and all path segments defined by the prefix are an exact
4298 * match.
4299 */
4300 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4301
4302 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004303 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004304 * homework and verified that they correctly handle packages and components
4305 * that come and go over time. In particular:
4306 * <ul>
4307 * <li>Apps installed on external storage, which will appear to be
4308 * uninstalled while the the device is ejected.
4309 * <li>Apps with encryption unaware components, which will appear to not
4310 * exist while the device is locked.
4311 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004312 *
4313 * @hide
4314 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004315 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004316
4317 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004318 * If set, the new activity is not kept in the history stack. As soon as
4319 * the user navigates away from it, the activity is finished. This may also
4320 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4321 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004322 *
4323 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4324 * is never invoked when the current activity starts a new activity which
4325 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004326 */
4327 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4328 /**
4329 * If set, the activity will not be launched if it is already running
4330 * at the top of the history stack.
4331 */
4332 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4333 /**
4334 * If set, this activity will become the start of a new task on this
4335 * history stack. A task (from the activity that started it to the
4336 * next task activity) defines an atomic group of activities that the
4337 * user can move to. Tasks can be moved to the foreground and background;
4338 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004339 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004340 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4341 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004342 *
4343 * <p>This flag is generally used by activities that want
4344 * to present a "launcher" style behavior: they give the user a list of
4345 * separate things that can be done, which otherwise run completely
4346 * independently of the activity launching them.
4347 *
4348 * <p>When using this flag, if a task is already running for the activity
4349 * you are now starting, then a new activity will not be started; instead,
4350 * the current task will simply be brought to the front of the screen with
4351 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4352 * to disable this behavior.
4353 *
4354 * <p>This flag can not be used when the caller is requesting a result from
4355 * the activity being launched.
4356 */
4357 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4358 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004359 * This flag is used to create a new task and launch an activity into it.
4360 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4361 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4362 * search through existing tasks for ones matching this Intent. Only if no such
4363 * task is found would a new task be created. When paired with
4364 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4365 * the search for a matching task and unconditionally start a new task.
4366 *
4367 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4368 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004369 * top-level application launcher.</strong> Used in conjunction with
4370 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4371 * behavior of bringing an existing task to the foreground. When set,
4372 * a new task is <em>always</em> started to host the Activity for the
4373 * Intent, regardless of whether there is already an existing task running
4374 * the same thing.
4375 *
4376 * <p><strong>Because the default system does not include graphical task management,
4377 * you should not use this flag unless you provide some way for a user to
4378 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004379 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004380 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4381 * creating new document tasks.
4382 *
4383 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004384 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004385 *
Scott Main7aee61f2011-02-08 11:25:01 -08004386 * <p>See
4387 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4388 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004389 *
4390 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4391 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004392 */
4393 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4394 /**
4395 * If set, and the activity being launched is already running in the
4396 * current task, then instead of launching a new instance of that activity,
4397 * all of the other activities on top of it will be closed and this Intent
4398 * will be delivered to the (now on top) old activity as a new Intent.
4399 *
4400 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4401 * If D calls startActivity() with an Intent that resolves to the component
4402 * of activity B, then C and D will be finished and B receive the given
4403 * Intent, resulting in the stack now being: A, B.
4404 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004405 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004406 * either receive the new intent you are starting here in its
4407 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004408 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004409 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4410 * the same intent, then it will be finished and re-created; for all other
4411 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4412 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004413 *
4414 * <p>This launch mode can also be used to good effect in conjunction with
4415 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4416 * of a task, it will bring any currently running instance of that task
4417 * to the foreground, and then clear it to its root state. This is
4418 * especially useful, for example, when launching an activity from the
4419 * notification manager.
4420 *
Scott Main7aee61f2011-02-08 11:25:01 -08004421 * <p>See
4422 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4423 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004424 */
4425 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4426 /**
4427 * If set and this intent is being used to launch a new activity from an
4428 * existing one, then the reply target of the existing activity will be
4429 * transfered to the new activity. This way the new activity can call
4430 * {@link android.app.Activity#setResult} and have that result sent back to
4431 * the reply target of the original activity.
4432 */
4433 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4434 /**
4435 * If set and this intent is being used to launch a new activity from an
4436 * existing one, the current activity will not be counted as the top
4437 * activity for deciding whether the new intent should be delivered to
4438 * the top instead of starting a new one. The previous activity will
4439 * be used as the top, with the assumption being that the current activity
4440 * will finish itself immediately.
4441 */
4442 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4443 /**
4444 * If set, the new activity is not kept in the list of recently launched
4445 * activities.
4446 */
4447 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4448 /**
4449 * This flag is not normally set by application code, but set for you by
4450 * the system as described in the
4451 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4452 * launchMode} documentation for the singleTask mode.
4453 */
4454 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4455 /**
4456 * If set, and this activity is either being started in a new task or
4457 * bringing to the top an existing task, then it will be launched as
4458 * the front door of the task. This will result in the application of
4459 * any affinities needed to have that task in the proper state (either
4460 * moving activities to or from it), or simply resetting that task to
4461 * its initial state if needed.
4462 */
4463 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4464 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004465 * This flag is not normally set by application code, but set for you by
4466 * the system if this activity is being launched from history
4467 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004468 */
4469 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004470 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004471 * @deprecated As of API 21 this performs identically to
4472 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004473 */
4474 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004475 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004476 * This flag is used to open a document into a new task rooted at the activity launched
4477 * by this Intent. Through the use of this flag, or its equivalent attribute,
4478 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004479 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004480 *
Craig Mautner026596b2014-05-21 15:35:44 -07004481 * <p>The use of the activity attribute form of this,
4482 * {@link android.R.attr#documentLaunchMode}, is
4483 * preferred over the Intent flag described here. The attribute form allows the
4484 * Activity to specify multiple document behavior for all launchers of the Activity
4485 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004486 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004487 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4488 * it is kept after the activity is finished is different than the use of
4489 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4490 * this flag is being used to create a new recents entry, then by default that entry
4491 * will be removed once the activity is finished. You can modify this behavior with
4492 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4493 *
Craig Mautner026596b2014-05-21 15:35:44 -07004494 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4495 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4496 * equivalent of the Activity manifest specifying {@link
4497 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4498 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4499 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004500 *
Craig Mautner026596b2014-05-21 15:35:44 -07004501 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004502 *
Craig Mautner026596b2014-05-21 15:35:44 -07004503 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004504 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4505 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004506 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004507 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004508 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004509 * callback from occurring on the current frontmost activity before it is
4510 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004511 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004512 * <p>Typically, an activity can rely on that callback to indicate that an
4513 * explicit user action has caused their activity to be moved out of the
4514 * foreground. The callback marks an appropriate point in the activity's
4515 * lifecycle for it to dismiss any notifications that it intends to display
4516 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004517 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004518 * <p>If an activity is ever started via any non-user-driven events such as
4519 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4520 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004521 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004522 */
4523 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004524 /**
4525 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4526 * this flag will cause the launched activity to be brought to the front of its
4527 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004528 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004529 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4530 * If D calls startActivity() with an Intent that resolves to the component
4531 * of activity B, then B will be brought to the front of the history stack,
4532 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004533 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004534 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004535 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004536 */
4537 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004538 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004539 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4540 * this flag will prevent the system from applying an activity transition
4541 * animation to go to the next activity state. This doesn't mean an
4542 * animation will never run -- if another activity change happens that doesn't
4543 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004544 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004545 * when you are going to do a series of activity operations but the
4546 * animation seen by the user shouldn't be driven by the first activity
4547 * change but rather a later one.
4548 */
4549 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4550 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004551 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4552 * this flag will cause any existing task that would be associated with the
4553 * activity to be cleared before the activity is started. That is, the activity
4554 * becomes the new root of an otherwise empty task, and any old activities
4555 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4556 */
4557 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4558 /**
4559 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4560 * this flag will cause a newly launching task to be placed on top of the current
4561 * home activity task (if there is one). That is, pressing back from the task
4562 * will always return the user to home even if that was not the last activity they
4563 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4564 */
4565 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4566 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004567 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4568 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004569 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004570 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004571 * this flag. When set and the task's activity is finished, the recents
4572 * entry will remain in the interface for the user to re-launch it, like a
4573 * recents entry for a top-level application.
4574 * <p>
4575 * The receiving activity can override this request with
4576 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4577 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004578 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004579 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004580 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004581
4582 /**
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004583 * This flag is only used in split-screen multi-window mode. The new activity will be displayed
4584 * adjacent to the one launching it. This can only be used in conjunction with
Wale Ogunwale6bdf2572016-03-11 15:22:38 -08004585 * {@link #FLAG_ACTIVITY_NEW_TASK}. Also, setting {@link #FLAG_ACTIVITY_MULTIPLE_TASK} is
4586 * required if you want a new instance of an existing activity to be created.
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004587 */
Wale Ogunwale2a25a622016-01-30 11:27:21 -08004588 public static final int FLAG_ACTIVITY_LAUNCH_ADJACENT = 0x00001000;
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004589
4590 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004591 * If set, when sending a broadcast only registered receivers will be
4592 * called -- no BroadcastReceiver components will be launched.
4593 */
4594 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004595 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004596 * If set, when sending a broadcast the new broadcast will replace
4597 * any existing pending broadcast that matches it. Matching is defined
4598 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4599 * true for the intents of the two broadcasts. When a match is found,
4600 * the new broadcast (and receivers associated with it) will replace the
4601 * existing one in the pending broadcast list, remaining at the same
4602 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004603 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004604 * <p>This flag is most typically used with sticky broadcasts, which
4605 * only care about delivering the most recent values of the broadcast
4606 * to their receivers.
4607 */
4608 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4609 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004610 * If set, when sending a broadcast the recipient is allowed to run at
4611 * foreground priority, with a shorter timeout interval. During normal
4612 * broadcasts the receivers are not automatically hoisted out of the
4613 * background priority class.
4614 */
4615 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4616 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004617 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4618 * They can still propagate results through to later receivers, but they can not prevent
4619 * later receivers from seeing the broadcast.
4620 */
4621 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4622 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004623 * If set, when sending a broadcast <i>before boot has completed</i> only
4624 * registered receivers will be called -- no BroadcastReceiver components
4625 * will be launched. Sticky intent state will be recorded properly even
4626 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4627 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004628 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004629 * <p>This flag is only for use by system sevices as a convenience to
4630 * avoid having to implement a more complex mechanism around detection
4631 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004632 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004633 * @hide
4634 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004635 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004636 /**
4637 * Set when this broadcast is for a boot upgrade, a special mode that
4638 * allows the broadcast to be sent before the system is ready and launches
4639 * the app process with no providers running in it.
4640 * @hide
4641 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004642 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004643 /**
4644 * If set, the broadcast will always go to manifest receivers in background (cached
4645 * or not running) apps, regardless of whether that would be done by default. By
4646 * default they will only receive broadcasts if the broadcast has specified an
4647 * explicit component or package name.
4648 * @hide
4649 */
4650 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4651 /**
4652 * If set, the broadcast will never go to manifest receivers in background (cached
4653 * or not running) apps, regardless of whether that would be done by default. By
4654 * default they will receive broadcasts if the broadcast has specified an
4655 * explicit component or package name.
4656 * @hide
4657 */
4658 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004659
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004660 /**
4661 * @hide Flags that can't be changed with PendingIntent.
4662 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004663 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4664 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4665 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004667 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004668 // ---------------------------------------------------------------------
4669 // toUri() and parseUri() options.
4670
4671 /**
4672 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4673 * always has the "intent:" scheme. This syntax can be used when you want
4674 * to later disambiguate between URIs that are intended to describe an
4675 * Intent vs. all others that should be treated as raw URIs. When used
4676 * with {@link #parseUri}, any other scheme will result in a generic
4677 * VIEW action for that raw URI.
4678 */
4679 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004680
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004681 /**
4682 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4683 * always has the "android-app:" scheme. This is a variation of
4684 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4685 * http/https URI being delivered to a specific package name. The format
4686 * is:
4687 *
4688 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004689 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004690 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004691 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4692 * you must also include a scheme; including a path also requires both a host and a scheme.
4693 * The final #Intent; fragment can be used without a scheme, host, or path.
4694 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004695 * used with intents that have a {@link #setSelector}, since the base intent
4696 * will always have an explicit package name.</p>
4697 *
4698 * <p>Some examples of how this scheme maps to Intent objects:</p>
4699 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4700 * <colgroup align="left" />
4701 * <colgroup align="left" />
4702 * <thead>
4703 * <tr><th>URI</th> <th>Intent</th></tr>
4704 * </thead>
4705 *
4706 * <tbody>
4707 * <tr><td><code>android-app://com.example.app</code></td>
4708 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4709 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4710 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4711 * </table></td>
4712 * </tr>
4713 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4714 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4715 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4716 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4717 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4718 * </table></td>
4719 * </tr>
4720 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4721 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4722 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4723 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4724 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4725 * </table></td>
4726 * </tr>
4727 * <tr><td><code>android-app://com.example.app/<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4728 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4729 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4730 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4731 * </table></td>
4732 * </tr>
4733 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4734 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4735 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4736 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4737 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4738 * </table></td>
4739 * </tr>
4740 * <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>
4741 * <td><table border="" style="margin:0" >
4742 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4743 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4744 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4745 * </table></td>
4746 * </tr>
4747 * </tbody>
4748 * </table>
4749 */
4750 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4751
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004752 /**
4753 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4754 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4755 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4756 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4757 * generated Intent can not cause unexpected data access to happen.
4758 *
4759 * <p>If you do not trust the source of the URI being parsed, you should still do further
4760 * processing to protect yourself from it. In particular, when using it to start an
4761 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4762 * that can handle it.</p>
4763 */
4764 public static final int URI_ALLOW_UNSAFE = 1<<2;
4765
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004766 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004767
4768 private String mAction;
4769 private Uri mData;
4770 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004771 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004772 private ComponentName mComponent;
4773 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004774 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004775 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004776 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004777 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004778 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004779 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004780
4781 // ---------------------------------------------------------------------
4782
4783 /**
4784 * Create an empty intent.
4785 */
4786 public Intent() {
4787 }
4788
4789 /**
4790 * Copy constructor.
4791 */
4792 public Intent(Intent o) {
4793 this.mAction = o.mAction;
4794 this.mData = o.mData;
4795 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004796 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004797 this.mComponent = o.mComponent;
4798 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004799 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004800 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004801 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004802 }
4803 if (o.mExtras != null) {
4804 this.mExtras = new Bundle(o.mExtras);
4805 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004806 if (o.mSourceBounds != null) {
4807 this.mSourceBounds = new Rect(o.mSourceBounds);
4808 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004809 if (o.mSelector != null) {
4810 this.mSelector = new Intent(o.mSelector);
4811 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004812 if (o.mClipData != null) {
4813 this.mClipData = new ClipData(o.mClipData);
4814 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004815 }
4816
4817 @Override
4818 public Object clone() {
4819 return new Intent(this);
4820 }
4821
4822 private Intent(Intent o, boolean all) {
4823 this.mAction = o.mAction;
4824 this.mData = o.mData;
4825 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004826 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004827 this.mComponent = o.mComponent;
4828 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004829 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004830 }
4831 }
4832
4833 /**
4834 * Make a clone of only the parts of the Intent that are relevant for
4835 * filter matching: the action, data, type, component, and categories.
4836 */
4837 public Intent cloneFilter() {
4838 return new Intent(this, false);
4839 }
4840
4841 /**
4842 * Create an intent with a given action. All other fields (data, type,
4843 * class) are null. Note that the action <em>must</em> be in a
4844 * namespace because Intents are used globally in the system -- for
4845 * example the system VIEW action is android.intent.action.VIEW; an
4846 * application's custom action would be something like
4847 * com.google.app.myapp.CUSTOM_ACTION.
4848 *
4849 * @param action The Intent action, such as ACTION_VIEW.
4850 */
4851 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004852 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004853 }
4854
4855 /**
4856 * Create an intent with a given action and for a given data url. Note
4857 * that the action <em>must</em> be in a namespace because Intents are
4858 * used globally in the system -- for example the system VIEW action is
4859 * android.intent.action.VIEW; an application's custom action would be
4860 * something like com.google.app.myapp.CUSTOM_ACTION.
4861 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004862 * <p><em>Note: scheme and host name matching in the Android framework is
4863 * case-sensitive, unlike the formal RFC. As a result,
4864 * you should always ensure that you write your Uri with these elements
4865 * using lower case letters, and normalize any Uris you receive from
4866 * outside of Android to ensure the scheme and host is lower case.</em></p>
4867 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004868 * @param action The Intent action, such as ACTION_VIEW.
4869 * @param uri The Intent data URI.
4870 */
4871 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004872 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873 mData = uri;
4874 }
4875
4876 /**
4877 * Create an intent for a specific component. All other fields (action, data,
4878 * type, class) are null, though they can be modified later with explicit
4879 * calls. This provides a convenient way to create an intent that is
4880 * intended to execute a hard-coded class name, rather than relying on the
4881 * system to find an appropriate class for you; see {@link #setComponent}
4882 * for more information on the repercussions of this.
4883 *
4884 * @param packageContext A Context of the application package implementing
4885 * this class.
4886 * @param cls The component class that is to be used for the intent.
4887 *
4888 * @see #setClass
4889 * @see #setComponent
4890 * @see #Intent(String, android.net.Uri , Context, Class)
4891 */
4892 public Intent(Context packageContext, Class<?> cls) {
4893 mComponent = new ComponentName(packageContext, cls);
4894 }
4895
4896 /**
4897 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004898 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004899 * construct the Intent and then calling {@link #setClass} to set its
4900 * class.
4901 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004902 * <p><em>Note: scheme and host name matching in the Android framework is
4903 * case-sensitive, unlike the formal RFC. As a result,
4904 * you should always ensure that you write your Uri with these elements
4905 * using lower case letters, and normalize any Uris you receive from
4906 * outside of Android to ensure the scheme and host is lower case.</em></p>
4907 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004908 * @param action The Intent action, such as ACTION_VIEW.
4909 * @param uri The Intent data URI.
4910 * @param packageContext A Context of the application package implementing
4911 * this class.
4912 * @param cls The component class that is to be used for the intent.
4913 *
4914 * @see #Intent(String, android.net.Uri)
4915 * @see #Intent(Context, Class)
4916 * @see #setClass
4917 * @see #setComponent
4918 */
4919 public Intent(String action, Uri uri,
4920 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004921 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004922 mData = uri;
4923 mComponent = new ComponentName(packageContext, cls);
4924 }
4925
4926 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004927 * Create an intent to launch the main (root) activity of a task. This
4928 * is the Intent that is started when the application's is launched from
4929 * Home. For anything else that wants to launch an application in the
4930 * same way, it is important that they use an Intent structured the same
4931 * way, and can use this function to ensure this is the case.
4932 *
4933 * <p>The returned Intent has the given Activity component as its explicit
4934 * component, {@link #ACTION_MAIN} as its action, and includes the
4935 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4936 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4937 * to do that through {@link #addFlags(int)} on the returned Intent.
4938 *
4939 * @param mainActivity The main activity component that this Intent will
4940 * launch.
4941 * @return Returns a newly created Intent that can be used to launch the
4942 * activity as a main application entry.
4943 *
4944 * @see #setClass
4945 * @see #setComponent
4946 */
4947 public static Intent makeMainActivity(ComponentName mainActivity) {
4948 Intent intent = new Intent(ACTION_MAIN);
4949 intent.setComponent(mainActivity);
4950 intent.addCategory(CATEGORY_LAUNCHER);
4951 return intent;
4952 }
4953
4954 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004955 * Make an Intent for the main activity of an application, without
4956 * specifying a specific activity to run but giving a selector to find
4957 * the activity. This results in a final Intent that is structured
4958 * the same as when the application is launched from
4959 * Home. For anything else that wants to launch an application in the
4960 * same way, it is important that they use an Intent structured the same
4961 * way, and can use this function to ensure this is the case.
4962 *
4963 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4964 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4965 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4966 * to do that through {@link #addFlags(int)} on the returned Intent.
4967 *
4968 * @param selectorAction The action name of the Intent's selector.
4969 * @param selectorCategory The name of a category to add to the Intent's
4970 * selector.
4971 * @return Returns a newly created Intent that can be used to launch the
4972 * activity as a main application entry.
4973 *
4974 * @see #setSelector(Intent)
4975 */
4976 public static Intent makeMainSelectorActivity(String selectorAction,
4977 String selectorCategory) {
4978 Intent intent = new Intent(ACTION_MAIN);
4979 intent.addCategory(CATEGORY_LAUNCHER);
4980 Intent selector = new Intent();
4981 selector.setAction(selectorAction);
4982 selector.addCategory(selectorCategory);
4983 intent.setSelector(selector);
4984 return intent;
4985 }
4986
4987 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004988 * Make an Intent that can be used to re-launch an application's task
4989 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4990 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4991 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4992 *
4993 * @param mainActivity The activity component that is the root of the
4994 * task; this is the activity that has been published in the application's
4995 * manifest as the main launcher icon.
4996 *
4997 * @return Returns a newly created Intent that can be used to relaunch the
4998 * activity's task in its root state.
4999 */
5000 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5001 Intent intent = makeMainActivity(mainActivity);
5002 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5003 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5004 return intent;
5005 }
5006
5007 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005008 * Call {@link #parseUri} with 0 flags.
5009 * @deprecated Use {@link #parseUri} instead.
5010 */
5011 @Deprecated
5012 public static Intent getIntent(String uri) throws URISyntaxException {
5013 return parseUri(uri, 0);
5014 }
Tom Taylord4a47292009-12-21 13:59:18 -08005015
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005016 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005017 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005018 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005019 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005020 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 *
5022 * <p>The URI given here must not be relative -- that is, it must include
5023 * the scheme and full path.
5024 *
5025 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005026 * @param flags Additional processing flags. Either 0,
5027 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005028 *
5029 * @return Intent The newly created Intent object.
5030 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005031 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5032 * it bad (as parsed by the Uri class) or the Intent data within the
5033 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005034 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005035 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005036 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005037 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005038 int i = 0;
5039 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005040 final boolean androidApp = uri.startsWith("android-app:");
5041
5042 // Validate intent scheme if requested.
5043 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5044 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005045 Intent intent = new Intent(ACTION_VIEW);
5046 try {
5047 intent.setData(Uri.parse(uri));
5048 } catch (IllegalArgumentException e) {
5049 throw new URISyntaxException(uri, e.getMessage());
5050 }
5051 return intent;
5052 }
5053 }
Tom Taylord4a47292009-12-21 13:59:18 -08005054
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005055 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005056 // simple case
5057 if (i == -1) {
5058 if (!androidApp) {
5059 return new Intent(ACTION_VIEW, Uri.parse(uri));
5060 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005061
5062 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005063 } else if (!uri.startsWith("#Intent;", i)) {
5064 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005065 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005066 } else {
5067 i = -1;
5068 }
5069 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005070
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005071 // new format
5072 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005073 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005074 boolean explicitAction = false;
5075 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005076
5077 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005078 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005079 String data;
5080 if (i >= 0) {
5081 data = uri.substring(0, i);
5082 i += 8; // length of "#Intent;"
5083 } else {
5084 data = uri;
5085 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005086
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005088 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005090 if (eq < 0) eq = i-1;
5091 int semi = uri.indexOf(';', i);
5092 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093
5094 // action
5095 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005096 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005097 if (!inSelector) {
5098 explicitAction = true;
5099 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005100 }
5101
5102 // categories
5103 else if (uri.startsWith("category=", i)) {
5104 intent.addCategory(value);
5105 }
5106
5107 // type
5108 else if (uri.startsWith("type=", i)) {
5109 intent.mType = value;
5110 }
5111
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005112 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005113 else if (uri.startsWith("launchFlags=", i)) {
5114 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005115 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5116 intent.mFlags &= ~IMMUTABLE_FLAGS;
5117 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005118 }
5119
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005120 // package
5121 else if (uri.startsWith("package=", i)) {
5122 intent.mPackage = value;
5123 }
5124
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005125 // component
5126 else if (uri.startsWith("component=", i)) {
5127 intent.mComponent = ComponentName.unflattenFromString(value);
5128 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005129
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005130 // scheme
5131 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005132 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005133 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005134 } else {
5135 scheme = value;
5136 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005137 }
5138
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005139 // source bounds
5140 else if (uri.startsWith("sourceBounds=", i)) {
5141 intent.mSourceBounds = Rect.unflattenFromString(value);
5142 }
5143
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005144 // selector
5145 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5146 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005147 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005148 }
5149
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005150 // extra
5151 else {
5152 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005153 // create Bundle if it doesn't already exist
5154 if (intent.mExtras == null) intent.mExtras = new Bundle();
5155 Bundle b = intent.mExtras;
5156 // add EXTRA
5157 if (uri.startsWith("S.", i)) b.putString(key, value);
5158 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5159 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5160 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5161 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5162 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5163 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5164 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5165 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5166 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5167 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005168
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005169 // move to the next item
5170 i = semi + 1;
5171 }
5172
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005173 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005174 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005175 if (baseIntent.mPackage == null) {
5176 baseIntent.setSelector(intent);
5177 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005178 intent = baseIntent;
5179 }
5180
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005181 if (data != null) {
5182 if (data.startsWith("intent:")) {
5183 data = data.substring(7);
5184 if (scheme != null) {
5185 data = scheme + ':' + data;
5186 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005187 } else if (data.startsWith("android-app:")) {
5188 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5189 // Correctly formed android-app, first part is package name.
5190 int end = data.indexOf('/', 14);
5191 if (end < 0) {
5192 // All we have is a package name.
5193 intent.mPackage = data.substring(14);
5194 if (!explicitAction) {
5195 intent.setAction(ACTION_MAIN);
5196 }
5197 data = "";
5198 } else {
5199 // Target the Intent at the given package name always.
5200 String authority = null;
5201 intent.mPackage = data.substring(14, end);
5202 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005203 if ((end+1) < data.length()) {
5204 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5205 // Found a scheme, remember it.
5206 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005207 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005208 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5209 // Found a authority, remember it.
5210 authority = data.substring(end+1, newEnd);
5211 end = newEnd;
5212 }
5213 } else {
5214 // All we have is a scheme.
5215 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005216 }
5217 }
5218 if (scheme == null) {
5219 // If there was no scheme, then this just targets the package.
5220 if (!explicitAction) {
5221 intent.setAction(ACTION_MAIN);
5222 }
5223 data = "";
5224 } else if (authority == null) {
5225 data = scheme + ":";
5226 } else {
5227 data = scheme + "://" + authority + data.substring(end);
5228 }
5229 }
5230 } else {
5231 data = "";
5232 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005233 }
Tom Taylord4a47292009-12-21 13:59:18 -08005234
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005235 if (data.length() > 0) {
5236 try {
5237 intent.mData = Uri.parse(data);
5238 } catch (IllegalArgumentException e) {
5239 throw new URISyntaxException(uri, e.getMessage());
5240 }
5241 }
5242 }
Tom Taylord4a47292009-12-21 13:59:18 -08005243
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005244 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005245
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005246 } catch (IndexOutOfBoundsException e) {
5247 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5248 }
5249 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005250
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005251 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005252 return getIntentOld(uri, 0);
5253 }
5254
5255 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005256 Intent intent;
5257
5258 int i = uri.lastIndexOf('#');
5259 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005260 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005261 final int intentFragmentStart = i;
5262 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005263
5264 i++;
5265
5266 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005267 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268 i += 7;
5269 int j = uri.indexOf(')', i);
5270 action = uri.substring(i, j);
5271 i = j + 1;
5272 }
5273
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005274 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005275
5276 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005277 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005278 i += 11;
5279 int j = uri.indexOf(')', i);
5280 while (i < j) {
5281 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005282 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005283 if (i < sep) {
5284 intent.addCategory(uri.substring(i, sep));
5285 }
5286 i = sep + 1;
5287 }
5288 i = j + 1;
5289 }
5290
5291 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005292 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005293 i += 5;
5294 int j = uri.indexOf(')', i);
5295 intent.mType = uri.substring(i, j);
5296 i = j + 1;
5297 }
5298
5299 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005300 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005301 i += 12;
5302 int j = uri.indexOf(')', i);
5303 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005304 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5305 intent.mFlags &= ~IMMUTABLE_FLAGS;
5306 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005307 i = j + 1;
5308 }
5309
5310 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005311 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005312 i += 10;
5313 int j = uri.indexOf(')', i);
5314 int sep = uri.indexOf('!', i);
5315 if (sep >= 0 && sep < j) {
5316 String pkg = uri.substring(i, sep);
5317 String cls = uri.substring(sep + 1, j);
5318 intent.mComponent = new ComponentName(pkg, cls);
5319 }
5320 i = j + 1;
5321 }
5322
5323 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005324 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005325 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005326
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005327 final int closeParen = uri.indexOf(')', i);
5328 if (closeParen == -1) throw new URISyntaxException(uri,
5329 "EXTRA missing trailing ')'", i);
5330
5331 while (i < closeParen) {
5332 // fetch the key value
5333 int j = uri.indexOf('=', i);
5334 if (j <= i + 1 || i >= closeParen) {
5335 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5336 }
5337 char type = uri.charAt(i);
5338 i++;
5339 String key = uri.substring(i, j);
5340 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005341
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005342 // get type-value
5343 j = uri.indexOf('!', i);
5344 if (j == -1 || j >= closeParen) j = closeParen;
5345 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5346 String value = uri.substring(i, j);
5347 i = j;
5348
5349 // create Bundle if it doesn't already exist
5350 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005351
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005352 // add item to bundle
5353 try {
5354 switch (type) {
5355 case 'S':
5356 intent.mExtras.putString(key, Uri.decode(value));
5357 break;
5358 case 'B':
5359 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5360 break;
5361 case 'b':
5362 intent.mExtras.putByte(key, Byte.parseByte(value));
5363 break;
5364 case 'c':
5365 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5366 break;
5367 case 'd':
5368 intent.mExtras.putDouble(key, Double.parseDouble(value));
5369 break;
5370 case 'f':
5371 intent.mExtras.putFloat(key, Float.parseFloat(value));
5372 break;
5373 case 'i':
5374 intent.mExtras.putInt(key, Integer.parseInt(value));
5375 break;
5376 case 'l':
5377 intent.mExtras.putLong(key, Long.parseLong(value));
5378 break;
5379 case 's':
5380 intent.mExtras.putShort(key, Short.parseShort(value));
5381 break;
5382 default:
5383 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5384 }
5385 } catch (NumberFormatException e) {
5386 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5387 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005388
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005389 char ch = uri.charAt(i);
5390 if (ch == ')') break;
5391 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5392 i++;
5393 }
5394 }
5395
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005396 if (isIntentFragment) {
5397 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5398 } else {
5399 intent.mData = Uri.parse(uri);
5400 }
Tom Taylord4a47292009-12-21 13:59:18 -08005401
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005402 if (intent.mAction == null) {
5403 // By default, if no action is specified, then use VIEW.
5404 intent.mAction = ACTION_VIEW;
5405 }
5406
5407 } else {
5408 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5409 }
5410
5411 return intent;
5412 }
5413
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005414 /** @hide */
5415 public interface CommandOptionHandler {
5416 boolean handleOption(String opt, ShellCommand cmd);
5417 }
5418
5419 /** @hide */
5420 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5421 throws URISyntaxException {
5422 Intent intent = new Intent();
5423 Intent baseIntent = intent;
5424 boolean hasIntentInfo = false;
5425
5426 Uri data = null;
5427 String type = null;
5428
5429 String opt;
5430 while ((opt=cmd.getNextOption()) != null) {
5431 switch (opt) {
5432 case "-a":
5433 intent.setAction(cmd.getNextArgRequired());
5434 if (intent == baseIntent) {
5435 hasIntentInfo = true;
5436 }
5437 break;
5438 case "-d":
5439 data = Uri.parse(cmd.getNextArgRequired());
5440 if (intent == baseIntent) {
5441 hasIntentInfo = true;
5442 }
5443 break;
5444 case "-t":
5445 type = cmd.getNextArgRequired();
5446 if (intent == baseIntent) {
5447 hasIntentInfo = true;
5448 }
5449 break;
5450 case "-c":
5451 intent.addCategory(cmd.getNextArgRequired());
5452 if (intent == baseIntent) {
5453 hasIntentInfo = true;
5454 }
5455 break;
5456 case "-e":
5457 case "--es": {
5458 String key = cmd.getNextArgRequired();
5459 String value = cmd.getNextArgRequired();
5460 intent.putExtra(key, value);
5461 }
5462 break;
5463 case "--esn": {
5464 String key = cmd.getNextArgRequired();
5465 intent.putExtra(key, (String) null);
5466 }
5467 break;
5468 case "--ei": {
5469 String key = cmd.getNextArgRequired();
5470 String value = cmd.getNextArgRequired();
5471 intent.putExtra(key, Integer.decode(value));
5472 }
5473 break;
5474 case "--eu": {
5475 String key = cmd.getNextArgRequired();
5476 String value = cmd.getNextArgRequired();
5477 intent.putExtra(key, Uri.parse(value));
5478 }
5479 break;
5480 case "--ecn": {
5481 String key = cmd.getNextArgRequired();
5482 String value = cmd.getNextArgRequired();
5483 ComponentName cn = ComponentName.unflattenFromString(value);
5484 if (cn == null)
5485 throw new IllegalArgumentException("Bad component name: " + value);
5486 intent.putExtra(key, cn);
5487 }
5488 break;
5489 case "--eia": {
5490 String key = cmd.getNextArgRequired();
5491 String value = cmd.getNextArgRequired();
5492 String[] strings = value.split(",");
5493 int[] list = new int[strings.length];
5494 for (int i = 0; i < strings.length; i++) {
5495 list[i] = Integer.decode(strings[i]);
5496 }
5497 intent.putExtra(key, list);
5498 }
5499 break;
5500 case "--eial": {
5501 String key = cmd.getNextArgRequired();
5502 String value = cmd.getNextArgRequired();
5503 String[] strings = value.split(",");
5504 ArrayList<Integer> list = new ArrayList<>(strings.length);
5505 for (int i = 0; i < strings.length; i++) {
5506 list.add(Integer.decode(strings[i]));
5507 }
5508 intent.putExtra(key, list);
5509 }
5510 break;
5511 case "--el": {
5512 String key = cmd.getNextArgRequired();
5513 String value = cmd.getNextArgRequired();
5514 intent.putExtra(key, Long.valueOf(value));
5515 }
5516 break;
5517 case "--ela": {
5518 String key = cmd.getNextArgRequired();
5519 String value = cmd.getNextArgRequired();
5520 String[] strings = value.split(",");
5521 long[] list = new long[strings.length];
5522 for (int i = 0; i < strings.length; i++) {
5523 list[i] = Long.valueOf(strings[i]);
5524 }
5525 intent.putExtra(key, list);
5526 hasIntentInfo = true;
5527 }
5528 break;
5529 case "--elal": {
5530 String key = cmd.getNextArgRequired();
5531 String value = cmd.getNextArgRequired();
5532 String[] strings = value.split(",");
5533 ArrayList<Long> list = new ArrayList<>(strings.length);
5534 for (int i = 0; i < strings.length; i++) {
5535 list.add(Long.valueOf(strings[i]));
5536 }
5537 intent.putExtra(key, list);
5538 hasIntentInfo = true;
5539 }
5540 break;
5541 case "--ef": {
5542 String key = cmd.getNextArgRequired();
5543 String value = cmd.getNextArgRequired();
5544 intent.putExtra(key, Float.valueOf(value));
5545 hasIntentInfo = true;
5546 }
5547 break;
5548 case "--efa": {
5549 String key = cmd.getNextArgRequired();
5550 String value = cmd.getNextArgRequired();
5551 String[] strings = value.split(",");
5552 float[] list = new float[strings.length];
5553 for (int i = 0; i < strings.length; i++) {
5554 list[i] = Float.valueOf(strings[i]);
5555 }
5556 intent.putExtra(key, list);
5557 hasIntentInfo = true;
5558 }
5559 break;
5560 case "--efal": {
5561 String key = cmd.getNextArgRequired();
5562 String value = cmd.getNextArgRequired();
5563 String[] strings = value.split(",");
5564 ArrayList<Float> list = new ArrayList<>(strings.length);
5565 for (int i = 0; i < strings.length; i++) {
5566 list.add(Float.valueOf(strings[i]));
5567 }
5568 intent.putExtra(key, list);
5569 hasIntentInfo = true;
5570 }
5571 break;
5572 case "--esa": {
5573 String key = cmd.getNextArgRequired();
5574 String value = cmd.getNextArgRequired();
5575 // Split on commas unless they are preceeded by an escape.
5576 // The escape character must be escaped for the string and
5577 // again for the regex, thus four escape characters become one.
5578 String[] strings = value.split("(?<!\\\\),");
5579 intent.putExtra(key, strings);
5580 hasIntentInfo = true;
5581 }
5582 break;
5583 case "--esal": {
5584 String key = cmd.getNextArgRequired();
5585 String value = cmd.getNextArgRequired();
5586 // Split on commas unless they are preceeded by an escape.
5587 // The escape character must be escaped for the string and
5588 // again for the regex, thus four escape characters become one.
5589 String[] strings = value.split("(?<!\\\\),");
5590 ArrayList<String> list = new ArrayList<>(strings.length);
5591 for (int i = 0; i < strings.length; i++) {
5592 list.add(strings[i]);
5593 }
5594 intent.putExtra(key, list);
5595 hasIntentInfo = true;
5596 }
5597 break;
5598 case "--ez": {
5599 String key = cmd.getNextArgRequired();
5600 String value = cmd.getNextArgRequired().toLowerCase();
5601 // Boolean.valueOf() results in false for anything that is not "true", which is
5602 // error-prone in shell commands
5603 boolean arg;
5604 if ("true".equals(value) || "t".equals(value)) {
5605 arg = true;
5606 } else if ("false".equals(value) || "f".equals(value)) {
5607 arg = false;
5608 } else {
5609 try {
5610 arg = Integer.decode(value) != 0;
5611 } catch (NumberFormatException ex) {
5612 throw new IllegalArgumentException("Invalid boolean value: " + value);
5613 }
5614 }
5615
5616 intent.putExtra(key, arg);
5617 }
5618 break;
5619 case "-n": {
5620 String str = cmd.getNextArgRequired();
5621 ComponentName cn = ComponentName.unflattenFromString(str);
5622 if (cn == null)
5623 throw new IllegalArgumentException("Bad component name: " + str);
5624 intent.setComponent(cn);
5625 if (intent == baseIntent) {
5626 hasIntentInfo = true;
5627 }
5628 }
5629 break;
5630 case "-p": {
5631 String str = cmd.getNextArgRequired();
5632 intent.setPackage(str);
5633 if (intent == baseIntent) {
5634 hasIntentInfo = true;
5635 }
5636 }
5637 break;
5638 case "-f":
5639 String str = cmd.getNextArgRequired();
5640 intent.setFlags(Integer.decode(str).intValue());
5641 break;
5642 case "--grant-read-uri-permission":
5643 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5644 break;
5645 case "--grant-write-uri-permission":
5646 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5647 break;
5648 case "--grant-persistable-uri-permission":
5649 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5650 break;
5651 case "--grant-prefix-uri-permission":
5652 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5653 break;
5654 case "--exclude-stopped-packages":
5655 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5656 break;
5657 case "--include-stopped-packages":
5658 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5659 break;
5660 case "--debug-log-resolution":
5661 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5662 break;
5663 case "--activity-brought-to-front":
5664 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5665 break;
5666 case "--activity-clear-top":
5667 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5668 break;
5669 case "--activity-clear-when-task-reset":
5670 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5671 break;
5672 case "--activity-exclude-from-recents":
5673 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5674 break;
5675 case "--activity-launched-from-history":
5676 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5677 break;
5678 case "--activity-multiple-task":
5679 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5680 break;
5681 case "--activity-no-animation":
5682 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5683 break;
5684 case "--activity-no-history":
5685 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5686 break;
5687 case "--activity-no-user-action":
5688 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5689 break;
5690 case "--activity-previous-is-top":
5691 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5692 break;
5693 case "--activity-reorder-to-front":
5694 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5695 break;
5696 case "--activity-reset-task-if-needed":
5697 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5698 break;
5699 case "--activity-single-top":
5700 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5701 break;
5702 case "--activity-clear-task":
5703 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5704 break;
5705 case "--activity-task-on-home":
5706 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5707 break;
5708 case "--receiver-registered-only":
5709 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5710 break;
5711 case "--receiver-replace-pending":
5712 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5713 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005714 case "--receiver-foreground":
5715 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5716 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005717 case "--selector":
5718 intent.setDataAndType(data, type);
5719 intent = new Intent();
5720 break;
5721 default:
5722 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5723 // Okay, caller handled this option.
5724 } else {
5725 throw new IllegalArgumentException("Unknown option: " + opt);
5726 }
5727 break;
5728 }
5729 }
5730 intent.setDataAndType(data, type);
5731
5732 final boolean hasSelector = intent != baseIntent;
5733 if (hasSelector) {
5734 // A selector was specified; fix up.
5735 baseIntent.setSelector(intent);
5736 intent = baseIntent;
5737 }
5738
5739 String arg = cmd.getNextArg();
5740 baseIntent = null;
5741 if (arg == null) {
5742 if (hasSelector) {
5743 // If a selector has been specified, and no arguments
5744 // have been supplied for the main Intent, then we can
5745 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5746 // need to have a component name specified yet, the
5747 // selector will take care of that.
5748 baseIntent = new Intent(Intent.ACTION_MAIN);
5749 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5750 }
5751 } else if (arg.indexOf(':') >= 0) {
5752 // The argument is a URI. Fully parse it, and use that result
5753 // to fill in any data not specified so far.
5754 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5755 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5756 } else if (arg.indexOf('/') >= 0) {
5757 // The argument is a component name. Build an Intent to launch
5758 // it.
5759 baseIntent = new Intent(Intent.ACTION_MAIN);
5760 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5761 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5762 } else {
5763 // Assume the argument is a package name.
5764 baseIntent = new Intent(Intent.ACTION_MAIN);
5765 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5766 baseIntent.setPackage(arg);
5767 }
5768 if (baseIntent != null) {
5769 Bundle extras = intent.getExtras();
5770 intent.replaceExtras((Bundle)null);
5771 Bundle uriExtras = baseIntent.getExtras();
5772 baseIntent.replaceExtras((Bundle)null);
5773 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5774 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5775 for (String c : cats) {
5776 baseIntent.removeCategory(c);
5777 }
5778 }
5779 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5780 if (extras == null) {
5781 extras = uriExtras;
5782 } else if (uriExtras != null) {
5783 uriExtras.putAll(extras);
5784 extras = uriExtras;
5785 }
5786 intent.replaceExtras(extras);
5787 hasIntentInfo = true;
5788 }
5789
5790 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5791 return intent;
5792 }
5793
5794 /** @hide */
5795 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5796 final String[] lines = new String[] {
5797 "<INTENT> specifications include these flags and arguments:",
5798 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5799 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5800 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5801 " [--esn <EXTRA_KEY> ...]",
5802 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5803 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5804 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5805 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5806 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5807 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5808 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5809 " (mutiple extras passed as Integer[])",
5810 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5811 " (mutiple extras passed as List<Integer>)",
5812 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5813 " (mutiple extras passed as Long[])",
5814 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5815 " (mutiple extras passed as List<Long>)",
5816 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5817 " (mutiple extras passed as Float[])",
5818 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5819 " (mutiple extras passed as List<Float>)",
5820 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5821 " (mutiple extras passed as String[]; to embed a comma into a string,",
5822 " escape it using \"\\,\")",
5823 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5824 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5825 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005826 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005827 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5828 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5829 " [--debug-log-resolution] [--exclude-stopped-packages]",
5830 " [--include-stopped-packages]",
5831 " [--activity-brought-to-front] [--activity-clear-top]",
5832 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5833 " [--activity-launched-from-history] [--activity-multiple-task]",
5834 " [--activity-no-animation] [--activity-no-history]",
5835 " [--activity-no-user-action] [--activity-previous-is-top]",
5836 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5837 " [--activity-single-top] [--activity-clear-task]",
5838 " [--activity-task-on-home]",
5839 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005840 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005841 " [--selector]",
5842 " [<URI> | <PACKAGE> | <COMPONENT>]"
5843 };
5844 for (String line : lines) {
5845 pw.print(prefix);
5846 pw.println(line);
5847 }
5848 }
5849
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005850 /**
5851 * Retrieve the general action to be performed, such as
5852 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5853 * the information in the intent should be interpreted -- most importantly,
5854 * what to do with the data returned by {@link #getData}.
5855 *
5856 * @return The action of this intent or null if none is specified.
5857 *
5858 * @see #setAction
5859 */
5860 public String getAction() {
5861 return mAction;
5862 }
5863
5864 /**
5865 * Retrieve data this intent is operating on. This URI specifies the name
5866 * of the data; often it uses the content: scheme, specifying data in a
5867 * content provider. Other schemes may be handled by specific activities,
5868 * such as http: by the web browser.
5869 *
5870 * @return The URI of the data this intent is targeting or null.
5871 *
5872 * @see #getScheme
5873 * @see #setData
5874 */
5875 public Uri getData() {
5876 return mData;
5877 }
5878
5879 /**
5880 * The same as {@link #getData()}, but returns the URI as an encoded
5881 * String.
5882 */
5883 public String getDataString() {
5884 return mData != null ? mData.toString() : null;
5885 }
5886
5887 /**
5888 * Return the scheme portion of the intent's data. If the data is null or
5889 * does not include a scheme, null is returned. Otherwise, the scheme
5890 * prefix without the final ':' is returned, i.e. "http".
5891 *
5892 * <p>This is the same as calling getData().getScheme() (and checking for
5893 * null data).
5894 *
5895 * @return The scheme of this intent.
5896 *
5897 * @see #getData
5898 */
5899 public String getScheme() {
5900 return mData != null ? mData.getScheme() : null;
5901 }
5902
5903 /**
5904 * Retrieve any explicit MIME type included in the intent. This is usually
5905 * null, as the type is determined by the intent data.
5906 *
5907 * @return If a type was manually set, it is returned; else null is
5908 * returned.
5909 *
5910 * @see #resolveType(ContentResolver)
5911 * @see #setType
5912 */
5913 public String getType() {
5914 return mType;
5915 }
5916
5917 /**
5918 * Return the MIME data type of this intent. If the type field is
5919 * explicitly set, that is simply returned. Otherwise, if the data is set,
5920 * the type of that data is returned. If neither fields are set, a null is
5921 * returned.
5922 *
5923 * @return The MIME type of this intent.
5924 *
5925 * @see #getType
5926 * @see #resolveType(ContentResolver)
5927 */
5928 public String resolveType(Context context) {
5929 return resolveType(context.getContentResolver());
5930 }
5931
5932 /**
5933 * Return the MIME data type of this intent. If the type field is
5934 * explicitly set, that is simply returned. Otherwise, if the data is set,
5935 * the type of that data is returned. If neither fields are set, a null is
5936 * returned.
5937 *
5938 * @param resolver A ContentResolver that can be used to determine the MIME
5939 * type of the intent's data.
5940 *
5941 * @return The MIME type of this intent.
5942 *
5943 * @see #getType
5944 * @see #resolveType(Context)
5945 */
5946 public String resolveType(ContentResolver resolver) {
5947 if (mType != null) {
5948 return mType;
5949 }
5950 if (mData != null) {
5951 if ("content".equals(mData.getScheme())) {
5952 return resolver.getType(mData);
5953 }
5954 }
5955 return null;
5956 }
5957
5958 /**
5959 * Return the MIME data type of this intent, only if it will be needed for
5960 * intent resolution. This is not generally useful for application code;
5961 * it is used by the frameworks for communicating with back-end system
5962 * services.
5963 *
5964 * @param resolver A ContentResolver that can be used to determine the MIME
5965 * type of the intent's data.
5966 *
5967 * @return The MIME type of this intent, or null if it is unknown or not
5968 * needed.
5969 */
5970 public String resolveTypeIfNeeded(ContentResolver resolver) {
5971 if (mComponent != null) {
5972 return mType;
5973 }
5974 return resolveType(resolver);
5975 }
5976
5977 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005978 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005979 *
5980 * @param category The category to check.
5981 *
5982 * @return boolean True if the intent contains the category, else false.
5983 *
5984 * @see #getCategories
5985 * @see #addCategory
5986 */
5987 public boolean hasCategory(String category) {
5988 return mCategories != null && mCategories.contains(category);
5989 }
5990
5991 /**
5992 * Return the set of all categories in the intent. If there are no categories,
5993 * returns NULL.
5994 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005995 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005996 *
5997 * @see #hasCategory
5998 * @see #addCategory
5999 */
6000 public Set<String> getCategories() {
6001 return mCategories;
6002 }
6003
6004 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006005 * Return the specific selector associated with this Intent. If there is
6006 * none, returns null. See {@link #setSelector} for more information.
6007 *
6008 * @see #setSelector
6009 */
6010 public Intent getSelector() {
6011 return mSelector;
6012 }
6013
6014 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006015 * Return the {@link ClipData} associated with this Intent. If there is
6016 * none, returns null. See {@link #setClipData} for more information.
6017 *
John Spurlock125d1332013-11-25 11:58:37 -05006018 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006019 */
6020 public ClipData getClipData() {
6021 return mClipData;
6022 }
6023
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006024 /** @hide */
6025 public int getContentUserHint() {
6026 return mContentUserHint;
6027 }
6028
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006029 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006030 * Sets the ClassLoader that will be used when unmarshalling
6031 * any Parcelable values from the extras of this Intent.
6032 *
6033 * @param loader a ClassLoader, or null to use the default loader
6034 * at the time of unmarshalling.
6035 */
6036 public void setExtrasClassLoader(ClassLoader loader) {
6037 if (mExtras != null) {
6038 mExtras.setClassLoader(loader);
6039 }
6040 }
6041
6042 /**
6043 * Returns true if an extra value is associated with the given name.
6044 * @param name the extra's name
6045 * @return true if the given extra is present.
6046 */
6047 public boolean hasExtra(String name) {
6048 return mExtras != null && mExtras.containsKey(name);
6049 }
6050
6051 /**
6052 * Returns true if the Intent's extras contain a parcelled file descriptor.
6053 * @return true if the Intent contains a parcelled file descriptor.
6054 */
6055 public boolean hasFileDescriptors() {
6056 return mExtras != null && mExtras.hasFileDescriptors();
6057 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006058
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006059 /** {@hide} */
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006060 public void setAllowFds(boolean allowFds) {
6061 if (mExtras != null) {
6062 mExtras.setAllowFds(allowFds);
6063 }
6064 }
6065
Jeff Sharkeyd136e512016-03-09 22:30:56 -07006066 /** {@hide} */
6067 public void setDefusable(boolean defusable) {
6068 if (mExtras != null) {
6069 mExtras.setDefusable(defusable);
6070 }
6071 }
6072
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006073 /**
6074 * Retrieve extended data from the intent.
6075 *
6076 * @param name The name of the desired item.
6077 *
6078 * @return the value of an item that previously added with putExtra()
6079 * or null if none was found.
6080 *
6081 * @deprecated
6082 * @hide
6083 */
6084 @Deprecated
6085 public Object getExtra(String name) {
6086 return getExtra(name, null);
6087 }
6088
6089 /**
6090 * Retrieve extended data from the intent.
6091 *
6092 * @param name The name of the desired item.
6093 * @param defaultValue the value to be returned if no value of the desired
6094 * type is stored with the given name.
6095 *
6096 * @return the value of an item that previously added with putExtra()
6097 * or the default value if none was found.
6098 *
6099 * @see #putExtra(String, boolean)
6100 */
6101 public boolean getBooleanExtra(String name, boolean defaultValue) {
6102 return mExtras == null ? defaultValue :
6103 mExtras.getBoolean(name, defaultValue);
6104 }
6105
6106 /**
6107 * Retrieve extended data from the intent.
6108 *
6109 * @param name The name of the desired item.
6110 * @param defaultValue the value to be returned if no value of the desired
6111 * type is stored with the given name.
6112 *
6113 * @return the value of an item that previously added with putExtra()
6114 * or the default value if none was found.
6115 *
6116 * @see #putExtra(String, byte)
6117 */
6118 public byte getByteExtra(String name, byte defaultValue) {
6119 return mExtras == null ? defaultValue :
6120 mExtras.getByte(name, defaultValue);
6121 }
6122
6123 /**
6124 * Retrieve extended data from the intent.
6125 *
6126 * @param name The name of the desired item.
6127 * @param defaultValue the value to be returned if no value of the desired
6128 * type is stored with the given name.
6129 *
6130 * @return the value of an item that previously added with putExtra()
6131 * or the default value if none was found.
6132 *
6133 * @see #putExtra(String, short)
6134 */
6135 public short getShortExtra(String name, short defaultValue) {
6136 return mExtras == null ? defaultValue :
6137 mExtras.getShort(name, defaultValue);
6138 }
6139
6140 /**
6141 * Retrieve extended data from the intent.
6142 *
6143 * @param name The name of the desired item.
6144 * @param defaultValue the value to be returned if no value of the desired
6145 * type is stored with the given name.
6146 *
6147 * @return the value of an item that previously added with putExtra()
6148 * or the default value if none was found.
6149 *
6150 * @see #putExtra(String, char)
6151 */
6152 public char getCharExtra(String name, char defaultValue) {
6153 return mExtras == null ? defaultValue :
6154 mExtras.getChar(name, defaultValue);
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, int)
6168 */
6169 public int getIntExtra(String name, int defaultValue) {
6170 return mExtras == null ? defaultValue :
6171 mExtras.getInt(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, long)
6185 */
6186 public long getLongExtra(String name, long defaultValue) {
6187 return mExtras == null ? defaultValue :
6188 mExtras.getLong(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 no such item is present
6200 *
6201 * @see #putExtra(String, float)
6202 */
6203 public float getFloatExtra(String name, float defaultValue) {
6204 return mExtras == null ? defaultValue :
6205 mExtras.getFloat(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, double)
6219 */
6220 public double getDoubleExtra(String name, double defaultValue) {
6221 return mExtras == null ? defaultValue :
6222 mExtras.getDouble(name, defaultValue);
6223 }
6224
6225 /**
6226 * Retrieve extended data from the intent.
6227 *
6228 * @param name The name of the desired item.
6229 *
6230 * @return the value of an item that previously added with putExtra()
6231 * or null if no String value was found.
6232 *
6233 * @see #putExtra(String, String)
6234 */
6235 public String getStringExtra(String name) {
6236 return mExtras == null ? null : mExtras.getString(name);
6237 }
6238
6239 /**
6240 * Retrieve extended data from the intent.
6241 *
6242 * @param name The name of the desired item.
6243 *
6244 * @return the value of an item that previously added with putExtra()
6245 * or null if no CharSequence value was found.
6246 *
6247 * @see #putExtra(String, CharSequence)
6248 */
6249 public CharSequence getCharSequenceExtra(String name) {
6250 return mExtras == null ? null : mExtras.getCharSequence(name);
6251 }
6252
6253 /**
6254 * Retrieve extended data from the intent.
6255 *
6256 * @param name The name of the desired item.
6257 *
6258 * @return the value of an item that previously added with putExtra()
6259 * or null if no Parcelable value was found.
6260 *
6261 * @see #putExtra(String, Parcelable)
6262 */
6263 public <T extends Parcelable> T getParcelableExtra(String name) {
6264 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6265 }
6266
6267 /**
6268 * Retrieve extended data from the intent.
6269 *
6270 * @param name The name of the desired item.
6271 *
6272 * @return the value of an item that previously added with putExtra()
6273 * or null if no Parcelable[] value was found.
6274 *
6275 * @see #putExtra(String, Parcelable[])
6276 */
6277 public Parcelable[] getParcelableArrayExtra(String name) {
6278 return mExtras == null ? null : mExtras.getParcelableArray(name);
6279 }
6280
6281 /**
6282 * Retrieve extended data from the intent.
6283 *
6284 * @param name The name of the desired item.
6285 *
6286 * @return the value of an item that previously added with putExtra()
6287 * or null if no ArrayList<Parcelable> value was found.
6288 *
6289 * @see #putParcelableArrayListExtra(String, ArrayList)
6290 */
6291 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6292 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6293 }
6294
6295 /**
6296 * Retrieve extended data from the intent.
6297 *
6298 * @param name The name of the desired item.
6299 *
6300 * @return the value of an item that previously added with putExtra()
6301 * or null if no Serializable value was found.
6302 *
6303 * @see #putExtra(String, Serializable)
6304 */
6305 public Serializable getSerializableExtra(String name) {
6306 return mExtras == null ? null : mExtras.getSerializable(name);
6307 }
6308
6309 /**
6310 * Retrieve extended data from the intent.
6311 *
6312 * @param name The name of the desired item.
6313 *
6314 * @return the value of an item that previously added with putExtra()
6315 * or null if no ArrayList<Integer> value was found.
6316 *
6317 * @see #putIntegerArrayListExtra(String, ArrayList)
6318 */
6319 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6320 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6321 }
6322
6323 /**
6324 * Retrieve extended data from the intent.
6325 *
6326 * @param name The name of the desired item.
6327 *
6328 * @return the value of an item that previously added with putExtra()
6329 * or null if no ArrayList<String> value was found.
6330 *
6331 * @see #putStringArrayListExtra(String, ArrayList)
6332 */
6333 public ArrayList<String> getStringArrayListExtra(String name) {
6334 return mExtras == null ? null : mExtras.getStringArrayList(name);
6335 }
6336
6337 /**
6338 * Retrieve extended data from the intent.
6339 *
6340 * @param name The name of the desired item.
6341 *
6342 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006343 * or null if no ArrayList<CharSequence> value was found.
6344 *
6345 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6346 */
6347 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6348 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6349 }
6350
6351 /**
6352 * Retrieve extended data from the intent.
6353 *
6354 * @param name The name of the desired item.
6355 *
6356 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006357 * or null if no boolean array value was found.
6358 *
6359 * @see #putExtra(String, boolean[])
6360 */
6361 public boolean[] getBooleanArrayExtra(String name) {
6362 return mExtras == null ? null : mExtras.getBooleanArray(name);
6363 }
6364
6365 /**
6366 * Retrieve extended data from the intent.
6367 *
6368 * @param name The name of the desired item.
6369 *
6370 * @return the value of an item that previously added with putExtra()
6371 * or null if no byte array value was found.
6372 *
6373 * @see #putExtra(String, byte[])
6374 */
6375 public byte[] getByteArrayExtra(String name) {
6376 return mExtras == null ? null : mExtras.getByteArray(name);
6377 }
6378
6379 /**
6380 * Retrieve extended data from the intent.
6381 *
6382 * @param name The name of the desired item.
6383 *
6384 * @return the value of an item that previously added with putExtra()
6385 * or null if no short array value was found.
6386 *
6387 * @see #putExtra(String, short[])
6388 */
6389 public short[] getShortArrayExtra(String name) {
6390 return mExtras == null ? null : mExtras.getShortArray(name);
6391 }
6392
6393 /**
6394 * Retrieve extended data from the intent.
6395 *
6396 * @param name The name of the desired item.
6397 *
6398 * @return the value of an item that previously added with putExtra()
6399 * or null if no char array value was found.
6400 *
6401 * @see #putExtra(String, char[])
6402 */
6403 public char[] getCharArrayExtra(String name) {
6404 return mExtras == null ? null : mExtras.getCharArray(name);
6405 }
6406
6407 /**
6408 * Retrieve extended data from the intent.
6409 *
6410 * @param name The name of the desired item.
6411 *
6412 * @return the value of an item that previously added with putExtra()
6413 * or null if no int array value was found.
6414 *
6415 * @see #putExtra(String, int[])
6416 */
6417 public int[] getIntArrayExtra(String name) {
6418 return mExtras == null ? null : mExtras.getIntArray(name);
6419 }
6420
6421 /**
6422 * Retrieve extended data from the intent.
6423 *
6424 * @param name The name of the desired item.
6425 *
6426 * @return the value of an item that previously added with putExtra()
6427 * or null if no long array value was found.
6428 *
6429 * @see #putExtra(String, long[])
6430 */
6431 public long[] getLongArrayExtra(String name) {
6432 return mExtras == null ? null : mExtras.getLongArray(name);
6433 }
6434
6435 /**
6436 * Retrieve extended data from the intent.
6437 *
6438 * @param name The name of the desired item.
6439 *
6440 * @return the value of an item that previously added with putExtra()
6441 * or null if no float array value was found.
6442 *
6443 * @see #putExtra(String, float[])
6444 */
6445 public float[] getFloatArrayExtra(String name) {
6446 return mExtras == null ? null : mExtras.getFloatArray(name);
6447 }
6448
6449 /**
6450 * Retrieve extended data from the intent.
6451 *
6452 * @param name The name of the desired item.
6453 *
6454 * @return the value of an item that previously added with putExtra()
6455 * or null if no double array value was found.
6456 *
6457 * @see #putExtra(String, double[])
6458 */
6459 public double[] getDoubleArrayExtra(String name) {
6460 return mExtras == null ? null : mExtras.getDoubleArray(name);
6461 }
6462
6463 /**
6464 * Retrieve extended data from the intent.
6465 *
6466 * @param name The name of the desired item.
6467 *
6468 * @return the value of an item that previously added with putExtra()
6469 * or null if no String array value was found.
6470 *
6471 * @see #putExtra(String, String[])
6472 */
6473 public String[] getStringArrayExtra(String name) {
6474 return mExtras == null ? null : mExtras.getStringArray(name);
6475 }
6476
6477 /**
6478 * Retrieve extended data from the intent.
6479 *
6480 * @param name The name of the desired item.
6481 *
6482 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006483 * or null if no CharSequence array value was found.
6484 *
6485 * @see #putExtra(String, CharSequence[])
6486 */
6487 public CharSequence[] getCharSequenceArrayExtra(String name) {
6488 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6489 }
6490
6491 /**
6492 * Retrieve extended data from the intent.
6493 *
6494 * @param name The name of the desired item.
6495 *
6496 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006497 * or null if no Bundle value was found.
6498 *
6499 * @see #putExtra(String, Bundle)
6500 */
6501 public Bundle getBundleExtra(String name) {
6502 return mExtras == null ? null : mExtras.getBundle(name);
6503 }
6504
6505 /**
6506 * Retrieve extended data from the intent.
6507 *
6508 * @param name The name of the desired item.
6509 *
6510 * @return the value of an item that previously added with putExtra()
6511 * or null if no IBinder value was found.
6512 *
6513 * @see #putExtra(String, IBinder)
6514 *
6515 * @deprecated
6516 * @hide
6517 */
6518 @Deprecated
6519 public IBinder getIBinderExtra(String name) {
6520 return mExtras == null ? null : mExtras.getIBinder(name);
6521 }
6522
6523 /**
6524 * Retrieve extended data from the intent.
6525 *
6526 * @param name The name of the desired item.
6527 * @param defaultValue The default value to return in case no item is
6528 * associated with the key 'name'
6529 *
6530 * @return the value of an item that previously added with putExtra()
6531 * or defaultValue if none was found.
6532 *
6533 * @see #putExtra
6534 *
6535 * @deprecated
6536 * @hide
6537 */
6538 @Deprecated
6539 public Object getExtra(String name, Object defaultValue) {
6540 Object result = defaultValue;
6541 if (mExtras != null) {
6542 Object result2 = mExtras.get(name);
6543 if (result2 != null) {
6544 result = result2;
6545 }
6546 }
6547
6548 return result;
6549 }
6550
6551 /**
6552 * Retrieves a map of extended data from the intent.
6553 *
6554 * @return the map of all extras previously added with putExtra(),
6555 * or null if none have been added.
6556 */
6557 public Bundle getExtras() {
6558 return (mExtras != null)
6559 ? new Bundle(mExtras)
6560 : null;
6561 }
6562
6563 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006564 * Filter extras to only basic types.
6565 * @hide
6566 */
6567 public void removeUnsafeExtras() {
6568 if (mExtras != null) {
6569 mExtras.filterValues();
6570 }
6571 }
6572
6573 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006574 * Retrieve any special flags associated with this intent. You will
6575 * normally just set them with {@link #setFlags} and let the system
6576 * take the appropriate action with them.
6577 *
6578 * @return int The currently set flags.
6579 *
6580 * @see #setFlags
6581 */
6582 public int getFlags() {
6583 return mFlags;
6584 }
6585
Dianne Hackborne7f97212011-02-24 14:40:20 -08006586 /** @hide */
6587 public boolean isExcludingStopped() {
6588 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6589 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6590 }
6591
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006592 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006593 * Retrieve the application package name this Intent is limited to. When
6594 * resolving an Intent, if non-null this limits the resolution to only
6595 * components in the given application package.
6596 *
6597 * @return The name of the application package for the Intent.
6598 *
6599 * @see #resolveActivity
6600 * @see #setPackage
6601 */
6602 public String getPackage() {
6603 return mPackage;
6604 }
6605
6606 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006607 * Retrieve the concrete component associated with the intent. When receiving
6608 * an intent, this is the component that was found to best handle it (that is,
6609 * yourself) and will always be non-null; in all other cases it will be
6610 * null unless explicitly set.
6611 *
6612 * @return The name of the application component to handle the intent.
6613 *
6614 * @see #resolveActivity
6615 * @see #setComponent
6616 */
6617 public ComponentName getComponent() {
6618 return mComponent;
6619 }
6620
6621 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006622 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6623 * used as a hint to the receiver for animations and the like. Null means that there
6624 * is no source bounds.
6625 */
6626 public Rect getSourceBounds() {
6627 return mSourceBounds;
6628 }
6629
6630 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006631 * Return the Activity component that should be used to handle this intent.
6632 * The appropriate component is determined based on the information in the
6633 * intent, evaluated as follows:
6634 *
6635 * <p>If {@link #getComponent} returns an explicit class, that is returned
6636 * without any further consideration.
6637 *
6638 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6639 * category to be considered.
6640 *
6641 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6642 * action.
6643 *
6644 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6645 * this type.
6646 *
6647 * <p>If {@link #addCategory} has added any categories, the activity must
6648 * handle ALL of the categories specified.
6649 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006650 * <p>If {@link #getPackage} is non-NULL, only activity components in
6651 * that application package will be considered.
6652 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006653 * <p>If there are no activities that satisfy all of these conditions, a
6654 * null string is returned.
6655 *
6656 * <p>If multiple activities are found to satisfy the intent, the one with
6657 * the highest priority will be used. If there are multiple activities
6658 * with the same priority, the system will either pick the best activity
6659 * based on user preference, or resolve to a system class that will allow
6660 * the user to pick an activity and forward from there.
6661 *
6662 * <p>This method is implemented simply by calling
6663 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6664 * true.</p>
6665 * <p> This API is called for you as part of starting an activity from an
6666 * intent. You do not normally need to call it yourself.</p>
6667 *
6668 * @param pm The package manager with which to resolve the Intent.
6669 *
6670 * @return Name of the component implementing an activity that can
6671 * display the intent.
6672 *
6673 * @see #setComponent
6674 * @see #getComponent
6675 * @see #resolveActivityInfo
6676 */
6677 public ComponentName resolveActivity(PackageManager pm) {
6678 if (mComponent != null) {
6679 return mComponent;
6680 }
6681
6682 ResolveInfo info = pm.resolveActivity(
6683 this, PackageManager.MATCH_DEFAULT_ONLY);
6684 if (info != null) {
6685 return new ComponentName(
6686 info.activityInfo.applicationInfo.packageName,
6687 info.activityInfo.name);
6688 }
6689
6690 return null;
6691 }
6692
6693 /**
6694 * Resolve the Intent into an {@link ActivityInfo}
6695 * describing the activity that should execute the intent. Resolution
6696 * follows the same rules as described for {@link #resolveActivity}, but
6697 * you get back the completely information about the resolved activity
6698 * instead of just its class name.
6699 *
6700 * @param pm The package manager with which to resolve the Intent.
6701 * @param flags Addition information to retrieve as per
6702 * {@link PackageManager#getActivityInfo(ComponentName, int)
6703 * PackageManager.getActivityInfo()}.
6704 *
6705 * @return PackageManager.ActivityInfo
6706 *
6707 * @see #resolveActivity
6708 */
6709 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6710 ActivityInfo ai = null;
6711 if (mComponent != null) {
6712 try {
6713 ai = pm.getActivityInfo(mComponent, flags);
6714 } catch (PackageManager.NameNotFoundException e) {
6715 // ignore
6716 }
6717 } else {
6718 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006719 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006720 if (info != null) {
6721 ai = info.activityInfo;
6722 }
6723 }
6724
6725 return ai;
6726 }
6727
6728 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006729 * Special function for use by the system to resolve service
6730 * intents to system apps. Throws an exception if there are
6731 * multiple potential matches to the Intent. Returns null if
6732 * there are no matches.
6733 * @hide
6734 */
6735 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6736 if (mComponent != null) {
6737 return mComponent;
6738 }
6739
6740 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6741 if (results == null) {
6742 return null;
6743 }
6744 ComponentName comp = null;
6745 for (int i=0; i<results.size(); i++) {
6746 ResolveInfo ri = results.get(i);
6747 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6748 continue;
6749 }
6750 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6751 ri.serviceInfo.name);
6752 if (comp != null) {
6753 throw new IllegalStateException("Multiple system services handle " + this
6754 + ": " + comp + ", " + foundComp);
6755 }
6756 comp = foundComp;
6757 }
6758 return comp;
6759 }
6760
6761 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 * Set the general action to be performed.
6763 *
6764 * @param action An action name, such as ACTION_VIEW. Application-specific
6765 * actions should be prefixed with the vendor's package name.
6766 *
6767 * @return Returns the same Intent object, for chaining multiple calls
6768 * into a single statement.
6769 *
6770 * @see #getAction
6771 */
6772 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006773 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006774 return this;
6775 }
6776
6777 /**
6778 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006779 * clears any type that was previously set by {@link #setType} or
6780 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006781 *
Nick Pellyccae4122012-01-09 14:12:58 -08006782 * <p><em>Note: scheme matching in the Android framework is
6783 * case-sensitive, unlike the formal RFC. As a result,
6784 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006785 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006786 * {@link #setDataAndNormalize}
6787 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006788 *
Nick Pellyccae4122012-01-09 14:12:58 -08006789 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006790 *
6791 * @return Returns the same Intent object, for chaining multiple calls
6792 * into a single statement.
6793 *
6794 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006795 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006796 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006797 */
6798 public Intent setData(Uri data) {
6799 mData = data;
6800 mType = null;
6801 return this;
6802 }
6803
6804 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006805 * Normalize and set the data this intent is operating on.
6806 *
6807 * <p>This method automatically clears any type that was
6808 * previously set (for example, by {@link #setType}).
6809 *
6810 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006811 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006812 * so really this is just a convenience method for
6813 * <pre>
6814 * setData(data.normalize())
6815 * </pre>
6816 *
6817 * @param data The Uri of the data this intent is now targeting.
6818 *
6819 * @return Returns the same Intent object, for chaining multiple calls
6820 * into a single statement.
6821 *
6822 * @see #getData
6823 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006824 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006825 */
6826 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006827 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006828 }
6829
6830 /**
6831 * Set an explicit MIME data type.
6832 *
6833 * <p>This is used to create intents that only specify a type and not data,
6834 * for example to indicate the type of data to return.
6835 *
6836 * <p>This method automatically clears any data that was
6837 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006838 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006839 * <p><em>Note: MIME type matching in the Android framework is
6840 * case-sensitive, unlike formal RFC MIME types. As a result,
6841 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006842 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6843 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006844 *
6845 * @param type The MIME type of the data being handled by this intent.
6846 *
6847 * @return Returns the same Intent object, for chaining multiple calls
6848 * into a single statement.
6849 *
6850 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006851 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006852 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006853 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006854 */
6855 public Intent setType(String type) {
6856 mData = null;
6857 mType = type;
6858 return this;
6859 }
6860
6861 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006862 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006863 *
Nick Pellyccae4122012-01-09 14:12:58 -08006864 * <p>This is used to create intents that only specify a type and not data,
6865 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006866 *
Nick Pellyccae4122012-01-09 14:12:58 -08006867 * <p>This method automatically clears any data that was
6868 * previously set (for example by {@link #setData}).
6869 *
6870 * <p>The MIME type is normalized using
6871 * {@link #normalizeMimeType} before it is set,
6872 * so really this is just a convenience method for
6873 * <pre>
6874 * setType(Intent.normalizeMimeType(type))
6875 * </pre>
6876 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006877 * @param type The MIME type of the data being handled by this intent.
6878 *
6879 * @return Returns the same Intent object, for chaining multiple calls
6880 * into a single statement.
6881 *
Nick Pellyccae4122012-01-09 14:12:58 -08006882 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006883 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006884 * @see #normalizeMimeType
6885 */
6886 public Intent setTypeAndNormalize(String type) {
6887 return setType(normalizeMimeType(type));
6888 }
6889
6890 /**
6891 * (Usually optional) Set the data for the intent along with an explicit
6892 * MIME data type. This method should very rarely be used -- it allows you
6893 * to override the MIME type that would ordinarily be inferred from the
6894 * data with your own type given here.
6895 *
6896 * <p><em>Note: MIME type and Uri scheme matching in the
6897 * Android framework is case-sensitive, unlike the formal RFC definitions.
6898 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006899 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006900 * {@link #setDataAndTypeAndNormalize}
6901 * to ensure that they are converted to lower case.</em>
6902 *
6903 * @param data The Uri of the data this intent is now targeting.
6904 * @param type The MIME type of the data being handled by this intent.
6905 *
6906 * @return Returns the same Intent object, for chaining multiple calls
6907 * into a single statement.
6908 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006909 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006910 * @see #setData
6911 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006912 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006913 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006914 */
6915 public Intent setDataAndType(Uri data, String type) {
6916 mData = data;
6917 mType = type;
6918 return this;
6919 }
6920
6921 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006922 * (Usually optional) Normalize and set both the data Uri and an explicit
6923 * MIME data type. This method should very rarely be used -- it allows you
6924 * to override the MIME type that would ordinarily be inferred from the
6925 * data with your own type given here.
6926 *
6927 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006928 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006929 * before they are set, so really this is just a convenience method for
6930 * <pre>
6931 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6932 * </pre>
6933 *
6934 * @param data The Uri of the data this intent is now targeting.
6935 * @param type The MIME type of the data being handled by this intent.
6936 *
6937 * @return Returns the same Intent object, for chaining multiple calls
6938 * into a single statement.
6939 *
6940 * @see #setType
6941 * @see #setData
6942 * @see #setDataAndType
6943 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006944 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006945 */
6946 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006947 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006948 }
6949
6950 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006951 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006952 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006953 * activities that provide <em>all</em> of the requested categories will be
6954 * used.
6955 *
6956 * @param category The desired category. This can be either one of the
6957 * predefined Intent categories, or a custom category in your own
6958 * namespace.
6959 *
6960 * @return Returns the same Intent object, for chaining multiple calls
6961 * into a single statement.
6962 *
6963 * @see #hasCategory
6964 * @see #removeCategory
6965 */
6966 public Intent addCategory(String category) {
6967 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006968 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006969 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006970 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006971 return this;
6972 }
6973
6974 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006975 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006976 *
6977 * @param category The category to remove.
6978 *
6979 * @see #addCategory
6980 */
6981 public void removeCategory(String category) {
6982 if (mCategories != null) {
6983 mCategories.remove(category);
6984 if (mCategories.size() == 0) {
6985 mCategories = null;
6986 }
6987 }
6988 }
6989
6990 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006991 * Set a selector for this Intent. This is a modification to the kinds of
6992 * things the Intent will match. If the selector is set, it will be used
6993 * when trying to find entities that can handle the Intent, instead of the
6994 * main contents of the Intent. This allows you build an Intent containing
6995 * a generic protocol while targeting it more specifically.
6996 *
6997 * <p>An example of where this may be used is with things like
6998 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6999 * Intent that will launch the Browser application. However, the correct
7000 * main entry point of an application is actually {@link #ACTION_MAIN}
7001 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7002 * used to specify the actual Activity to launch. If you launch the browser
7003 * with something different, undesired behavior may happen if the user has
7004 * previously or later launches it the normal way, since they do not match.
7005 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7006 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7007 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7008 *
7009 * <p>Setting a selector does not impact the behavior of
7010 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7011 * desired behavior of a selector -- it does not impact the base meaning
7012 * of the Intent, just what kinds of things will be matched against it
7013 * when determining who can handle it.</p>
7014 *
7015 * <p>You can not use both a selector and {@link #setPackage(String)} on
7016 * the same base Intent.</p>
7017 *
7018 * @param selector The desired selector Intent; set to null to not use
7019 * a special selector.
7020 */
7021 public void setSelector(Intent selector) {
7022 if (selector == this) {
7023 throw new IllegalArgumentException(
7024 "Intent being set as a selector of itself");
7025 }
7026 if (selector != null && mPackage != null) {
7027 throw new IllegalArgumentException(
7028 "Can't set selector when package name is already set");
7029 }
7030 mSelector = selector;
7031 }
7032
7033 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007034 * Set a {@link ClipData} associated with this Intent. This replaces any
7035 * previously set ClipData.
7036 *
7037 * <p>The ClipData in an intent is not used for Intent matching or other
7038 * such operations. Semantically it is like extras, used to transmit
7039 * additional data with the Intent. The main feature of using this over
7040 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7041 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7042 * items included in the clip data. This is useful, in particular, if
7043 * you want to transmit an Intent containing multiple <code>content:</code>
7044 * URIs for which the recipient may not have global permission to access the
7045 * content provider.
7046 *
7047 * <p>If the ClipData contains items that are themselves Intents, any
7048 * grant flags in those Intents will be ignored. Only the top-level flags
7049 * of the main Intent are respected, and will be applied to all Uri or
7050 * Intent items in the clip (or sub-items of the clip).
7051 *
7052 * <p>The MIME type, label, and icon in the ClipData object are not
7053 * directly used by Intent. Applications should generally rely on the
7054 * MIME type of the Intent itself, not what it may find in the ClipData.
7055 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007056 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007057 *
7058 * @param clip The new clip to set. May be null to clear the current clip.
7059 */
7060 public void setClipData(ClipData clip) {
7061 mClipData = clip;
7062 }
7063
7064 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007065 * This is NOT a secure mechanism to identify the user who sent the intent.
7066 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7067 * who sent the intent.
7068 * @hide
7069 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007070 public void prepareToLeaveUser(int userId) {
7071 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7072 // We want mContentUserHint to refer to the original user, so don't do anything.
7073 if (mContentUserHint == UserHandle.USER_CURRENT) {
7074 mContentUserHint = userId;
7075 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007076 }
7077
7078 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007079 * Add extended data to the intent. The name must include a package
7080 * prefix, for example the app com.android.contacts would use names
7081 * like "com.android.contacts.ShowAll".
7082 *
7083 * @param name The name of the extra data, with package prefix.
7084 * @param value The boolean data value.
7085 *
7086 * @return Returns the same Intent object, for chaining multiple calls
7087 * into a single statement.
7088 *
7089 * @see #putExtras
7090 * @see #removeExtra
7091 * @see #getBooleanExtra(String, boolean)
7092 */
7093 public Intent putExtra(String name, boolean value) {
7094 if (mExtras == null) {
7095 mExtras = new Bundle();
7096 }
7097 mExtras.putBoolean(name, value);
7098 return this;
7099 }
7100
7101 /**
7102 * Add extended data to the intent. The name must include a package
7103 * prefix, for example the app com.android.contacts would use names
7104 * like "com.android.contacts.ShowAll".
7105 *
7106 * @param name The name of the extra data, with package prefix.
7107 * @param value The byte data value.
7108 *
7109 * @return Returns the same Intent object, for chaining multiple calls
7110 * into a single statement.
7111 *
7112 * @see #putExtras
7113 * @see #removeExtra
7114 * @see #getByteExtra(String, byte)
7115 */
7116 public Intent putExtra(String name, byte value) {
7117 if (mExtras == null) {
7118 mExtras = new Bundle();
7119 }
7120 mExtras.putByte(name, value);
7121 return this;
7122 }
7123
7124 /**
7125 * Add extended data to the intent. The name must include a package
7126 * prefix, for example the app com.android.contacts would use names
7127 * like "com.android.contacts.ShowAll".
7128 *
7129 * @param name The name of the extra data, with package prefix.
7130 * @param value The char data value.
7131 *
7132 * @return Returns the same Intent object, for chaining multiple calls
7133 * into a single statement.
7134 *
7135 * @see #putExtras
7136 * @see #removeExtra
7137 * @see #getCharExtra(String, char)
7138 */
7139 public Intent putExtra(String name, char value) {
7140 if (mExtras == null) {
7141 mExtras = new Bundle();
7142 }
7143 mExtras.putChar(name, value);
7144 return this;
7145 }
7146
7147 /**
7148 * Add extended data to the intent. The name must include a package
7149 * prefix, for example the app com.android.contacts would use names
7150 * like "com.android.contacts.ShowAll".
7151 *
7152 * @param name The name of the extra data, with package prefix.
7153 * @param value The short data value.
7154 *
7155 * @return Returns the same Intent object, for chaining multiple calls
7156 * into a single statement.
7157 *
7158 * @see #putExtras
7159 * @see #removeExtra
7160 * @see #getShortExtra(String, short)
7161 */
7162 public Intent putExtra(String name, short value) {
7163 if (mExtras == null) {
7164 mExtras = new Bundle();
7165 }
7166 mExtras.putShort(name, value);
7167 return this;
7168 }
7169
7170 /**
7171 * Add extended data to the intent. The name must include a package
7172 * prefix, for example the app com.android.contacts would use names
7173 * like "com.android.contacts.ShowAll".
7174 *
7175 * @param name The name of the extra data, with package prefix.
7176 * @param value The integer data value.
7177 *
7178 * @return Returns the same Intent object, for chaining multiple calls
7179 * into a single statement.
7180 *
7181 * @see #putExtras
7182 * @see #removeExtra
7183 * @see #getIntExtra(String, int)
7184 */
7185 public Intent putExtra(String name, int value) {
7186 if (mExtras == null) {
7187 mExtras = new Bundle();
7188 }
7189 mExtras.putInt(name, value);
7190 return this;
7191 }
7192
7193 /**
7194 * Add extended data to the intent. The name must include a package
7195 * prefix, for example the app com.android.contacts would use names
7196 * like "com.android.contacts.ShowAll".
7197 *
7198 * @param name The name of the extra data, with package prefix.
7199 * @param value The long data value.
7200 *
7201 * @return Returns the same Intent object, for chaining multiple calls
7202 * into a single statement.
7203 *
7204 * @see #putExtras
7205 * @see #removeExtra
7206 * @see #getLongExtra(String, long)
7207 */
7208 public Intent putExtra(String name, long value) {
7209 if (mExtras == null) {
7210 mExtras = new Bundle();
7211 }
7212 mExtras.putLong(name, value);
7213 return this;
7214 }
7215
7216 /**
7217 * Add extended data to the intent. The name must include a package
7218 * prefix, for example the app com.android.contacts would use names
7219 * like "com.android.contacts.ShowAll".
7220 *
7221 * @param name The name of the extra data, with package prefix.
7222 * @param value The float data value.
7223 *
7224 * @return Returns the same Intent object, for chaining multiple calls
7225 * into a single statement.
7226 *
7227 * @see #putExtras
7228 * @see #removeExtra
7229 * @see #getFloatExtra(String, float)
7230 */
7231 public Intent putExtra(String name, float value) {
7232 if (mExtras == null) {
7233 mExtras = new Bundle();
7234 }
7235 mExtras.putFloat(name, value);
7236 return this;
7237 }
7238
7239 /**
7240 * Add extended data to the intent. The name must include a package
7241 * prefix, for example the app com.android.contacts would use names
7242 * like "com.android.contacts.ShowAll".
7243 *
7244 * @param name The name of the extra data, with package prefix.
7245 * @param value The double data value.
7246 *
7247 * @return Returns the same Intent object, for chaining multiple calls
7248 * into a single statement.
7249 *
7250 * @see #putExtras
7251 * @see #removeExtra
7252 * @see #getDoubleExtra(String, double)
7253 */
7254 public Intent putExtra(String name, double value) {
7255 if (mExtras == null) {
7256 mExtras = new Bundle();
7257 }
7258 mExtras.putDouble(name, value);
7259 return this;
7260 }
7261
7262 /**
7263 * Add extended data to the intent. The name must include a package
7264 * prefix, for example the app com.android.contacts would use names
7265 * like "com.android.contacts.ShowAll".
7266 *
7267 * @param name The name of the extra data, with package prefix.
7268 * @param value The String data value.
7269 *
7270 * @return Returns the same Intent object, for chaining multiple calls
7271 * into a single statement.
7272 *
7273 * @see #putExtras
7274 * @see #removeExtra
7275 * @see #getStringExtra(String)
7276 */
7277 public Intent putExtra(String name, String value) {
7278 if (mExtras == null) {
7279 mExtras = new Bundle();
7280 }
7281 mExtras.putString(name, value);
7282 return this;
7283 }
7284
7285 /**
7286 * Add extended data to the intent. The name must include a package
7287 * prefix, for example the app com.android.contacts would use names
7288 * like "com.android.contacts.ShowAll".
7289 *
7290 * @param name The name of the extra data, with package prefix.
7291 * @param value The CharSequence data value.
7292 *
7293 * @return Returns the same Intent object, for chaining multiple calls
7294 * into a single statement.
7295 *
7296 * @see #putExtras
7297 * @see #removeExtra
7298 * @see #getCharSequenceExtra(String)
7299 */
7300 public Intent putExtra(String name, CharSequence value) {
7301 if (mExtras == null) {
7302 mExtras = new Bundle();
7303 }
7304 mExtras.putCharSequence(name, value);
7305 return this;
7306 }
7307
7308 /**
7309 * Add extended data to the intent. The name must include a package
7310 * prefix, for example the app com.android.contacts would use names
7311 * like "com.android.contacts.ShowAll".
7312 *
7313 * @param name The name of the extra data, with package prefix.
7314 * @param value The Parcelable data value.
7315 *
7316 * @return Returns the same Intent object, for chaining multiple calls
7317 * into a single statement.
7318 *
7319 * @see #putExtras
7320 * @see #removeExtra
7321 * @see #getParcelableExtra(String)
7322 */
7323 public Intent putExtra(String name, Parcelable value) {
7324 if (mExtras == null) {
7325 mExtras = new Bundle();
7326 }
7327 mExtras.putParcelable(name, value);
7328 return this;
7329 }
7330
7331 /**
7332 * Add extended data to the intent. The name must include a package
7333 * prefix, for example the app com.android.contacts would use names
7334 * like "com.android.contacts.ShowAll".
7335 *
7336 * @param name The name of the extra data, with package prefix.
7337 * @param value The Parcelable[] data value.
7338 *
7339 * @return Returns the same Intent object, for chaining multiple calls
7340 * into a single statement.
7341 *
7342 * @see #putExtras
7343 * @see #removeExtra
7344 * @see #getParcelableArrayExtra(String)
7345 */
7346 public Intent putExtra(String name, Parcelable[] value) {
7347 if (mExtras == null) {
7348 mExtras = new Bundle();
7349 }
7350 mExtras.putParcelableArray(name, value);
7351 return this;
7352 }
7353
7354 /**
7355 * Add extended data to the intent. The name must include a package
7356 * prefix, for example the app com.android.contacts would use names
7357 * like "com.android.contacts.ShowAll".
7358 *
7359 * @param name The name of the extra data, with package prefix.
7360 * @param value The ArrayList<Parcelable> data value.
7361 *
7362 * @return Returns the same Intent object, for chaining multiple calls
7363 * into a single statement.
7364 *
7365 * @see #putExtras
7366 * @see #removeExtra
7367 * @see #getParcelableArrayListExtra(String)
7368 */
7369 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7370 if (mExtras == null) {
7371 mExtras = new Bundle();
7372 }
7373 mExtras.putParcelableArrayList(name, value);
7374 return this;
7375 }
7376
7377 /**
7378 * Add extended data to the intent. The name must include a package
7379 * prefix, for example the app com.android.contacts would use names
7380 * like "com.android.contacts.ShowAll".
7381 *
7382 * @param name The name of the extra data, with package prefix.
7383 * @param value The ArrayList<Integer> data value.
7384 *
7385 * @return Returns the same Intent object, for chaining multiple calls
7386 * into a single statement.
7387 *
7388 * @see #putExtras
7389 * @see #removeExtra
7390 * @see #getIntegerArrayListExtra(String)
7391 */
7392 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7393 if (mExtras == null) {
7394 mExtras = new Bundle();
7395 }
7396 mExtras.putIntegerArrayList(name, value);
7397 return this;
7398 }
7399
7400 /**
7401 * Add extended data to the intent. The name must include a package
7402 * prefix, for example the app com.android.contacts would use names
7403 * like "com.android.contacts.ShowAll".
7404 *
7405 * @param name The name of the extra data, with package prefix.
7406 * @param value The ArrayList<String> data value.
7407 *
7408 * @return Returns the same Intent object, for chaining multiple calls
7409 * into a single statement.
7410 *
7411 * @see #putExtras
7412 * @see #removeExtra
7413 * @see #getStringArrayListExtra(String)
7414 */
7415 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7416 if (mExtras == null) {
7417 mExtras = new Bundle();
7418 }
7419 mExtras.putStringArrayList(name, value);
7420 return this;
7421 }
7422
7423 /**
7424 * Add extended data to the intent. The name must include a package
7425 * prefix, for example the app com.android.contacts would use names
7426 * like "com.android.contacts.ShowAll".
7427 *
7428 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007429 * @param value The ArrayList<CharSequence> data value.
7430 *
7431 * @return Returns the same Intent object, for chaining multiple calls
7432 * into a single statement.
7433 *
7434 * @see #putExtras
7435 * @see #removeExtra
7436 * @see #getCharSequenceArrayListExtra(String)
7437 */
7438 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7439 if (mExtras == null) {
7440 mExtras = new Bundle();
7441 }
7442 mExtras.putCharSequenceArrayList(name, value);
7443 return this;
7444 }
7445
7446 /**
7447 * Add extended data to the intent. The name must include a package
7448 * prefix, for example the app com.android.contacts would use names
7449 * like "com.android.contacts.ShowAll".
7450 *
7451 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007452 * @param value The Serializable data value.
7453 *
7454 * @return Returns the same Intent object, for chaining multiple calls
7455 * into a single statement.
7456 *
7457 * @see #putExtras
7458 * @see #removeExtra
7459 * @see #getSerializableExtra(String)
7460 */
7461 public Intent putExtra(String name, Serializable value) {
7462 if (mExtras == null) {
7463 mExtras = new Bundle();
7464 }
7465 mExtras.putSerializable(name, value);
7466 return this;
7467 }
7468
7469 /**
7470 * Add extended data to the intent. The name must include a package
7471 * prefix, for example the app com.android.contacts would use names
7472 * like "com.android.contacts.ShowAll".
7473 *
7474 * @param name The name of the extra data, with package prefix.
7475 * @param value The boolean array data value.
7476 *
7477 * @return Returns the same Intent object, for chaining multiple calls
7478 * into a single statement.
7479 *
7480 * @see #putExtras
7481 * @see #removeExtra
7482 * @see #getBooleanArrayExtra(String)
7483 */
7484 public Intent putExtra(String name, boolean[] value) {
7485 if (mExtras == null) {
7486 mExtras = new Bundle();
7487 }
7488 mExtras.putBooleanArray(name, value);
7489 return this;
7490 }
7491
7492 /**
7493 * Add extended data to the intent. The name must include a package
7494 * prefix, for example the app com.android.contacts would use names
7495 * like "com.android.contacts.ShowAll".
7496 *
7497 * @param name The name of the extra data, with package prefix.
7498 * @param value The byte array data value.
7499 *
7500 * @return Returns the same Intent object, for chaining multiple calls
7501 * into a single statement.
7502 *
7503 * @see #putExtras
7504 * @see #removeExtra
7505 * @see #getByteArrayExtra(String)
7506 */
7507 public Intent putExtra(String name, byte[] value) {
7508 if (mExtras == null) {
7509 mExtras = new Bundle();
7510 }
7511 mExtras.putByteArray(name, value);
7512 return this;
7513 }
7514
7515 /**
7516 * Add extended data to the intent. The name must include a package
7517 * prefix, for example the app com.android.contacts would use names
7518 * like "com.android.contacts.ShowAll".
7519 *
7520 * @param name The name of the extra data, with package prefix.
7521 * @param value The short array data value.
7522 *
7523 * @return Returns the same Intent object, for chaining multiple calls
7524 * into a single statement.
7525 *
7526 * @see #putExtras
7527 * @see #removeExtra
7528 * @see #getShortArrayExtra(String)
7529 */
7530 public Intent putExtra(String name, short[] value) {
7531 if (mExtras == null) {
7532 mExtras = new Bundle();
7533 }
7534 mExtras.putShortArray(name, value);
7535 return this;
7536 }
7537
7538 /**
7539 * Add extended data to the intent. The name must include a package
7540 * prefix, for example the app com.android.contacts would use names
7541 * like "com.android.contacts.ShowAll".
7542 *
7543 * @param name The name of the extra data, with package prefix.
7544 * @param value The char array data value.
7545 *
7546 * @return Returns the same Intent object, for chaining multiple calls
7547 * into a single statement.
7548 *
7549 * @see #putExtras
7550 * @see #removeExtra
7551 * @see #getCharArrayExtra(String)
7552 */
7553 public Intent putExtra(String name, char[] value) {
7554 if (mExtras == null) {
7555 mExtras = new Bundle();
7556 }
7557 mExtras.putCharArray(name, value);
7558 return this;
7559 }
7560
7561 /**
7562 * Add extended data to the intent. The name must include a package
7563 * prefix, for example the app com.android.contacts would use names
7564 * like "com.android.contacts.ShowAll".
7565 *
7566 * @param name The name of the extra data, with package prefix.
7567 * @param value The int array data value.
7568 *
7569 * @return Returns the same Intent object, for chaining multiple calls
7570 * into a single statement.
7571 *
7572 * @see #putExtras
7573 * @see #removeExtra
7574 * @see #getIntArrayExtra(String)
7575 */
7576 public Intent putExtra(String name, int[] value) {
7577 if (mExtras == null) {
7578 mExtras = new Bundle();
7579 }
7580 mExtras.putIntArray(name, value);
7581 return this;
7582 }
7583
7584 /**
7585 * Add extended data to the intent. The name must include a package
7586 * prefix, for example the app com.android.contacts would use names
7587 * like "com.android.contacts.ShowAll".
7588 *
7589 * @param name The name of the extra data, with package prefix.
7590 * @param value The byte array data value.
7591 *
7592 * @return Returns the same Intent object, for chaining multiple calls
7593 * into a single statement.
7594 *
7595 * @see #putExtras
7596 * @see #removeExtra
7597 * @see #getLongArrayExtra(String)
7598 */
7599 public Intent putExtra(String name, long[] value) {
7600 if (mExtras == null) {
7601 mExtras = new Bundle();
7602 }
7603 mExtras.putLongArray(name, value);
7604 return this;
7605 }
7606
7607 /**
7608 * Add extended data to the intent. The name must include a package
7609 * prefix, for example the app com.android.contacts would use names
7610 * like "com.android.contacts.ShowAll".
7611 *
7612 * @param name The name of the extra data, with package prefix.
7613 * @param value The float array data value.
7614 *
7615 * @return Returns the same Intent object, for chaining multiple calls
7616 * into a single statement.
7617 *
7618 * @see #putExtras
7619 * @see #removeExtra
7620 * @see #getFloatArrayExtra(String)
7621 */
7622 public Intent putExtra(String name, float[] value) {
7623 if (mExtras == null) {
7624 mExtras = new Bundle();
7625 }
7626 mExtras.putFloatArray(name, value);
7627 return this;
7628 }
7629
7630 /**
7631 * Add extended data to the intent. The name must include a package
7632 * prefix, for example the app com.android.contacts would use names
7633 * like "com.android.contacts.ShowAll".
7634 *
7635 * @param name The name of the extra data, with package prefix.
7636 * @param value The double array data value.
7637 *
7638 * @return Returns the same Intent object, for chaining multiple calls
7639 * into a single statement.
7640 *
7641 * @see #putExtras
7642 * @see #removeExtra
7643 * @see #getDoubleArrayExtra(String)
7644 */
7645 public Intent putExtra(String name, double[] value) {
7646 if (mExtras == null) {
7647 mExtras = new Bundle();
7648 }
7649 mExtras.putDoubleArray(name, value);
7650 return this;
7651 }
7652
7653 /**
7654 * Add extended data to the intent. The name must include a package
7655 * prefix, for example the app com.android.contacts would use names
7656 * like "com.android.contacts.ShowAll".
7657 *
7658 * @param name The name of the extra data, with package prefix.
7659 * @param value The String array data value.
7660 *
7661 * @return Returns the same Intent object, for chaining multiple calls
7662 * into a single statement.
7663 *
7664 * @see #putExtras
7665 * @see #removeExtra
7666 * @see #getStringArrayExtra(String)
7667 */
7668 public Intent putExtra(String name, String[] value) {
7669 if (mExtras == null) {
7670 mExtras = new Bundle();
7671 }
7672 mExtras.putStringArray(name, value);
7673 return this;
7674 }
7675
7676 /**
7677 * Add extended data to the intent. The name must include a package
7678 * prefix, for example the app com.android.contacts would use names
7679 * like "com.android.contacts.ShowAll".
7680 *
7681 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007682 * @param value The CharSequence array data value.
7683 *
7684 * @return Returns the same Intent object, for chaining multiple calls
7685 * into a single statement.
7686 *
7687 * @see #putExtras
7688 * @see #removeExtra
7689 * @see #getCharSequenceArrayExtra(String)
7690 */
7691 public Intent putExtra(String name, CharSequence[] value) {
7692 if (mExtras == null) {
7693 mExtras = new Bundle();
7694 }
7695 mExtras.putCharSequenceArray(name, value);
7696 return this;
7697 }
7698
7699 /**
7700 * Add extended data to the intent. The name must include a package
7701 * prefix, for example the app com.android.contacts would use names
7702 * like "com.android.contacts.ShowAll".
7703 *
7704 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007705 * @param value The Bundle data value.
7706 *
7707 * @return Returns the same Intent object, for chaining multiple calls
7708 * into a single statement.
7709 *
7710 * @see #putExtras
7711 * @see #removeExtra
7712 * @see #getBundleExtra(String)
7713 */
7714 public Intent putExtra(String name, Bundle value) {
7715 if (mExtras == null) {
7716 mExtras = new Bundle();
7717 }
7718 mExtras.putBundle(name, value);
7719 return this;
7720 }
7721
7722 /**
7723 * Add extended data to the intent. The name must include a package
7724 * prefix, for example the app com.android.contacts would use names
7725 * like "com.android.contacts.ShowAll".
7726 *
7727 * @param name The name of the extra data, with package prefix.
7728 * @param value The IBinder data value.
7729 *
7730 * @return Returns the same Intent object, for chaining multiple calls
7731 * into a single statement.
7732 *
7733 * @see #putExtras
7734 * @see #removeExtra
7735 * @see #getIBinderExtra(String)
7736 *
7737 * @deprecated
7738 * @hide
7739 */
7740 @Deprecated
7741 public Intent putExtra(String name, IBinder value) {
7742 if (mExtras == null) {
7743 mExtras = new Bundle();
7744 }
7745 mExtras.putIBinder(name, value);
7746 return this;
7747 }
7748
7749 /**
7750 * Copy all extras in 'src' in to this intent.
7751 *
7752 * @param src Contains the extras to copy.
7753 *
7754 * @see #putExtra
7755 */
7756 public Intent putExtras(Intent src) {
7757 if (src.mExtras != null) {
7758 if (mExtras == null) {
7759 mExtras = new Bundle(src.mExtras);
7760 } else {
7761 mExtras.putAll(src.mExtras);
7762 }
7763 }
7764 return this;
7765 }
7766
7767 /**
7768 * Add a set of extended data to the intent. The keys 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 extras The Bundle of extras to add to this intent.
7773 *
7774 * @see #putExtra
7775 * @see #removeExtra
7776 */
7777 public Intent putExtras(Bundle extras) {
7778 if (mExtras == null) {
7779 mExtras = new Bundle();
7780 }
7781 mExtras.putAll(extras);
7782 return this;
7783 }
7784
7785 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007786 * Completely replace the extras in the Intent with the extras in the
7787 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007788 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007789 * @param src The exact extras contained in this Intent are copied
7790 * into the target intent, replacing any that were previously there.
7791 */
7792 public Intent replaceExtras(Intent src) {
7793 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7794 return this;
7795 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007796
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007797 /**
7798 * Completely replace the extras in the Intent with the given Bundle of
7799 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007800 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007801 * @param extras The new set of extras in the Intent, or null to erase
7802 * all extras.
7803 */
7804 public Intent replaceExtras(Bundle extras) {
7805 mExtras = extras != null ? new Bundle(extras) : null;
7806 return this;
7807 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007808
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007809 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007810 * Remove extended data from the intent.
7811 *
7812 * @see #putExtra
7813 */
7814 public void removeExtra(String name) {
7815 if (mExtras != null) {
7816 mExtras.remove(name);
7817 if (mExtras.size() == 0) {
7818 mExtras = null;
7819 }
7820 }
7821 }
7822
7823 /**
7824 * Set special flags controlling how this intent is handled. Most values
7825 * here depend on the type of component being executed by the Intent,
7826 * specifically the FLAG_ACTIVITY_* flags are all for use with
7827 * {@link Context#startActivity Context.startActivity()} and the
7828 * FLAG_RECEIVER_* flags are all for use with
7829 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7830 *
Scott Main7aee61f2011-02-08 11:25:01 -08007831 * <p>See the
7832 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7833 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007834 * the behavior of your application.
7835 *
7836 * @param flags The desired flags.
7837 *
7838 * @return Returns the same Intent object, for chaining multiple calls
7839 * into a single statement.
7840 *
7841 * @see #getFlags
7842 * @see #addFlags
7843 *
7844 * @see #FLAG_GRANT_READ_URI_PERMISSION
7845 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007846 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7847 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007848 * @see #FLAG_DEBUG_LOG_RESOLUTION
7849 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007850 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007851 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007852 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007853 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007854 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7855 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007856 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007857 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007858 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007859 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007860 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007861 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007862 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007863 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7864 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007865 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007866 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007867 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007868 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7869 */
7870 public Intent setFlags(int flags) {
7871 mFlags = flags;
7872 return this;
7873 }
7874
7875 /**
7876 * Add additional flags to the intent (or with existing flags
7877 * value).
7878 *
7879 * @param flags The new flags to set.
7880 *
7881 * @return Returns the same Intent object, for chaining multiple calls
7882 * into a single statement.
7883 *
7884 * @see #setFlags
7885 */
7886 public Intent addFlags(int flags) {
7887 mFlags |= flags;
7888 return this;
7889 }
7890
7891 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007892 * (Usually optional) Set an explicit application package name that limits
7893 * the components this Intent will resolve to. If left to the default
7894 * value of null, all components in all applications will considered.
7895 * If non-null, the Intent can only match the components in the given
7896 * application package.
7897 *
7898 * @param packageName The name of the application package to handle the
7899 * intent, or null to allow any application package.
7900 *
7901 * @return Returns the same Intent object, for chaining multiple calls
7902 * into a single statement.
7903 *
7904 * @see #getPackage
7905 * @see #resolveActivity
7906 */
7907 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007908 if (packageName != null && mSelector != null) {
7909 throw new IllegalArgumentException(
7910 "Can't set package name when selector is already set");
7911 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007912 mPackage = packageName;
7913 return this;
7914 }
7915
7916 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007917 * (Usually optional) Explicitly set the component to handle the intent.
7918 * If left with the default value of null, the system will determine the
7919 * appropriate class to use based on the other fields (action, data,
7920 * type, categories) in the Intent. If this class is defined, the
7921 * specified class will always be used regardless of the other fields. You
7922 * should only set this value when you know you absolutely want a specific
7923 * class to be used; otherwise it is better to let the system find the
7924 * appropriate class so that you will respect the installed applications
7925 * and user preferences.
7926 *
7927 * @param component The name of the application component to handle the
7928 * intent, or null to let the system find one for you.
7929 *
7930 * @return Returns the same Intent object, for chaining multiple calls
7931 * into a single statement.
7932 *
7933 * @see #setClass
7934 * @see #setClassName(Context, String)
7935 * @see #setClassName(String, String)
7936 * @see #getComponent
7937 * @see #resolveActivity
7938 */
7939 public Intent setComponent(ComponentName component) {
7940 mComponent = component;
7941 return this;
7942 }
7943
7944 /**
7945 * Convenience for calling {@link #setComponent} with an
7946 * explicit class name.
7947 *
7948 * @param packageContext A Context of the application package implementing
7949 * this class.
7950 * @param className The name of a class inside of the application package
7951 * that will be used as the component for this Intent.
7952 *
7953 * @return Returns the same Intent object, for chaining multiple calls
7954 * into a single statement.
7955 *
7956 * @see #setComponent
7957 * @see #setClass
7958 */
7959 public Intent setClassName(Context packageContext, String className) {
7960 mComponent = new ComponentName(packageContext, className);
7961 return this;
7962 }
7963
7964 /**
7965 * Convenience for calling {@link #setComponent} with an
7966 * explicit application package name and class name.
7967 *
7968 * @param packageName The name of the package implementing the desired
7969 * component.
7970 * @param className The name of a class inside of the application package
7971 * that will be used as the component for this Intent.
7972 *
7973 * @return Returns the same Intent object, for chaining multiple calls
7974 * into a single statement.
7975 *
7976 * @see #setComponent
7977 * @see #setClass
7978 */
7979 public Intent setClassName(String packageName, String className) {
7980 mComponent = new ComponentName(packageName, className);
7981 return this;
7982 }
7983
7984 /**
7985 * Convenience for calling {@link #setComponent(ComponentName)} with the
7986 * name returned by a {@link Class} object.
7987 *
7988 * @param packageContext A Context of the application package implementing
7989 * this class.
7990 * @param cls The class name to set, equivalent to
7991 * <code>setClassName(context, cls.getName())</code>.
7992 *
7993 * @return Returns the same Intent object, for chaining multiple calls
7994 * into a single statement.
7995 *
7996 * @see #setComponent
7997 */
7998 public Intent setClass(Context packageContext, Class<?> cls) {
7999 mComponent = new ComponentName(packageContext, cls);
8000 return this;
8001 }
8002
8003 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008004 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8005 * used as a hint to the receiver for animations and the like. Null means that there
8006 * is no source bounds.
8007 */
8008 public void setSourceBounds(Rect r) {
8009 if (r != null) {
8010 mSourceBounds = new Rect(r);
8011 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008012 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008013 }
8014 }
8015
Tor Norbyed9273d62013-05-30 15:59:53 -07008016 /** @hide */
8017 @IntDef(flag = true,
8018 value = {
8019 FILL_IN_ACTION,
8020 FILL_IN_DATA,
8021 FILL_IN_CATEGORIES,
8022 FILL_IN_COMPONENT,
8023 FILL_IN_PACKAGE,
8024 FILL_IN_SOURCE_BOUNDS,
8025 FILL_IN_SELECTOR,
8026 FILL_IN_CLIP_DATA
8027 })
8028 @Retention(RetentionPolicy.SOURCE)
8029 public @interface FillInFlags {}
8030
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008031 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008032 * Use with {@link #fillIn} to allow the current action value to be
8033 * overwritten, even if it is already set.
8034 */
8035 public static final int FILL_IN_ACTION = 1<<0;
8036
8037 /**
8038 * Use with {@link #fillIn} to allow the current data or type value
8039 * overwritten, even if it is already set.
8040 */
8041 public static final int FILL_IN_DATA = 1<<1;
8042
8043 /**
8044 * Use with {@link #fillIn} to allow the current categories to be
8045 * overwritten, even if they are already set.
8046 */
8047 public static final int FILL_IN_CATEGORIES = 1<<2;
8048
8049 /**
8050 * Use with {@link #fillIn} to allow the current component value to be
8051 * overwritten, even if it is already set.
8052 */
8053 public static final int FILL_IN_COMPONENT = 1<<3;
8054
8055 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008056 * Use with {@link #fillIn} to allow the current package value to be
8057 * overwritten, even if it is already set.
8058 */
8059 public static final int FILL_IN_PACKAGE = 1<<4;
8060
8061 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008062 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008063 * overwritten, even if it is already set.
8064 */
8065 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8066
8067 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008068 * Use with {@link #fillIn} to allow the current selector to be
8069 * overwritten, even if it is already set.
8070 */
8071 public static final int FILL_IN_SELECTOR = 1<<6;
8072
8073 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008074 * Use with {@link #fillIn} to allow the current ClipData to be
8075 * overwritten, even if it is already set.
8076 */
8077 public static final int FILL_IN_CLIP_DATA = 1<<7;
8078
8079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008080 * Copy the contents of <var>other</var> in to this object, but only
8081 * where fields are not defined by this object. For purposes of a field
8082 * being defined, the following pieces of data in the Intent are
8083 * considered to be separate fields:
8084 *
8085 * <ul>
8086 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008087 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008088 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8089 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008090 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008091 * <li> component, as set by {@link #setComponent(ComponentName)} or
8092 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008093 * <li> source bounds, as set by {@link #setSourceBounds}.
8094 * <li> selector, as set by {@link #setSelector(Intent)}.
8095 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008096 * <li> each top-level name in the associated extras.
8097 * </ul>
8098 *
8099 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008100 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008101 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8102 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8103 * the restriction where the corresponding field will not be replaced if
8104 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008105 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008106 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8107 * is explicitly specified. The selector will only be copied if
8108 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008109 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008110 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8111 * and Intent B with {action="gotit", data-type="some/thing",
8112 * categories="one","two"}.
8113 *
8114 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8115 * containing: {action="gotit", data-type="some/thing",
8116 * categories="bar"}.
8117 *
8118 * @param other Another Intent whose values are to be used to fill in
8119 * the current one.
8120 * @param flags Options to control which fields can be filled in.
8121 *
8122 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008123 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008124 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8125 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8126 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008127 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008128 @FillInFlags
8129 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008130 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008131 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008132 if (other.mAction != null
8133 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008134 mAction = other.mAction;
8135 changes |= FILL_IN_ACTION;
8136 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008137 if ((other.mData != null || other.mType != null)
8138 && ((mData == null && mType == null)
8139 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008140 mData = other.mData;
8141 mType = other.mType;
8142 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008143 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008144 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008145 if (other.mCategories != null
8146 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008147 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008148 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008149 }
8150 changes |= FILL_IN_CATEGORIES;
8151 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008152 if (other.mPackage != null
8153 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008154 // Only do this if mSelector is not set.
8155 if (mSelector == null) {
8156 mPackage = other.mPackage;
8157 changes |= FILL_IN_PACKAGE;
8158 }
8159 }
8160 // Selector is special: it can only be set if explicitly allowed,
8161 // for the same reason as the component name.
8162 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8163 if (mPackage == null) {
8164 mSelector = new Intent(other.mSelector);
8165 mPackage = null;
8166 changes |= FILL_IN_SELECTOR;
8167 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008168 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008169 if (other.mClipData != null
8170 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8171 mClipData = other.mClipData;
8172 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008173 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008174 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008175 // Component is special: it can -only- be set if explicitly allowed,
8176 // since otherwise the sender could force the intent somewhere the
8177 // originator didn't intend.
8178 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008179 mComponent = other.mComponent;
8180 changes |= FILL_IN_COMPONENT;
8181 }
8182 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008183 if (other.mSourceBounds != null
8184 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8185 mSourceBounds = new Rect(other.mSourceBounds);
8186 changes |= FILL_IN_SOURCE_BOUNDS;
8187 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008188 if (mExtras == null) {
8189 if (other.mExtras != null) {
8190 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008191 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008192 }
8193 } else if (other.mExtras != null) {
8194 try {
8195 Bundle newb = new Bundle(other.mExtras);
8196 newb.putAll(mExtras);
8197 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008198 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008199 } catch (RuntimeException e) {
8200 // Modifying the extras can cause us to unparcel the contents
8201 // of the bundle, and if we do this in the system process that
8202 // may fail. We really should handle this (i.e., the Bundle
8203 // impl shouldn't be on top of a plain map), but for now just
8204 // ignore it and keep the original contents. :(
8205 Log.w("Intent", "Failure filling in extras", e);
8206 }
8207 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008208 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8209 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8210 mContentUserHint = other.mContentUserHint;
8211 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008212 return changes;
8213 }
8214
8215 /**
8216 * Wrapper class holding an Intent and implementing comparisons on it for
8217 * the purpose of filtering. The class implements its
8218 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8219 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8220 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8221 * on the wrapped Intent.
8222 */
8223 public static final class FilterComparison {
8224 private final Intent mIntent;
8225 private final int mHashCode;
8226
8227 public FilterComparison(Intent intent) {
8228 mIntent = intent;
8229 mHashCode = intent.filterHashCode();
8230 }
8231
8232 /**
8233 * Return the Intent that this FilterComparison represents.
8234 * @return Returns the Intent held by the FilterComparison. Do
8235 * not modify!
8236 */
8237 public Intent getIntent() {
8238 return mIntent;
8239 }
8240
8241 @Override
8242 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008243 if (obj instanceof FilterComparison) {
8244 Intent other = ((FilterComparison)obj).mIntent;
8245 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008246 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008247 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008248 }
8249
8250 @Override
8251 public int hashCode() {
8252 return mHashCode;
8253 }
8254 }
8255
8256 /**
8257 * Determine if two intents are the same for the purposes of intent
8258 * resolution (filtering). That is, if their action, data, type,
8259 * class, and categories are the same. This does <em>not</em> compare
8260 * any extra data included in the intents.
8261 *
8262 * @param other The other Intent to compare against.
8263 *
8264 * @return Returns true if action, data, type, class, and categories
8265 * are the same.
8266 */
8267 public boolean filterEquals(Intent other) {
8268 if (other == null) {
8269 return false;
8270 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008271 if (!Objects.equals(this.mAction, other.mAction)) return false;
8272 if (!Objects.equals(this.mData, other.mData)) return false;
8273 if (!Objects.equals(this.mType, other.mType)) return false;
8274 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8275 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8276 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008277
8278 return true;
8279 }
8280
8281 /**
8282 * Generate hash code that matches semantics of filterEquals().
8283 *
8284 * @return Returns the hash value of the action, data, type, class, and
8285 * categories.
8286 *
8287 * @see #filterEquals
8288 */
8289 public int filterHashCode() {
8290 int code = 0;
8291 if (mAction != null) {
8292 code += mAction.hashCode();
8293 }
8294 if (mData != null) {
8295 code += mData.hashCode();
8296 }
8297 if (mType != null) {
8298 code += mType.hashCode();
8299 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008300 if (mPackage != null) {
8301 code += mPackage.hashCode();
8302 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008303 if (mComponent != null) {
8304 code += mComponent.hashCode();
8305 }
8306 if (mCategories != null) {
8307 code += mCategories.hashCode();
8308 }
8309 return code;
8310 }
8311
8312 @Override
8313 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008314 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008315
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008316 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008317 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008318 b.append(" }");
8319
8320 return b.toString();
8321 }
8322
8323 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008324 public String toInsecureString() {
8325 StringBuilder b = new StringBuilder(128);
8326
8327 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008328 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008329 b.append(" }");
8330
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008331 return b.toString();
8332 }
Romain Guy4969af72009-06-17 10:53:19 -07008333
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008334 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008335 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008336 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008337
8338 b.append("Intent { ");
8339 toShortString(b, false, true, true, true);
8340 b.append(" }");
8341
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008342 return b.toString();
8343 }
8344
8345 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008346 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8347 StringBuilder b = new StringBuilder(128);
8348 toShortString(b, secure, comp, extras, clip);
8349 return b.toString();
8350 }
8351
8352 /** @hide */
8353 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8354 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008355 boolean first = true;
8356 if (mAction != null) {
8357 b.append("act=").append(mAction);
8358 first = false;
8359 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008360 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008361 if (!first) {
8362 b.append(' ');
8363 }
8364 first = false;
8365 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008366 for (int i=0; i<mCategories.size(); i++) {
8367 if (i > 0) b.append(',');
8368 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008369 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008370 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008371 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008372 if (mData != null) {
8373 if (!first) {
8374 b.append(' ');
8375 }
8376 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008377 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008378 if (secure) {
8379 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008380 } else {
8381 b.append(mData);
8382 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008383 }
8384 if (mType != null) {
8385 if (!first) {
8386 b.append(' ');
8387 }
8388 first = false;
8389 b.append("typ=").append(mType);
8390 }
8391 if (mFlags != 0) {
8392 if (!first) {
8393 b.append(' ');
8394 }
8395 first = false;
8396 b.append("flg=0x").append(Integer.toHexString(mFlags));
8397 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008398 if (mPackage != null) {
8399 if (!first) {
8400 b.append(' ');
8401 }
8402 first = false;
8403 b.append("pkg=").append(mPackage);
8404 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008405 if (comp && mComponent != null) {
8406 if (!first) {
8407 b.append(' ');
8408 }
8409 first = false;
8410 b.append("cmp=").append(mComponent.flattenToShortString());
8411 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008412 if (mSourceBounds != null) {
8413 if (!first) {
8414 b.append(' ');
8415 }
8416 first = false;
8417 b.append("bnds=").append(mSourceBounds.toShortString());
8418 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008419 if (mClipData != null) {
8420 if (!first) {
8421 b.append(' ');
8422 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008423 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008424 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008425 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008426 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008427 if (mClipData.getDescription() != null) {
8428 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8429 } else {
8430 first = true;
8431 }
8432 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008433 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008434 first = false;
8435 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008436 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008437 if (extras && mExtras != null) {
8438 if (!first) {
8439 b.append(' ');
8440 }
8441 first = false;
8442 b.append("(has extras)");
8443 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008444 if (mContentUserHint != UserHandle.USER_CURRENT) {
8445 if (!first) {
8446 b.append(' ');
8447 }
8448 first = false;
8449 b.append("u=").append(mContentUserHint);
8450 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008451 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008452 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008453 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008454 b.append("}");
8455 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008456 }
8457
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008458 /**
8459 * Call {@link #toUri} with 0 flags.
8460 * @deprecated Use {@link #toUri} instead.
8461 */
8462 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008463 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008464 return toUri(0);
8465 }
8466
8467 /**
8468 * Convert this Intent into a String holding a URI representation of it.
8469 * The returned URI string has been properly URI encoded, so it can be
8470 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8471 * Intent's data as the base URI, with an additional fragment describing
8472 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008473 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008474 * <p>You can convert the returned string back to an Intent with
8475 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008476 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008477 * @param flags Additional operating flags. Either 0,
8478 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008479 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008480 * @return Returns a URI encoding URI string describing the entire contents
8481 * of the Intent.
8482 */
8483 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008484 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008485 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8486 if (mPackage == null) {
8487 throw new IllegalArgumentException(
8488 "Intent must include an explicit package name to build an android-app: "
8489 + this);
8490 }
8491 uri.append("android-app://");
8492 uri.append(mPackage);
8493 String scheme = null;
8494 if (mData != null) {
8495 scheme = mData.getScheme();
8496 if (scheme != null) {
8497 uri.append('/');
8498 uri.append(scheme);
8499 String authority = mData.getEncodedAuthority();
8500 if (authority != null) {
8501 uri.append('/');
8502 uri.append(authority);
8503 String path = mData.getEncodedPath();
8504 if (path != null) {
8505 uri.append(path);
8506 }
8507 String queryParams = mData.getEncodedQuery();
8508 if (queryParams != null) {
8509 uri.append('?');
8510 uri.append(queryParams);
8511 }
8512 String fragment = mData.getEncodedFragment();
8513 if (fragment != null) {
8514 uri.append('#');
8515 uri.append(fragment);
8516 }
8517 }
8518 }
8519 }
8520 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8521 mPackage, flags);
8522 return uri.toString();
8523 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008524 String scheme = null;
8525 if (mData != null) {
8526 String data = mData.toString();
8527 if ((flags&URI_INTENT_SCHEME) != 0) {
8528 final int N = data.length();
8529 for (int i=0; i<N; i++) {
8530 char c = data.charAt(i);
8531 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8532 || c == '.' || c == '-') {
8533 continue;
8534 }
8535 if (c == ':' && i > 0) {
8536 // Valid scheme.
8537 scheme = data.substring(0, i);
8538 uri.append("intent:");
8539 data = data.substring(i+1);
8540 break;
8541 }
Tom Taylord4a47292009-12-21 13:59:18 -08008542
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008543 // No scheme.
8544 break;
8545 }
8546 }
8547 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008548
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008549 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8550 uri.append("intent:");
8551 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008552
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008553 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008554
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008555 return uri.toString();
8556 }
8557
8558 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8559 String defPackage, int flags) {
8560 StringBuilder frag = new StringBuilder(128);
8561
8562 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008563 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008564 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008565 // Note that for now we are not going to try to handle the
8566 // data part; not clear how to represent this as a URI, and
8567 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008568 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8569 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008570 }
8571
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008572 if (frag.length() > 0) {
8573 uri.append("#Intent;");
8574 uri.append(frag);
8575 uri.append("end");
8576 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008577 }
8578
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008579 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8580 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008581 if (scheme != null) {
8582 uri.append("scheme=").append(scheme).append(';');
8583 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008584 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008585 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008586 }
8587 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008588 for (int i=0; i<mCategories.size(); i++) {
8589 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008590 }
8591 }
8592 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008593 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008594 }
8595 if (mFlags != 0) {
8596 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8597 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008598 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008599 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8600 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008601 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008602 uri.append("component=").append(Uri.encode(
8603 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008604 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008605 if (mSourceBounds != null) {
8606 uri.append("sourceBounds=")
8607 .append(Uri.encode(mSourceBounds.flattenToString()))
8608 .append(';');
8609 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008610 if (mExtras != null) {
8611 for (String key : mExtras.keySet()) {
8612 final Object value = mExtras.get(key);
8613 char entryType =
8614 value instanceof String ? 'S' :
8615 value instanceof Boolean ? 'B' :
8616 value instanceof Byte ? 'b' :
8617 value instanceof Character ? 'c' :
8618 value instanceof Double ? 'd' :
8619 value instanceof Float ? 'f' :
8620 value instanceof Integer ? 'i' :
8621 value instanceof Long ? 'l' :
8622 value instanceof Short ? 's' :
8623 '\0';
8624
8625 if (entryType != '\0') {
8626 uri.append(entryType);
8627 uri.append('.');
8628 uri.append(Uri.encode(key));
8629 uri.append('=');
8630 uri.append(Uri.encode(value.toString()));
8631 uri.append(';');
8632 }
8633 }
8634 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008635 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008637 public int describeContents() {
8638 return (mExtras != null) ? mExtras.describeContents() : 0;
8639 }
8640
8641 public void writeToParcel(Parcel out, int flags) {
8642 out.writeString(mAction);
8643 Uri.writeToParcel(out, mData);
8644 out.writeString(mType);
8645 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008646 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008647 ComponentName.writeToParcel(mComponent, out);
8648
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008649 if (mSourceBounds != null) {
8650 out.writeInt(1);
8651 mSourceBounds.writeToParcel(out, flags);
8652 } else {
8653 out.writeInt(0);
8654 }
8655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008656 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008657 final int N = mCategories.size();
8658 out.writeInt(N);
8659 for (int i=0; i<N; i++) {
8660 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008661 }
8662 } else {
8663 out.writeInt(0);
8664 }
8665
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008666 if (mSelector != null) {
8667 out.writeInt(1);
8668 mSelector.writeToParcel(out, flags);
8669 } else {
8670 out.writeInt(0);
8671 }
8672
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008673 if (mClipData != null) {
8674 out.writeInt(1);
8675 mClipData.writeToParcel(out, flags);
8676 } else {
8677 out.writeInt(0);
8678 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008679 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008680 out.writeBundle(mExtras);
8681 }
8682
8683 public static final Parcelable.Creator<Intent> CREATOR
8684 = new Parcelable.Creator<Intent>() {
8685 public Intent createFromParcel(Parcel in) {
8686 return new Intent(in);
8687 }
8688 public Intent[] newArray(int size) {
8689 return new Intent[size];
8690 }
8691 };
8692
Dianne Hackborneb034652009-09-07 00:49:58 -07008693 /** @hide */
8694 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008695 readFromParcel(in);
8696 }
8697
8698 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008699 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008700 mData = Uri.CREATOR.createFromParcel(in);
8701 mType = in.readString();
8702 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008703 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008704 mComponent = ComponentName.readFromParcel(in);
8705
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008706 if (in.readInt() != 0) {
8707 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8708 }
8709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008710 int N = in.readInt();
8711 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008712 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008713 int i;
8714 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008715 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008716 }
8717 } else {
8718 mCategories = null;
8719 }
8720
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008721 if (in.readInt() != 0) {
8722 mSelector = new Intent(in);
8723 }
8724
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008725 if (in.readInt() != 0) {
8726 mClipData = new ClipData(in);
8727 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008728 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008729 mExtras = in.readBundle();
8730 }
8731
8732 /**
8733 * Parses the "intent" element (and its children) from XML and instantiates
8734 * an Intent object. The given XML parser should be located at the tag
8735 * where parsing should start (often named "intent"), from which the
8736 * basic action, data, type, and package and class name will be
8737 * retrieved. The function will then parse in to any child elements,
8738 * looking for <category android:name="xxx"> tags to add categories and
8739 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8740 * to the intent.
8741 *
8742 * @param resources The Resources to use when inflating resources.
8743 * @param parser The XML parser pointing at an "intent" tag.
8744 * @param attrs The AttributeSet interface for retrieving extended
8745 * attribute data at the current <var>parser</var> location.
8746 * @return An Intent object matching the XML data.
8747 * @throws XmlPullParserException If there was an XML parsing error.
8748 * @throws IOException If there was an I/O error.
8749 */
8750 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8751 throws XmlPullParserException, IOException {
8752 Intent intent = new Intent();
8753
8754 TypedArray sa = resources.obtainAttributes(attrs,
8755 com.android.internal.R.styleable.Intent);
8756
8757 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8758
8759 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8760 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8761 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8762
8763 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8764 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8765 if (packageName != null && className != null) {
8766 intent.setComponent(new ComponentName(packageName, className));
8767 }
8768
8769 sa.recycle();
8770
8771 int outerDepth = parser.getDepth();
8772 int type;
8773 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8774 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8775 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8776 continue;
8777 }
8778
8779 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008780 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008781 sa = resources.obtainAttributes(attrs,
8782 com.android.internal.R.styleable.IntentCategory);
8783 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8784 sa.recycle();
8785
8786 if (cat != null) {
8787 intent.addCategory(cat);
8788 }
8789 XmlUtils.skipCurrentTag(parser);
8790
Craig Mautner21d24a22014-04-23 11:45:37 -07008791 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008792 if (intent.mExtras == null) {
8793 intent.mExtras = new Bundle();
8794 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008795 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008796 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008797
8798 } else {
8799 XmlUtils.skipCurrentTag(parser);
8800 }
8801 }
8802
8803 return intent;
8804 }
Nick Pellyccae4122012-01-09 14:12:58 -08008805
Craig Mautner21d24a22014-04-23 11:45:37 -07008806 /** @hide */
8807 public void saveToXml(XmlSerializer out) throws IOException {
8808 if (mAction != null) {
8809 out.attribute(null, ATTR_ACTION, mAction);
8810 }
8811 if (mData != null) {
8812 out.attribute(null, ATTR_DATA, mData.toString());
8813 }
8814 if (mType != null) {
8815 out.attribute(null, ATTR_TYPE, mType);
8816 }
8817 if (mComponent != null) {
8818 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8819 }
8820 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8821
8822 if (mCategories != null) {
8823 out.startTag(null, TAG_CATEGORIES);
8824 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8825 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8826 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008827 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008828 }
8829 }
8830
8831 /** @hide */
8832 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8833 XmlPullParserException {
8834 Intent intent = new Intent();
8835 final int outerDepth = in.getDepth();
8836
8837 int attrCount = in.getAttributeCount();
8838 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8839 final String attrName = in.getAttributeName(attrNdx);
8840 final String attrValue = in.getAttributeValue(attrNdx);
8841 if (ATTR_ACTION.equals(attrName)) {
8842 intent.setAction(attrValue);
8843 } else if (ATTR_DATA.equals(attrName)) {
8844 intent.setData(Uri.parse(attrValue));
8845 } else if (ATTR_TYPE.equals(attrName)) {
8846 intent.setType(attrValue);
8847 } else if (ATTR_COMPONENT.equals(attrName)) {
8848 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8849 } else if (ATTR_FLAGS.equals(attrName)) {
8850 intent.setFlags(Integer.valueOf(attrValue, 16));
8851 } else {
8852 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8853 }
8854 }
8855
8856 int event;
8857 String name;
8858 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8859 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8860 if (event == XmlPullParser.START_TAG) {
8861 name = in.getName();
8862 if (TAG_CATEGORIES.equals(name)) {
8863 attrCount = in.getAttributeCount();
8864 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8865 intent.addCategory(in.getAttributeValue(attrNdx));
8866 }
8867 } else {
8868 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8869 XmlUtils.skipCurrentTag(in);
8870 }
8871 }
8872 }
8873
8874 return intent;
8875 }
8876
Nick Pellyccae4122012-01-09 14:12:58 -08008877 /**
8878 * Normalize a MIME data type.
8879 *
8880 * <p>A normalized MIME type has white-space trimmed,
8881 * content-type parameters removed, and is lower-case.
8882 * This aligns the type with Android best practices for
8883 * intent filtering.
8884 *
8885 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8886 * "text/x-vCard" becomes "text/x-vcard".
8887 *
8888 * <p>All MIME types received from outside Android (such as user input,
8889 * or external sources like Bluetooth, NFC, or the Internet) should
8890 * be normalized before they are used to create an Intent.
8891 *
8892 * @param type MIME data type to normalize
8893 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008894 * @see #setType
8895 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008896 */
8897 public static String normalizeMimeType(String type) {
8898 if (type == null) {
8899 return null;
8900 }
8901
Elliott Hughescb64d432013-08-02 10:00:44 -07008902 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008903
8904 final int semicolonIndex = type.indexOf(';');
8905 if (semicolonIndex != -1) {
8906 type = type.substring(0, semicolonIndex);
8907 }
8908 return type;
8909 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008910
8911 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008912 * Prepare this {@link Intent} to leave an app process.
8913 *
8914 * @hide
8915 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008916 public void prepareToLeaveProcess(Context context) {
8917 final boolean leavingPackage = (mComponent == null)
8918 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8919 prepareToLeaveProcess(leavingPackage);
8920 }
8921
8922 /**
8923 * Prepare this {@link Intent} to leave an app process.
8924 *
8925 * @hide
8926 */
8927 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008928 setAllowFds(false);
8929
8930 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008931 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008932 }
8933 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008934 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008935 }
8936
Jeff Sharkeya8b42782016-01-30 17:58:09 -07008937 if (mAction != null && mData != null && StrictMode.vmFileUriExposureEnabled()
8938 && leavingPackage) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008939 switch (mAction) {
8940 case ACTION_MEDIA_REMOVED:
8941 case ACTION_MEDIA_UNMOUNTED:
8942 case ACTION_MEDIA_CHECKING:
8943 case ACTION_MEDIA_NOFS:
8944 case ACTION_MEDIA_MOUNTED:
8945 case ACTION_MEDIA_SHARED:
8946 case ACTION_MEDIA_UNSHARED:
8947 case ACTION_MEDIA_BAD_REMOVAL:
8948 case ACTION_MEDIA_UNMOUNTABLE:
8949 case ACTION_MEDIA_EJECT:
8950 case ACTION_MEDIA_SCANNER_STARTED:
8951 case ACTION_MEDIA_SCANNER_FINISHED:
8952 case ACTION_MEDIA_SCANNER_SCAN_FILE:
Jeff Sharkey37355a92016-02-05 16:19:10 -07008953 case ACTION_PACKAGE_NEEDS_VERIFICATION:
8954 case ACTION_PACKAGE_VERIFIED:
Jeff Sharkey344744b2016-01-28 19:03:30 -07008955 // Ignore legacy actions
8956 break;
8957 default:
8958 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008959 }
8960 }
8961 }
8962
8963 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008964 * @hide
8965 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008966 public void prepareToEnterProcess() {
Jeff Sharkeyd136e512016-03-09 22:30:56 -07008967 // We just entered destination process, so we should be able to read all
8968 // parcelables inside.
8969 setDefusable(true);
8970
8971 if (mSelector != null) {
8972 mSelector.prepareToEnterProcess();
8973 }
8974 if (mClipData != null) {
8975 mClipData.prepareToEnterProcess();
8976 }
8977
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008978 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008979 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8980 fixUris(mContentUserHint);
8981 mContentUserHint = UserHandle.USER_CURRENT;
8982 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008983 }
8984 }
8985
8986 /**
8987 * @hide
8988 */
8989 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008990 Uri data = getData();
8991 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008992 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008993 }
8994 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008995 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008996 }
8997 String action = getAction();
8998 if (ACTION_SEND.equals(action)) {
8999 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9000 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009001 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009002 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009003 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009004 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9005 if (streams != null) {
9006 ArrayList<Uri> newStreams = new ArrayList<Uri>();
9007 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009008 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009009 }
9010 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
9011 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009012 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9013 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9014 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9015 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9016 if (output != null) {
9017 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9018 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009019 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009020 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009021
9022 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009023 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009024 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9025 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009026 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009027 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009028 * @hide
9029 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009030 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009031 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009032 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009033
9034 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009035 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009036
9037 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009038 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009039 // Inspect contained intents to see if we need to migrate extras. We
9040 // don't promote ClipData to the parent, since ChooserActivity will
9041 // already start the picked item as the caller, and we can't combine
9042 // the flags in a safe way.
9043
9044 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009045 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009046 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9047 if (intent != null) {
9048 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009049 }
9050 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009051 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009052 try {
9053 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9054 if (intents != null) {
9055 for (int i = 0; i < intents.length; i++) {
9056 final Intent intent = (Intent) intents[i];
9057 if (intent != null) {
9058 migrated |= intent.migrateExtraStreamToClipData();
9059 }
9060 }
9061 }
9062 } catch (ClassCastException e) {
9063 }
9064 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009065
9066 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009067 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009068 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9069 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9070 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9071 if (stream != null || text != null || htmlText != null) {
9072 final ClipData clipData = new ClipData(
9073 null, new String[] { getType() },
9074 new ClipData.Item(text, htmlText, null, stream));
9075 setClipData(clipData);
9076 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009077 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009078 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009079 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009080 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009081
9082 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009083 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009084 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9085 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9086 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9087 int num = -1;
9088 if (streams != null) {
9089 num = streams.size();
9090 }
9091 if (texts != null) {
9092 if (num >= 0 && num != texts.size()) {
9093 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009094 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009095 }
9096 num = texts.size();
9097 }
9098 if (htmlTexts != null) {
9099 if (num >= 0 && num != htmlTexts.size()) {
9100 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009101 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009102 }
9103 num = htmlTexts.size();
9104 }
9105 if (num > 0) {
9106 final ClipData clipData = new ClipData(
9107 null, new String[] { getType() },
9108 makeClipItem(streams, texts, htmlTexts, 0));
9109
9110 for (int i = 1; i < num; i++) {
9111 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9112 }
9113
9114 setClipData(clipData);
9115 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009116 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009117 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009118 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009119 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009120 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9121 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9122 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9123 final Uri output;
9124 try {
9125 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9126 } catch (ClassCastException e) {
9127 return false;
9128 }
9129 if (output != null) {
9130 setClipData(ClipData.newRawUri("", output));
9131 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9132 return true;
9133 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009134 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009135
9136 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009137 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009138
9139 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9140 ArrayList<String> htmlTexts, int which) {
9141 Uri uri = streams != null ? streams.get(which) : null;
9142 CharSequence text = texts != null ? texts.get(which) : null;
9143 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9144 return new ClipData.Item(text, htmlText, null, uri);
9145 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009146
9147 /** @hide */
9148 public boolean isDocument() {
9149 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9150 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009151}