blob: ee469dabcf437413f045219dfdf69528077e899e [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
Dianne Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Adam Powell2ed547e2015-04-29 18:45:04 -070020import android.os.ResultReceiver;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080021import android.os.ShellCommand;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010022import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070023import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070024
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070025import org.xmlpull.v1.XmlPullParser;
26import org.xmlpull.v1.XmlPullParserException;
27
Tor Norbye7b9c9122013-05-30 16:48:33 -070028import android.annotation.AnyRes;
Tor Norbyed9273d62013-05-30 15:59:53 -070029import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070031import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.annotation.SdkConstant.SdkConstantType;
33import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070034
Nicolas Prevotd85fc722014-04-16 19:52:08 +010035import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070036
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.content.pm.PackageManager;
38import android.content.pm.ResolveInfo;
39import android.content.res.Resources;
40import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080041import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042import android.net.Uri;
43import android.os.Bundle;
Felipe Lemec7b1f892016-01-15 15:02:31 -080044import android.os.Environment;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070045import android.os.IBinder;
46import android.os.Parcel;
47import android.os.Parcelable;
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +000048import android.os.Process;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070049import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010050import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070051import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070052import android.provider.DocumentsProvider;
53import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import android.util.AttributeSet;
55import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080056
57import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070058
Craig Mautner21d24a22014-04-23 11:45:37 -070059import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060
61import java.io.IOException;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080062import java.io.PrintWriter;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070063import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070064import java.lang.annotation.Retention;
65import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070066import java.net.URISyntaxException;
67import java.util.ArrayList;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -080068import java.util.HashSet;
Dianne Hackborn221ea892013-08-04 16:50:16 -070069import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080070import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070071import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070072import java.util.Set;
73
74/**
75 * An intent is an abstract description of an operation to be performed. It
76 * can be used with {@link Context#startActivity(Intent) startActivity} to
77 * launch an {@link android.app.Activity},
78 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
79 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
80 * and {@link android.content.Context#startService} or
81 * {@link android.content.Context#bindService} to communicate with a
82 * background {@link android.app.Service}.
83 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070084 * <p>An Intent provides a facility for performing late runtime binding between the code in
85 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070086 * can be thought of as the glue between activities. It is basically a passive data structure
87 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070088 *
89 * <div class="special reference">
90 * <h3>Developer Guides</h3>
91 * <p>For information about how to create and resolve intents, read the
92 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
93 * developer guide.</p>
94 * </div>
95 *
96 * <a name="IntentStructure"></a>
97 * <h3>Intent Structure</h3>
98 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070099 *
100 * <ul>
101 * <li> <p><b>action</b> -- The general action to be performed, such as
102 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
103 * etc.</p>
104 * </li>
105 * <li> <p><b>data</b> -- The data to operate on, such as a person record
106 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
107 * </li>
108 * </ul>
109 *
110 *
111 * <p>Some examples of action/data pairs are:</p>
112 *
113 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * information about the person whose identifier is "1".</p>
116 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * the phone dialer with the person filled in.</p>
119 * </li>
120 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
121 * the phone dialer with the given number filled in. Note how the
122 * VIEW action does what what is considered the most reasonable thing for
123 * a particular URI.</p>
124 * </li>
125 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
126 * the phone dialer with the given number filled in.</p>
127 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700128 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700129 * information about the person whose identifier is "1".</p>
130 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700131 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700132 * a list of people, which the user can browse through. This example is a
133 * typical top-level entry into the Contacts application, showing you the
134 * list of people. Selecting a particular person to view would result in a
135 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
136 * being used to start an activity to display that person.</p>
137 * </li>
138 * </ul>
139 *
140 * <p>In addition to these primary attributes, there are a number of secondary
141 * attributes that you can also include with an intent:</p>
142 *
143 * <ul>
144 * <li> <p><b>category</b> -- Gives additional information about the action
145 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
146 * appear in the Launcher as a top-level application, while
147 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
148 * of alternative actions the user can perform on a piece of data.</p>
149 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
150 * intent data. Normally the type is inferred from the data itself.
151 * By setting this attribute, you disable that evaluation and force
152 * an explicit type.</p>
153 * <li> <p><b>component</b> -- Specifies an explicit name of a component
154 * class to use for the intent. Normally this is determined by looking
155 * at the other information in the intent (the action, data/type, and
156 * categories) and matching that with a component that can handle it.
157 * If this attribute is set then none of the evaluation is performed,
158 * and this component is used exactly as is. By specifying this attribute,
159 * all of the other Intent attributes become optional.</p>
160 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
161 * This can be used to provide extended information to the component.
162 * For example, if we have a action to send an e-mail message, we could
163 * also include extra pieces of data here to supply a subject, body,
164 * etc.</p>
165 * </ul>
166 *
167 * <p>Here are some examples of other operations you can specify as intents
168 * using these additional parameters:</p>
169 *
170 * <ul>
171 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
172 * Launch the home screen.</p>
173 * </li>
174 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
175 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
176 * vnd.android.cursor.item/phone}</i></b>
177 * -- Display the list of people's phone numbers, allowing the user to
178 * browse through them and pick one and return it to the parent activity.</p>
179 * </li>
180 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
181 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
182 * -- Display all pickers for data that can be opened with
183 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
184 * allowing the user to pick one of them and then some data inside of it
185 * and returning the resulting URI to the caller. This can be used,
186 * for example, in an e-mail application to allow the user to pick some
187 * data to include as an attachment.</p>
188 * </li>
189 * </ul>
190 *
191 * <p>There are a variety of standard Intent action and category constants
192 * defined in the Intent class, but applications can also define their own.
193 * These strings use java style scoping, to ensure they are unique -- for
194 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700195 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700196 *
197 * <p>Put together, the set of actions, data types, categories, and extra data
198 * defines a language for the system allowing for the expression of phrases
199 * such as "call john smith's cell". As applications are added to the system,
200 * they can extend this language by adding new actions, types, and categories, or
201 * they can modify the behavior of existing phrases by supplying their own
202 * activities that handle them.</p>
203 *
204 * <a name="IntentResolution"></a>
205 * <h3>Intent Resolution</h3>
206 *
207 * <p>There are two primary forms of intents you will use.
208 *
209 * <ul>
210 * <li> <p><b>Explicit Intents</b> have specified a component (via
211 * {@link #setComponent} or {@link #setClass}), which provides the exact
212 * class to be run. Often these will not include any other information,
213 * simply being a way for an application to launch various internal
214 * activities it has as the user interacts with the application.
215 *
216 * <li> <p><b>Implicit Intents</b> have not specified a component;
217 * instead, they must include enough information for the system to
218 * determine which of the available components is best to run for that
219 * intent.
220 * </ul>
221 *
222 * <p>When using implicit intents, given such an arbitrary intent we need to
223 * know what to do with it. This is handled by the process of <em>Intent
224 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
225 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
226 * more activities/receivers) that can handle it.</p>
227 *
228 * <p>The intent resolution mechanism basically revolves around matching an
229 * Intent against all of the &lt;intent-filter&gt; descriptions in the
230 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
231 * objects explicitly registered with {@link Context#registerReceiver}.) More
232 * details on this can be found in the documentation on the {@link
233 * IntentFilter} class.</p>
234 *
235 * <p>There are three pieces of information in the Intent that are used for
236 * resolution: the action, type, and category. Using this information, a query
237 * is done on the {@link PackageManager} for a component that can handle the
238 * intent. The appropriate component is determined based on the intent
239 * information supplied in the <code>AndroidManifest.xml</code> file as
240 * follows:</p>
241 *
242 * <ul>
243 * <li> <p>The <b>action</b>, if given, must be listed by the component as
244 * one it handles.</p>
245 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
246 * already supplied in the Intent. Like the action, if a type is
247 * included in the intent (either explicitly or implicitly in its
248 * data), then this must be listed by the component as one it handles.</p>
249 * <li> For data that is not a <code>content:</code> URI and where no explicit
250 * type is included in the Intent, instead the <b>scheme</b> of the
251 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
252 * considered. Again like the action, if we are matching a scheme it
253 * must be listed by the component as one it can handle.
254 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
255 * by the activity as categories it handles. That is, if you include
256 * the categories {@link #CATEGORY_LAUNCHER} and
257 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
258 * with an intent that lists <em>both</em> of those categories.
259 * Activities will very often need to support the
260 * {@link #CATEGORY_DEFAULT} so that they can be found by
261 * {@link Context#startActivity Context.startActivity()}.</p>
262 * </ul>
263 *
264 * <p>For example, consider the Note Pad sample application that
265 * allows user to browse through a list of notes data and view details about
266 * individual items. Text in italics indicate places were you would replace a
267 * name with one specific to your own package.</p>
268 *
269 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
270 * package="<i>com.android.notepad</i>"&gt;
271 * &lt;application android:icon="@drawable/app_notes"
272 * android:label="@string/app_name"&gt;
273 *
274 * &lt;provider class=".NotePadProvider"
275 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
276 *
277 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
278 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="android.intent.action.MAIN" /&gt;
280 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700281 * &lt;/intent-filter&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.VIEW" /&gt;
284 * &lt;action android:name="android.intent.action.EDIT" /&gt;
285 * &lt;action android:name="android.intent.action.PICK" /&gt;
286 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
287 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700293 * &lt;/intent-filter&gt;
294 * &lt;/activity&gt;
295 *
296 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
297 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="android.intent.action.VIEW" /&gt;
299 * &lt;action android:name="android.intent.action.EDIT" /&gt;
300 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
301 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700302 * &lt;/intent-filter&gt;
303 *
304 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700305 * &lt;action android:name="android.intent.action.INSERT" /&gt;
306 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
307 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700308 * &lt;/intent-filter&gt;
309 *
310 * &lt;/activity&gt;
311 *
312 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
313 * android:theme="@android:style/Theme.Dialog"&gt;
314 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700315 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
316 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
317 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
318 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
319 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700320 * &lt;/intent-filter&gt;
321 * &lt;/activity&gt;
322 *
323 * &lt;/application&gt;
324 * &lt;/manifest&gt;</pre>
325 *
326 * <p>The first activity,
327 * <code>com.android.notepad.NotesList</code>, serves as our main
328 * entry into the app. It can do three things as described by its three intent
329 * templates:
330 * <ol>
331 * <li><pre>
332 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700333 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
334 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700335 * &lt;/intent-filter&gt;</pre>
336 * <p>This provides a top-level entry into the NotePad application: the standard
337 * MAIN action is a main entry point (not requiring any other information in
338 * the Intent), and the LAUNCHER category says that this entry point should be
339 * listed in the application launcher.</p>
340 * <li><pre>
341 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700342 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
343 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
344 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
345 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
346 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700347 * &lt;/intent-filter&gt;</pre>
348 * <p>This declares the things that the activity can do on a directory of
349 * notes. The type being supported is given with the &lt;type&gt; tag, where
350 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
351 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
352 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
353 * The activity allows the user to view or edit the directory of data (via
354 * the VIEW and EDIT actions), or to pick a particular note and return it
355 * to the caller (via the PICK action). Note also the DEFAULT category
356 * supplied here: this is <em>required</em> for the
357 * {@link Context#startActivity Context.startActivity} method to resolve your
358 * activity when its component name is not explicitly specified.</p>
359 * <li><pre>
360 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700361 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
362 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
363 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700364 * &lt;/intent-filter&gt;</pre>
365 * <p>This filter describes the ability return to the caller a note selected by
366 * the user without needing to know where it came from. The data type
367 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
368 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
369 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
370 * The GET_CONTENT action is similar to the PICK action, where the activity
371 * will return to its caller a piece of data selected by the user. Here,
372 * however, the caller specifies the type of data they desire instead of
373 * the type of data the user will be picking from.</p>
374 * </ol>
375 *
376 * <p>Given these capabilities, the following intents will resolve to the
377 * NotesList activity:</p>
378 *
379 * <ul>
380 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
381 * activities that can be used as top-level entry points into an
382 * application.</p>
383 * <li> <p><b>{ action=android.app.action.MAIN,
384 * category=android.app.category.LAUNCHER }</b> is the actual intent
385 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700386 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700387 * data=content://com.google.provider.NotePad/notes }</b>
388 * displays a list of all the notes under
389 * "content://com.google.provider.NotePad/notes", which
390 * the user can browse through and see the details on.</p>
391 * <li> <p><b>{ action=android.app.action.PICK
392 * data=content://com.google.provider.NotePad/notes }</b>
393 * provides a list of the notes under
394 * "content://com.google.provider.NotePad/notes", from which
395 * the user can pick a note whose data URL is returned back to the caller.</p>
396 * <li> <p><b>{ action=android.app.action.GET_CONTENT
397 * type=vnd.android.cursor.item/vnd.google.note }</b>
398 * is similar to the pick action, but allows the caller to specify the
399 * kind of data they want back so that the system can find the appropriate
400 * activity to pick something of that data type.</p>
401 * </ul>
402 *
403 * <p>The second activity,
404 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
405 * note entry and allows them to edit it. It can do two things as described
406 * by its two intent templates:
407 * <ol>
408 * <li><pre>
409 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700410 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
411 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
412 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
413 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * &lt;/intent-filter&gt;</pre>
415 * <p>The first, primary, purpose of this activity is to let the user interact
416 * with a single note, as decribed by the MIME type
417 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
418 * either VIEW a note or allow the user to EDIT it. Again we support the
419 * DEFAULT category to allow the activity to be launched without explicitly
420 * specifying its component.</p>
421 * <li><pre>
422 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700423 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
424 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
425 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700426 * &lt;/intent-filter&gt;</pre>
427 * <p>The secondary use of this activity is to insert a new note entry into
428 * an existing directory of notes. This is used when the user creates a new
429 * note: the INSERT action is executed on the directory of notes, causing
430 * this activity to run and have the user create the new note data which
431 * it then adds to the content provider.</p>
432 * </ol>
433 *
434 * <p>Given these capabilities, the following intents will resolve to the
435 * NoteEditor activity:</p>
436 *
437 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700438 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700439 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
440 * shows the user the content of note <var>{ID}</var>.</p>
441 * <li> <p><b>{ action=android.app.action.EDIT
442 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
443 * allows the user to edit the content of note <var>{ID}</var>.</p>
444 * <li> <p><b>{ action=android.app.action.INSERT
445 * data=content://com.google.provider.NotePad/notes }</b>
446 * creates a new, empty note in the notes list at
447 * "content://com.google.provider.NotePad/notes"
448 * and allows the user to edit it. If they keep their changes, the URI
449 * of the newly created note is returned to the caller.</p>
450 * </ul>
451 *
452 * <p>The last activity,
453 * <code>com.android.notepad.TitleEditor</code>, allows the user to
454 * edit the title of a note. This could be implemented as a class that the
455 * application directly invokes (by explicitly setting its component in
456 * the Intent), but here we show a way you can publish alternative
457 * operations on existing data:</p>
458 *
459 * <pre>
460 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700461 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
462 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
463 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
464 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
465 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700466 * &lt;/intent-filter&gt;</pre>
467 *
468 * <p>In the single intent template here, we
469 * have created our own private action called
470 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
471 * edit the title of a note. It must be invoked on a specific note
472 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
473 * view and edit actions, but here displays and edits the title contained
474 * in the note data.
475 *
476 * <p>In addition to supporting the default category as usual, our title editor
477 * also supports two other standard categories: ALTERNATIVE and
478 * SELECTED_ALTERNATIVE. Implementing
479 * these categories allows others to find the special action it provides
480 * without directly knowing about it, through the
481 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
482 * more often to build dynamic menu items with
483 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
484 * template here was also supply an explicit name for the template
485 * (via <code>android:label="@string/resolve_title"</code>) to better control
486 * what the user sees when presented with this activity as an alternative
487 * action to the data they are viewing.
488 *
489 * <p>Given these capabilities, the following intent will resolve to the
490 * TitleEditor activity:</p>
491 *
492 * <ul>
493 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
494 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
495 * displays and allows the user to edit the title associated
496 * with note <var>{ID}</var>.</p>
497 * </ul>
498 *
499 * <h3>Standard Activity Actions</h3>
500 *
501 * <p>These are the current standard actions that Intent defines for launching
502 * activities (usually through {@link Context#startActivity}. The most
503 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
504 * {@link #ACTION_EDIT}.
505 *
506 * <ul>
507 * <li> {@link #ACTION_MAIN}
508 * <li> {@link #ACTION_VIEW}
509 * <li> {@link #ACTION_ATTACH_DATA}
510 * <li> {@link #ACTION_EDIT}
511 * <li> {@link #ACTION_PICK}
512 * <li> {@link #ACTION_CHOOSER}
513 * <li> {@link #ACTION_GET_CONTENT}
514 * <li> {@link #ACTION_DIAL}
515 * <li> {@link #ACTION_CALL}
516 * <li> {@link #ACTION_SEND}
517 * <li> {@link #ACTION_SENDTO}
518 * <li> {@link #ACTION_ANSWER}
519 * <li> {@link #ACTION_INSERT}
520 * <li> {@link #ACTION_DELETE}
521 * <li> {@link #ACTION_RUN}
522 * <li> {@link #ACTION_SYNC}
523 * <li> {@link #ACTION_PICK_ACTIVITY}
524 * <li> {@link #ACTION_SEARCH}
525 * <li> {@link #ACTION_WEB_SEARCH}
526 * <li> {@link #ACTION_FACTORY_TEST}
527 * </ul>
528 *
529 * <h3>Standard Broadcast Actions</h3>
530 *
531 * <p>These are the current standard actions that Intent defines for receiving
532 * broadcasts (usually through {@link Context#registerReceiver} or a
533 * &lt;receiver&gt; tag in a manifest).
534 *
535 * <ul>
536 * <li> {@link #ACTION_TIME_TICK}
537 * <li> {@link #ACTION_TIME_CHANGED}
538 * <li> {@link #ACTION_TIMEZONE_CHANGED}
539 * <li> {@link #ACTION_BOOT_COMPLETED}
540 * <li> {@link #ACTION_PACKAGE_ADDED}
541 * <li> {@link #ACTION_PACKAGE_CHANGED}
542 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800543 * <li> {@link #ACTION_PACKAGE_RESTARTED}
544 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +0000545 * <li> {@link #ACTION_PACKAGES_SUSPENDED}
546 * <li> {@link #ACTION_PACKAGES_UNSUSPENDED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700547 * <li> {@link #ACTION_UID_REMOVED}
548 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700549 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700550 * <li> {@link #ACTION_POWER_DISCONNECTED}
551 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * </ul>
553 *
554 * <h3>Standard Categories</h3>
555 *
556 * <p>These are the current standard categories that can be used to further
557 * clarify an Intent via {@link #addCategory}.
558 *
559 * <ul>
560 * <li> {@link #CATEGORY_DEFAULT}
561 * <li> {@link #CATEGORY_BROWSABLE}
562 * <li> {@link #CATEGORY_TAB}
563 * <li> {@link #CATEGORY_ALTERNATIVE}
564 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
565 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800566 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * <li> {@link #CATEGORY_HOME}
568 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700569 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400570 * <li> {@link #CATEGORY_CAR_DOCK}
571 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500572 * <li> {@link #CATEGORY_LE_DESK_DOCK}
573 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200574 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700575 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700576 * </ul>
577 *
578 * <h3>Standard Extra Data</h3>
579 *
580 * <p>These are the current standard fields that can be used as extra data via
581 * {@link #putExtra}.
582 *
583 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_ALARM_COUNT}
585 * <li> {@link #EXTRA_BCC}
586 * <li> {@link #EXTRA_CC}
587 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
588 * <li> {@link #EXTRA_DATA_REMOVED}
589 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500590 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
591 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_DOCK_STATE_CAR}
593 * <li> {@link #EXTRA_DOCK_STATE_DESK}
594 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
595 * <li> {@link #EXTRA_DONT_KILL_APP}
596 * <li> {@link #EXTRA_EMAIL}
597 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800599 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700600 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800601 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700602 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800603 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
604 * <li> {@link #EXTRA_REPLACING}
605 * <li> {@link #EXTRA_SHORTCUT_ICON}
606 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
607 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800609 * <li> {@link #EXTRA_SHORTCUT_NAME}
610 * <li> {@link #EXTRA_SUBJECT}
611 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800613 * <li> {@link #EXTRA_TITLE}
614 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700615 * </ul>
616 *
617 * <h3>Flags</h3>
618 *
619 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800620 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
621 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800623public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700624 private static final String ATTR_ACTION = "action";
625 private static final String TAG_CATEGORIES = "categories";
626 private static final String ATTR_CATEGORY = "category";
627 private static final String TAG_EXTRA = "extra";
628 private static final String ATTR_TYPE = "type";
629 private static final String ATTR_COMPONENT = "component";
630 private static final String ATTR_DATA = "data";
631 private static final String ATTR_FLAGS = "flags";
632
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 // ---------------------------------------------------------------------
634 // ---------------------------------------------------------------------
635 // Standard intent activity actions (see action variable).
636
637 /**
638 * Activity Action: Start as a main entry point, does not expect to
639 * receive data.
640 * <p>Input: nothing
641 * <p>Output: nothing
642 */
643 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
644 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800645
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700646 /**
647 * Activity Action: Display the data to the user. This is the most common
648 * action performed on data -- it is the generic action you can use on
649 * a piece of data to get the most reasonable thing to occur. For example,
650 * when used on a contacts entry it will view the entry; when used on a
651 * mailto: URI it will bring up a compose window filled with the information
652 * supplied by the URI; when used with a tel: URI it will invoke the
653 * dialer.
654 * <p>Input: {@link #getData} is URI from which to retrieve data.
655 * <p>Output: nothing.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
662 * performed on a piece of data.
663 */
664 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800665
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700666 /**
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +0900667 * Activity Action: Quick view the data. Launches a quick viewer for
668 * a URI or a list of URIs.
669 * <p>Input: {@link #getData} is a mandatory content URI of the item to
670 * preview. {@link #getClipData} contains an optional list of content URIs
671 * if there is more than one item to preview. {@link #EXTRA_INDEX} is an
672 * optional index of the URI in the clip data to show first.
Steve McKayc78bcb82015-07-31 14:35:22 -0700673 * <p>Output: nothing.
Steve McKayc78bcb82015-07-31 14:35:22 -0700674 */
675 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
676 public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW";
677
678 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700679 * Used to indicate that some piece of data should be attached to some other
680 * place. For example, image data could be attached to a contact. It is up
681 * to the recipient to decide where the data should be attached; the intent
682 * does not specify the ultimate destination.
683 * <p>Input: {@link #getData} is URI of data to be attached.
684 * <p>Output: nothing.
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700689 /**
690 * Activity Action: Provide explicit editable access to the given data.
691 * <p>Input: {@link #getData} is URI of data to be edited.
692 * <p>Output: nothing.
693 */
694 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
695 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800696
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700697 /**
698 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
699 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
700 * The extras can contain type specific data to pass through to the editing/creating
701 * activity.
702 * <p>Output: The URI of the item that was picked. This must be a content:
703 * URI so that any receiver can access it.
704 */
705 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
706 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700708 /**
709 * Activity Action: Pick an item from the data, returning what was selected.
710 * <p>Input: {@link #getData} is URI containing a directory of data
711 * (vnd.android.cursor.dir/*) from which to pick an item.
712 * <p>Output: The URI of the item that was picked.
713 */
714 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
715 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700717 /**
718 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 * <p>Output: An Intent representing the shortcut. The intent must contain three
721 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
722 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800723 * (value: ShortcutIconResource).</p>
724 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700725 * @see #EXTRA_SHORTCUT_INTENT
726 * @see #EXTRA_SHORTCUT_NAME
727 * @see #EXTRA_SHORTCUT_ICON
728 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
729 * @see android.content.Intent.ShortcutIconResource
730 */
731 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
732 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
733
734 /**
735 * The name of the extra used to define the Intent of a shortcut.
736 *
737 * @see #ACTION_CREATE_SHORTCUT
738 */
739 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
740 /**
741 * The name of the extra used to define the name of a shortcut.
742 *
743 * @see #ACTION_CREATE_SHORTCUT
744 */
745 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
746 /**
747 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
748 *
749 * @see #ACTION_CREATE_SHORTCUT
750 */
751 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
752 /**
753 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
754 *
755 * @see #ACTION_CREATE_SHORTCUT
756 * @see android.content.Intent.ShortcutIconResource
757 */
758 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
759 "android.intent.extra.shortcut.ICON_RESOURCE";
760
761 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800762 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700763 *
764 * @see Intent#ACTION_CREATE_SHORTCUT
765 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800766 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
767 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700768 */
769 public static class ShortcutIconResource implements Parcelable {
770 /**
771 * The package name of the application containing the icon.
772 */
773 public String packageName;
774
775 /**
776 * The resource name of the icon, including package, name and type.
777 */
778 public String resourceName;
779
780 /**
781 * Creates a new ShortcutIconResource for the specified context and resource
782 * identifier.
783 *
784 * @param context The context of the application.
Tor Norbye7b9c9122013-05-30 16:48:33 -0700785 * @param resourceId The resource identifier for the icon.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700786 * @return A new ShortcutIconResource with the specified's context package name
Tor Norbye7b9c9122013-05-30 16:48:33 -0700787 * and icon resource identifier.``
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700788 */
Tor Norbye7b9c9122013-05-30 16:48:33 -0700789 public static ShortcutIconResource fromContext(Context context, @AnyRes int resourceId) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700790 ShortcutIconResource icon = new ShortcutIconResource();
791 icon.packageName = context.getPackageName();
792 icon.resourceName = context.getResources().getResourceName(resourceId);
793 return icon;
794 }
795
796 /**
797 * Used to read a ShortcutIconResource from a Parcel.
798 */
799 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
800 new Parcelable.Creator<ShortcutIconResource>() {
801
802 public ShortcutIconResource createFromParcel(Parcel source) {
803 ShortcutIconResource icon = new ShortcutIconResource();
804 icon.packageName = source.readString();
805 icon.resourceName = source.readString();
806 return icon;
807 }
808
809 public ShortcutIconResource[] newArray(int size) {
810 return new ShortcutIconResource[size];
811 }
812 };
813
814 /**
815 * No special parcel contents.
816 */
817 public int describeContents() {
818 return 0;
819 }
820
821 public void writeToParcel(Parcel dest, int flags) {
822 dest.writeString(packageName);
823 dest.writeString(resourceName);
824 }
825
826 @Override
827 public String toString() {
828 return resourceName;
829 }
830 }
831
832 /**
833 * Activity Action: Display an activity chooser, allowing the user to pick
834 * what they want to before proceeding. This can be used as an alternative
835 * to the standard activity picker that is displayed by the system when
836 * you try to start an activity with multiple possible matches, with these
837 * differences in behavior:
838 * <ul>
839 * <li>You can specify the title that will appear in the activity chooser.
840 * <li>The user does not have the option to make one of the matching
841 * activities a preferred activity, and all possible activities will
842 * always be shown even if one of them is currently marked as the
843 * preferred activity.
844 * </ul>
845 * <p>
846 * This action should be used when the user will naturally expect to
847 * select an activity in order to proceed. An example if when not to use
848 * it is when the user clicks on a "mailto:" link. They would naturally
849 * expect to go directly to their mail app, so startActivity() should be
850 * called directly: it will
851 * either launch the current preferred app, or put up a dialog allowing the
852 * user to pick an app to use and optionally marking that as preferred.
853 * <p>
854 * In contrast, if the user is selecting a menu item to send a picture
855 * they are viewing to someone else, there are many different things they
856 * may want to do at this point: send it through e-mail, upload it to a
857 * web service, etc. In this case the CHOOSER action should be used, to
858 * always present to the user a list of the things they can do, with a
859 * nice title given by the caller such as "Send this photo with:".
860 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700861 * If you need to grant URI permissions through a chooser, you must specify
862 * the permissions to be granted on the ACTION_CHOOSER Intent
863 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
864 * {@link #setClipData} to specify the URIs to be granted as well as
865 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
866 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
867 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700868 * As a convenience, an Intent of this form can be created with the
869 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700870 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700871 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700872 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
873 * and can optionally have a {@link #EXTRA_TITLE} field containing the
874 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700875 * <p>
876 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700877 */
878 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
879 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
880
881 /**
882 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
883 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700884 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
885 * target intent, also optionally supplying a title. If the target
886 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
887 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
888 * set in the returned chooser intent, with its ClipData set appropriately:
889 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500890 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700891 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * @param target The Intent that the user will be selecting an activity
893 * to perform.
894 * @param title Optional title that will be displayed in the chooser.
895 * @return Return a new Intent object that you can hand to
896 * {@link Context#startActivity(Intent) Context.startActivity()} and
897 * related methods.
898 */
899 public static Intent createChooser(Intent target, CharSequence title) {
Adam Powell0b3c1122014-10-09 12:50:14 -0700900 return createChooser(target, title, null);
901 }
902
903 /**
904 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
905 *
906 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
907 * target intent, also optionally supplying a title. If the target
908 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
909 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
910 * set in the returned chooser intent, with its ClipData set appropriately:
911 * either a direct reflection of {@link #getClipData()} if that is non-null,
912 * or a new ClipData built from {@link #getData()}.</p>
913 *
914 * <p>The caller may optionally supply an {@link IntentSender} to receive a callback
915 * when the user makes a choice. This can be useful if the calling application wants
916 * to remember the last chosen target and surface it as a more prominent or one-touch
917 * affordance elsewhere in the UI for next time.</p>
918 *
919 * @param target The Intent that the user will be selecting an activity
920 * to perform.
921 * @param title Optional title that will be displayed in the chooser.
922 * @param sender Optional IntentSender to be called when a choice is made.
923 * @return Return a new Intent object that you can hand to
924 * {@link Context#startActivity(Intent) Context.startActivity()} and
925 * related methods.
926 */
927 public static Intent createChooser(Intent target, CharSequence title, IntentSender sender) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700928 Intent intent = new Intent(ACTION_CHOOSER);
929 intent.putExtra(EXTRA_INTENT, target);
930 if (title != null) {
931 intent.putExtra(EXTRA_TITLE, title);
932 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700933
Adam Powell0b3c1122014-10-09 12:50:14 -0700934 if (sender != null) {
935 intent.putExtra(EXTRA_CHOSEN_COMPONENT_INTENT_SENDER, sender);
936 }
937
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700938 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700939 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
940 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
941 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700942 if (permFlags != 0) {
943 ClipData targetClipData = target.getClipData();
944 if (targetClipData == null && target.getData() != null) {
945 ClipData.Item item = new ClipData.Item(target.getData());
946 String[] mimeTypes;
947 if (target.getType() != null) {
948 mimeTypes = new String[] { target.getType() };
949 } else {
950 mimeTypes = new String[] { };
951 }
952 targetClipData = new ClipData(null, mimeTypes, item);
953 }
954 if (targetClipData != null) {
955 intent.setClipData(targetClipData);
956 intent.addFlags(permFlags);
957 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700958 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700959
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700960 return intent;
961 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700962
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700963 /**
964 * Activity Action: Allow the user to select a particular kind of data and
965 * return it. This is different than {@link #ACTION_PICK} in that here we
966 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800967 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700968 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900969 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700970 * etc.
971 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900972 * 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 -0700973 * of data, such as a person contact, you set the MIME type to the kind of
974 * data you want and launch it with {@link Context#startActivity(Intent)}.
975 * The system will then launch the best application to select that kind
976 * of data for you.
977 * <p>
978 * You may also be interested in any of a set of types of content the user
979 * can pick. For example, an e-mail application that wants to allow the
980 * user to add an attachment to an e-mail message can use this action to
981 * bring up a list of all of the types of content the user can attach.
982 * <p>
983 * In this case, you should wrap the GET_CONTENT intent with a chooser
984 * (through {@link #createChooser}), which will give the proper interface
985 * for the user to pick how to send your data and allow you to specify
986 * a prompt indicating what they are doing. You will usually specify a
987 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
988 * broad range of content types the user can select from.
989 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900990 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700991 * only pick from data that can be represented as a stream. This is
992 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
993 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800994 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900995 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800996 * is locally available on the device. For example, if this extra is set
997 * to true then an image picker should not show any pictures that are available
998 * from a remote server but not already on the local device (thus requiring
999 * they be downloaded when opened).
1000 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001001 * If the caller can handle multiple returned items (the user performing
1002 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
1003 * to indicate this.
1004 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001005 * Input: {@link #getType} is the desired MIME type to retrieve. Note
1006 * that no URI is supplied in the intent, as there are no constraints on
1007 * where the returned data originally comes from. You may also include the
1008 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08001009 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08001010 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
1011 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001012 * <p>
1013 * Output: The URI of the item that was picked. This must be a content:
1014 * URI so that any receiver can access it.
1015 */
1016 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1017 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
1018 /**
1019 * Activity Action: Dial a number as specified by the data. This shows a
1020 * UI with the number being dialed, allowing the user to explicitly
1021 * initiate the call.
1022 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1023 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1024 * number.
1025 * <p>Output: nothing.
1026 */
1027 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1028 public static final String ACTION_DIAL = "android.intent.action.DIAL";
1029 /**
1030 * Activity Action: Perform a call to someone specified by the data.
1031 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
1032 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
1033 * number.
1034 * <p>Output: nothing.
1035 *
1036 * <p>Note: there will be restrictions on which applications can initiate a
1037 * call; most applications should use the {@link #ACTION_DIAL}.
1038 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
1039 * numbers. Applications can <strong>dial</strong> emergency numbers using
1040 * {@link #ACTION_DIAL}, however.
Svetoslav7008b512015-06-24 18:47:07 -07001041 *
Dianne Hackborn0e3de6c2015-07-29 15:20:21 -07001042 * <p>Note: if you app targets {@link android.os.Build.VERSION_CODES#M M}
Svetoslav7008b512015-06-24 18:47:07 -07001043 * and above and declares as using the {@link android.Manifest.permission#CALL_PHONE}
Svet Ganov7121e182015-07-13 22:38:12 -07001044 * permission which is not granted, then attempting to use this action will
Svetoslav7008b512015-06-24 18:47:07 -07001045 * result in a {@link java.lang.SecurityException}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_CALL = "android.intent.action.CALL";
1049 /**
1050 * Activity Action: Perform a call to an emergency number specified by the
1051 * data.
1052 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1053 * tel: URI of an explicit phone number.
1054 * <p>Output: nothing.
1055 * @hide
1056 */
1057 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1058 /**
1059 * Activity action: Perform a call to any number (emergency or not)
1060 * specified by the data.
1061 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1062 * tel: URI of an explicit phone number.
1063 * <p>Output: nothing.
1064 * @hide
1065 */
1066 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1067 /**
Santos Cordon15a13782015-03-31 18:32:31 -07001068 * Activity action: Activate the current SIM card. If SIM cards do not require activation,
1069 * sending this intent is a no-op.
1070 * <p>Input: No data should be specified. get*Extra may have an optional
1071 * {@link #EXTRA_SIM_ACTIVATION_RESPONSE} field containing a PendingIntent through which to
1072 * send the activation result.
1073 * <p>Output: nothing.
1074 * @hide
1075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_SIM_ACTIVATION_REQUEST =
1078 "android.intent.action.SIM_ACTIVATION_REQUEST";
1079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001080 * Activity Action: Send a message to someone specified by the data.
1081 * <p>Input: {@link #getData} is URI describing the target.
1082 * <p>Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1086 /**
1087 * Activity Action: Deliver some data to someone else. Who the data is
1088 * being delivered to is not specified; it is up to the receiver of this
1089 * action to ask the user where the data should be sent.
1090 * <p>
1091 * When launching a SEND intent, you should usually wrap it in a chooser
1092 * (through {@link #createChooser}), which will give the proper interface
1093 * for the user to pick how to send your data and allow you to specify
1094 * a prompt indicating what they are doing.
1095 * <p>
1096 * Input: {@link #getType} is the MIME type of the data being sent.
1097 * get*Extra can have either a {@link #EXTRA_TEXT}
1098 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1099 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1100 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1101 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001102 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1103 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1104 * your text with HTML formatting.
1105 * <p>
1106 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1107 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1108 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1109 * content: URIs and other advanced features of {@link ClipData}. If
1110 * using this approach, you still must supply the same data through the
1111 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1112 * for compatibility with old applications. If you don't set a ClipData,
1113 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001114 * <p>
1115 * Optional standard extras, which may be interpreted by some recipients as
1116 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1117 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1118 * <p>
1119 * Output: nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_SEND = "android.intent.action.SEND";
1123 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001124 * Activity Action: Deliver multiple data to someone else.
1125 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001126 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001127 * <p>
1128 * Input: {@link #getType} is the MIME type of the data being sent.
1129 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001130 * #EXTRA_STREAM} field, containing the data to be sent. If using
1131 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1132 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001133 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001134 * Multiple types are supported, and receivers should handle mixed types
1135 * whenever possible. The right way for the receiver to check them is to
1136 * use the content resolver on each URI. The intent sender should try to
1137 * put the most concrete mime type in the intent type, but it can fall
1138 * back to {@literal <type>/*} or {@literal *}/* as needed.
1139 * <p>
1140 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1141 * be image/jpg, but if you are sending image/jpg and image/png, then the
1142 * intent's type should be image/*.
1143 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001144 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1145 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1146 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1147 * content: URIs and other advanced features of {@link ClipData}. If
1148 * using this approach, you still must supply the same data through the
1149 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1150 * for compatibility with old applications. If you don't set a ClipData,
1151 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1152 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001153 * Optional standard extras, which may be interpreted by some recipients as
1154 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1155 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1156 * <p>
1157 * Output: nothing.
1158 */
1159 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1160 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1161 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001162 * Activity Action: Handle an incoming phone call.
1163 * <p>Input: nothing.
1164 * <p>Output: nothing.
1165 */
1166 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1167 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1168 /**
1169 * Activity Action: Insert an empty item into the given container.
1170 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1171 * in which to place the data.
1172 * <p>Output: URI of the new data that was created.
1173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1176 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001177 * Activity Action: Create a new item in the given container, initializing it
1178 * from the current contents of the clipboard.
1179 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1180 * in which to place the data.
1181 * <p>Output: URI of the new data that was created.
1182 */
1183 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1184 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1185 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001186 * Activity Action: Delete the given data from its container.
1187 * <p>Input: {@link #getData} is URI of data to be deleted.
1188 * <p>Output: nothing.
1189 */
1190 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1191 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1192 /**
1193 * Activity Action: Run the data, whatever that means.
1194 * <p>Input: ? (Note: this is currently specific to the test harness.)
1195 * <p>Output: nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_RUN = "android.intent.action.RUN";
1199 /**
1200 * Activity Action: Perform a data synchronization.
1201 * <p>Input: ?
1202 * <p>Output: ?
1203 */
1204 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1205 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1206 /**
1207 * Activity Action: Pick an activity given an intent, returning the class
1208 * selected.
1209 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1210 * used with {@link PackageManager#queryIntentActivities} to determine the
1211 * set of activities from which to pick.
1212 * <p>Output: Class name of the activity that was selected.
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1216 /**
1217 * Activity Action: Perform a search.
1218 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1219 * is the text to search for. If empty, simply
1220 * enter your search results Activity with the search UI activated.
1221 * <p>Output: nothing.
1222 */
1223 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1224 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1225 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001226 * Activity Action: Start the platform-defined tutorial
1227 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1228 * is the text to search for. If empty, simply
1229 * enter your search results Activity with the search UI activated.
1230 * <p>Output: nothing.
1231 */
1232 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1233 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1234 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001235 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001236 * <p>
1237 * Input: {@link android.app.SearchManager#QUERY
1238 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1239 * a url starts with http or https, the site will be opened. If it is plain
1240 * text, Google search will be applied.
1241 * <p>
1242 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001246
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001247 /**
Jim Miller07994402012-05-02 14:22:27 -07001248 * Activity Action: Perform assist action.
1249 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001250 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1251 * additional optional contextual information about where the user was when they
Dianne Hackborna3acdb32015-06-08 17:07:40 -07001252 * requested the assist; {@link #EXTRA_REFERRER} may be set with additional referrer
1253 * information.
Jim Miller07994402012-05-02 14:22:27 -07001254 * Output: nothing.
1255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001258
1259 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001260 * Activity Action: Perform voice assist action.
1261 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001262 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1263 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001264 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001265 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001266 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1270
1271 /**
Adam Skory7140a252013-09-11 12:04:58 +01001272 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1273 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001274 */
1275 public static final String EXTRA_ASSIST_PACKAGE
1276 = "android.intent.extra.ASSIST_PACKAGE";
1277
1278 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07001279 * An optional field on {@link #ACTION_ASSIST} containing the uid of the current foreground
1280 * application package at the time the assist was invoked.
1281 */
1282 public static final String EXTRA_ASSIST_UID
1283 = "android.intent.extra.ASSIST_UID";
1284
1285 /**
Adam Skory7140a252013-09-11 12:04:58 +01001286 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1287 * information supplied by the current foreground app at the time of the assist request.
1288 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001289 */
1290 public static final String EXTRA_ASSIST_CONTEXT
1291 = "android.intent.extra.ASSIST_CONTEXT";
1292
Jim Miller07994402012-05-02 14:22:27 -07001293 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001294 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1295 * keyboard as the primary input device for assistance.
1296 */
1297 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1298 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1299
1300 /**
Tim Kilbourn0e5f1102015-06-05 16:18:09 -07001301 * An optional field on {@link #ACTION_ASSIST} containing the InputDevice id
1302 * that was used to invoke the assist.
1303 */
1304 public static final String EXTRA_ASSIST_INPUT_DEVICE_ID =
1305 "android.intent.extra.ASSIST_INPUT_DEVICE_ID";
1306
1307 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001308 * Activity Action: List all available applications
1309 * <p>Input: Nothing.
1310 * <p>Output: nothing.
1311 */
1312 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1313 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1314 /**
1315 * Activity Action: Show settings for choosing wallpaper
1316 * <p>Input: Nothing.
1317 * <p>Output: Nothing.
1318 */
1319 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1320 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1321
1322 /**
1323 * Activity Action: Show activity for reporting a bug.
1324 * <p>Input: Nothing.
1325 * <p>Output: Nothing.
1326 */
1327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1328 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1329
1330 /**
1331 * Activity Action: Main entry point for factory tests. Only used when
1332 * the device is booting in factory test node. The implementing package
1333 * must be installed in the system image.
1334 * <p>Input: nothing
1335 * <p>Output: nothing
1336 */
1337 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1338
1339 /**
1340 * Activity Action: The user pressed the "call" button to go to the dialer
1341 * or other appropriate UI for placing a call.
1342 * <p>Input: Nothing.
1343 * <p>Output: Nothing.
1344 */
1345 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1346 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1347
1348 /**
1349 * Activity Action: Start Voice Command.
1350 * <p>Input: Nothing.
1351 * <p>Output: Nothing.
1352 */
1353 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1354 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001355
1356 /**
1357 * Activity Action: Start action associated with long pressing on the
1358 * search key.
1359 * <p>Input: Nothing.
1360 * <p>Output: Nothing.
1361 */
1362 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1363 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001364
Jacek Surazski86b6c532009-05-13 14:38:28 +02001365 /**
1366 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1367 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001368 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001369 * <p>Input: No data is specified. The bug report is passed in using
1370 * an {@link #EXTRA_BUG_REPORT} field.
1371 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001372 *
1373 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001374 */
1375 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1376 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001377
1378 /**
1379 * Activity Action: Show power usage information to the user.
1380 * <p>Input: Nothing.
1381 * <p>Output: Nothing.
1382 */
1383 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1384 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001385
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001386 /**
1387 * Activity Action: Setup wizard to launch after a platform update. This
1388 * activity should have a string meta-data field associated with it,
1389 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1390 * the platform for setup. The activity will be launched only if
1391 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1392 * same value.
1393 * <p>Input: Nothing.
1394 * <p>Output: Nothing.
1395 * @hide
1396 */
1397 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1398 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001399
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001400 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001401 * Activity Action: Show settings for managing network data usage of a
1402 * specific application. Applications should define an activity that offers
1403 * options to control data usage.
1404 */
1405 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1406 public static final String ACTION_MANAGE_NETWORK_USAGE =
1407 "android.intent.action.MANAGE_NETWORK_USAGE";
1408
1409 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001410 * Activity Action: Launch application installer.
1411 * <p>
1412 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001413 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1414 * you can also use "package:<package-name>" to install an application for the
1415 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001416 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1417 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1418 * <p>
1419 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1420 * succeeded.
Svet Ganov86877e42015-05-28 08:19:48 -07001421 * <p>
1422 * <strong>Note:</strong>If your app is targeting API level higher than 22 you
1423 * need to hold {@link android.Manifest.permission#REQUEST_INSTALL_PACKAGES}
1424 * in order to launch the application installer.
1425 * </p>
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001426 *
1427 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1428 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1429 * @see #EXTRA_RETURN_RESULT
1430 */
1431 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1432 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1433
1434 /**
Todd Kennedyb8a279e2015-11-18 09:59:47 -08001435 * Activity Action: Launch ephemeral installer.
1436 * <p>
1437 * Input: The data must be a http: URI that the ephemeral application is registered
1438 * to handle.
1439 * <p class="note">
1440 * This is a protected intent that can only be sent by the system.
1441 * </p>
1442 *
1443 * @hide
1444 */
1445 @SystemApi
1446 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1447 public static final String ACTION_INSTALL_EPHEMERAL_PACKAGE
1448 = "android.intent.action.INSTALL_EPHEMERAL_PACKAGE";
1449
1450 /**
1451 * Service Action: Resolve ephemeral application.
1452 * <p>
1453 * The system will have a persistent connection to this service.
1454 * This is a protected intent that can only be sent by the system.
1455 * </p>
1456 *
1457 * @hide
1458 */
1459 @SystemApi
1460 @SdkConstant(SdkConstantType.SERVICE_ACTION)
1461 public static final String ACTION_RESOLVE_EPHEMERAL_PACKAGE
1462 = "android.intent.action.RESOLVE_EPHEMERAL_PACKAGE";
1463
1464 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001465 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1466 * package. Specifies the installer package name; this package will receive the
1467 * {@link #ACTION_APP_ERROR} intent.
1468 */
1469 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1470 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1471
1472 /**
1473 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1474 * package. Specifies that the application being installed should not be
1475 * treated as coming from an unknown source, but as coming from the app
1476 * invoking the Intent. For this to work you must start the installer with
1477 * startActivityForResult().
1478 */
1479 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1480 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1481
1482 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001483 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1484 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001485 * data field originated from.
1486 */
rich cannings706e8ba2012-08-20 13:20:14 -07001487 public static final String EXTRA_ORIGINATING_URI
1488 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001489
1490 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001491 * This extra can be used with any Intent used to launch an activity, supplying information
1492 * about who is launching that activity. This field contains a {@link android.net.Uri}
1493 * object, typically an http: or https: URI of the web site that the referral came from;
1494 * it can also use the {@link #URI_ANDROID_APP_SCHEME android-app:} scheme to identify
1495 * a native application that it came from.
1496 *
1497 * <p>To retrieve this value in a client, use {@link android.app.Activity#getReferrer}
1498 * instead of directly retrieving the extra. It is also valid for applications to
1499 * instead supply {@link #EXTRA_REFERRER_NAME} for cases where they can only create
1500 * a string, not a Uri; the field here, if supplied, will always take precedence,
1501 * however.</p>
1502 *
1503 * @see #EXTRA_REFERRER_NAME
rich cannings368ed012012-06-07 15:37:57 -07001504 */
1505 public static final String EXTRA_REFERRER
1506 = "android.intent.extra.REFERRER";
1507
1508 /**
Dianne Hackborn85d558c2014-11-04 10:31:54 -08001509 * Alternate version of {@link #EXTRA_REFERRER} that supplies the URI as a String rather
1510 * than a {@link android.net.Uri} object. Only for use in cases where Uri objects can
1511 * not be created, in particular when Intent extras are supplied through the
1512 * {@link #URI_INTENT_SCHEME intent:} or {@link #URI_ANDROID_APP_SCHEME android-app:}
1513 * schemes.
1514 *
1515 * @see #EXTRA_REFERRER
1516 */
1517 public static final String EXTRA_REFERRER_NAME
1518 = "android.intent.extra.REFERRER_NAME";
1519
1520 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001521 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1522 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1523 * @hide
1524 */
1525 public static final String EXTRA_ORIGINATING_UID
1526 = "android.intent.extra.ORIGINATING_UID";
1527
1528 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001529 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1530 * package. Tells the installer UI to skip the confirmation with the user
1531 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001532 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1533 * will no longer show an interstitial message about updating existing
1534 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001535 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001536 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001537 public static final String EXTRA_ALLOW_REPLACE
1538 = "android.intent.extra.ALLOW_REPLACE";
1539
1540 /**
1541 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1542 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1543 * return to the application the result code of the install/uninstall. The returned result
1544 * code will be {@link android.app.Activity#RESULT_OK} on success or
1545 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1546 */
1547 public static final String EXTRA_RETURN_RESULT
1548 = "android.intent.extra.RETURN_RESULT";
1549
1550 /**
1551 * Package manager install result code. @hide because result codes are not
1552 * yet ready to be exposed.
1553 */
1554 public static final String EXTRA_INSTALL_RESULT
1555 = "android.intent.extra.INSTALL_RESULT";
1556
1557 /**
1558 * Activity Action: Launch application uninstaller.
1559 * <p>
1560 * Input: The data must be a package: URI whose scheme specific part is
1561 * the package name of the current installed package to be uninstalled.
1562 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1563 * <p>
1564 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1565 * succeeded.
1566 */
1567 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1568 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1569
1570 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001571 * Specify whether the package should be uninstalled for all users.
1572 * @hide because these should not be part of normal application flow.
1573 */
1574 public static final String EXTRA_UNINSTALL_ALL_USERS
1575 = "android.intent.extra.UNINSTALL_ALL_USERS";
1576
1577 /**
Suprabh Shukla74a2fe42016-01-27 12:57:24 -08001578 * Specified when the uninstall confirmation dialog is not required to be shown.
1579 * Use with {@link #ACTION_UNINSTALL_PACKAGE}
1580 * @hide
1581 */
1582 public static final String EXTRA_SKIP_UNINSTALL_CONFIRMATION =
1583 "android.intent.extra.SKIP_UNINSTALL_CONFIRMATION";
1584
1585 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001586 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1587 * describing the last run version of the platform that was setup.
1588 * @hide
1589 */
1590 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1591
Svet Ganov3695b8a2015-03-24 16:30:25 -07001592 /**
1593 * Activity action: Launch UI to manage the permissions of an app.
1594 * <p>
1595 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose permissions
1596 * will be managed by the launched UI.
1597 * </p>
1598 * <p>
1599 * Output: Nothing.
1600 * </p>
1601 *
1602 * @see #EXTRA_PACKAGE_NAME
1603 *
1604 * @hide
1605 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001606 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1607 public static final String ACTION_MANAGE_APP_PERMISSIONS =
1608 "android.intent.action.MANAGE_APP_PERMISSIONS";
1609
1610 /**
Svet Ganov321f0152015-05-16 22:51:50 -07001611 * Activity action: Launch UI to manage permissions.
1612 * <p>
1613 * Input: Nothing.
1614 * </p>
1615 * <p>
1616 * Output: Nothing.
1617 * </p>
1618 *
1619 * @hide
1620 */
Svet Ganov321f0152015-05-16 22:51:50 -07001621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1622 public static final String ACTION_MANAGE_PERMISSIONS =
1623 "android.intent.action.MANAGE_PERMISSIONS";
1624
1625 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001626 * Activity action: Launch UI to review permissions for an app.
1627 * The system uses this intent if permission review for apps not
1628 * supporting the new runtime permissions model is enabled. In
1629 * this mode a permission review is required before any of the
1630 * app components can run.
1631 * <p>
1632 * Input: {@link #EXTRA_PACKAGE_NAME} specifies the package whose
1633 * permissions will be reviewed (mandatory).
1634 * </p>
1635 * <p>
1636 * Input: {@link #EXTRA_INTENT} specifies a pending intent to
1637 * be fired after the permission review (optional).
1638 * </p>
1639 * <p>
1640 * Input: {@link #EXTRA_REMOTE_CALLBACK} specifies a callback to
1641 * be invoked after the permission review (optional).
1642 * </p>
1643 * <p>
1644 * Input: {@link #EXTRA_RESULT_NEEDED} specifies whether the intent
1645 * passed via {@link #EXTRA_INTENT} needs a result (optional).
1646 * </p>
1647 * <p>
1648 * Output: Nothing.
1649 * </p>
1650 *
1651 * @see #EXTRA_PACKAGE_NAME
1652 * @see #EXTRA_INTENT
1653 * @see #EXTRA_REMOTE_CALLBACK
1654 * @see #EXTRA_RESULT_NEEDED
1655 *
1656 * @hide
1657 */
1658 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1659 public static final String ACTION_REVIEW_PERMISSIONS =
1660 "android.intent.action.REVIEW_PERMISSIONS";
1661
1662 /**
1663 * Intent extra: A callback for reporting remote result as a bundle.
1664 * <p>
1665 * Type: IRemoteCallback
1666 * </p>
1667 *
1668 * @hide
1669 */
1670 public static final String EXTRA_REMOTE_CALLBACK = "android.intent.extra.REMOTE_CALLBACK";
1671
1672 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001673 * Intent extra: An app package name.
1674 * <p>
1675 * Type: String
Svet Ganov0b316702015-05-23 13:25:11 -07001676 * </p>
Svet Ganov3695b8a2015-03-24 16:30:25 -07001677 *
1678 * @hide
1679 */
1680 @SystemApi
1681 public static final String EXTRA_PACKAGE_NAME = "android.intent.extra.PACKAGE_NAME";
1682
1683 /**
Svet Ganov9c165d72015-12-01 19:52:26 -08001684 * Intent extra: An extra for specifying whether a result is needed.
1685 * <p>
1686 * Type: boolean
1687 * </p>
1688 *
1689 * @hide
1690 */
1691 public static final String EXTRA_RESULT_NEEDED = "android.intent.extra.RESULT_NEEDED";
1692
1693 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001694 * Broadcast action that requests current permission granted information. It will respond
1695 * to the request by sending a broadcast with action defined by
1696 * {@link #EXTRA_GET_PERMISSIONS_RESPONSE_INTENT}. The response will contain
Makoto Onukibbb912a2015-06-05 16:27:23 -07001697 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}, as well as
1698 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}, with contents described below or
1699 * a null upon failure.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001700 *
Makoto Onukibbb912a2015-06-05 16:27:23 -07001701 * <p>If {@link #EXTRA_PACKAGE_NAME} is included then the number of permissions granted, the
1702 * number of permissions requested and the number of granted additional permissions
1703 * by that package will be calculated and included as the first
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001704 * and second elements respectively of an int[] in the response as
Makoto Onukibbb912a2015-06-05 16:27:23 -07001705 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}. The response will also deliver the list
1706 * of localized permission group names that are granted in
1707 * {@link #EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT}.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001708 *
1709 * <p>If {@link #EXTRA_PACKAGE_NAME} is not included then the number of apps granted any runtime
1710 * permissions and the total number of apps requesting runtime permissions will be the first
1711 * and second elements respectively of an int[] in the response as
1712 * {@link #EXTRA_GET_PERMISSIONS_COUNT_RESULT}.
1713 *
1714 * @hide
1715 */
1716 public static final String ACTION_GET_PERMISSIONS_COUNT
1717 = "android.intent.action.GET_PERMISSIONS_COUNT";
1718
1719 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001720 * Broadcast action that requests list of all apps that have runtime permissions. It will
1721 * respond to the request by sending a broadcast with action defined by
1722 * {@link #EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT}. The response will contain
1723 * {@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT}, as well as
1724 * {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}, with contents described below or
1725 * a null upon failure.
1726 *
1727 * <p>{@link #EXTRA_GET_PERMISSIONS_APP_LIST_RESULT} will contain a list of package names of
1728 * apps that have runtime permissions. {@link #EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT}
1729 * will contain the list of app labels corresponding ot the apps in the first list.
1730 *
1731 * @hide
1732 */
1733 public static final String ACTION_GET_PERMISSIONS_PACKAGES
1734 = "android.intent.action.GET_PERMISSIONS_PACKAGES";
1735
1736 /**
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001737 * Extra included in response to {@link #ACTION_GET_PERMISSIONS_COUNT}.
1738 * @hide
1739 */
1740 public static final String EXTRA_GET_PERMISSIONS_COUNT_RESULT
1741 = "android.intent.extra.GET_PERMISSIONS_COUNT_RESULT";
1742
1743 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001744 * List of CharSequence of localized permission group labels.
1745 * @hide
1746 */
1747 public static final String EXTRA_GET_PERMISSIONS_GROUP_LIST_RESULT
1748 = "android.intent.extra.GET_PERMISSIONS_GROUP_LIST_RESULT";
1749
1750 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001751 * String list of apps that have one or more runtime permissions.
1752 * @hide
1753 */
1754 public static final String EXTRA_GET_PERMISSIONS_APP_LIST_RESULT
1755 = "android.intent.extra.GET_PERMISSIONS_APP_LIST_RESULT";
1756
1757 /**
1758 * String list of app labels for apps that have one or more runtime permissions.
1759 * @hide
1760 */
1761 public static final String EXTRA_GET_PERMISSIONS_APP_LABEL_LIST_RESULT
1762 = "android.intent.extra.GET_PERMISSIONS_APP_LABEL_LIST_RESULT";
1763
1764 /**
Anthony Hugh3575a402015-10-26 17:47:05 -07001765 * Boolean list describing if the app is a system app for apps that have one or more runtime
1766 * permissions.
1767 * @hide
1768 */
1769 public static final String EXTRA_GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT
1770 = "android.intent.extra.GET_PERMISSIONS_IS_SYSTEM_APP_LIST_RESULT";
1771
1772 /**
Makoto Onukibbb912a2015-06-05 16:27:23 -07001773 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_COUNT} broadcasts.
Jason Monk9cfa0cc2015-05-22 14:50:21 -04001774 * @hide
1775 */
1776 public static final String EXTRA_GET_PERMISSIONS_RESPONSE_INTENT
1777 = "android.intent.extra.GET_PERMISSIONS_RESONSE_INTENT";
1778
1779 /**
Vinod Krishnan61665cc2015-08-31 19:30:20 -07001780 * Required extra to be sent with {@link #ACTION_GET_PERMISSIONS_PACKAGES} broadcasts.
1781 * @hide
1782 */
1783 public static final String EXTRA_GET_PERMISSIONS_PACKAGES_RESPONSE_INTENT
1784 = "android.intent.extra.GET_PERMISSIONS_PACKAGES_RESONSE_INTENT";
1785
1786 /**
Svet Ganov3695b8a2015-03-24 16:30:25 -07001787 * Activity action: Launch UI to manage which apps have a given permission.
1788 * <p>
1789 * Input: {@link #EXTRA_PERMISSION_NAME} specifies the permission access
1790 * to which will be managed by the launched UI.
1791 * </p>
1792 * <p>
1793 * Output: Nothing.
1794 * </p>
1795 *
1796 * @see #EXTRA_PERMISSION_NAME
1797 *
1798 * @hide
1799 */
Svet Ganov3695b8a2015-03-24 16:30:25 -07001800 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1801 public static final String ACTION_MANAGE_PERMISSION_APPS =
1802 "android.intent.action.MANAGE_PERMISSION_APPS";
1803
1804 /**
1805 * Intent extra: The name of a permission.
1806 * <p>
1807 * Type: String
1808 * </p>
1809 *
1810 * @hide
1811 */
1812 @SystemApi
1813 public static final String EXTRA_PERMISSION_NAME = "android.intent.extra.PERMISSION_NAME";
1814
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001815 // ---------------------------------------------------------------------
1816 // ---------------------------------------------------------------------
1817 // Standard intent broadcast actions (see action variable).
1818
1819 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001820 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1821 * <p>
1822 * For historical reasons, the name of this broadcast action refers to the power
1823 * state of the screen but it is actually sent in response to changes in the
1824 * overall interactive state of the device.
1825 * </p><p>
1826 * This broadcast is sent when the device becomes non-interactive which may have
1827 * nothing to do with the screen turning off. To determine the
1828 * actual state of the screen, use {@link android.view.Display#getState}.
1829 * </p><p>
1830 * See {@link android.os.PowerManager#isInteractive} for details.
1831 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001832 * You <em>cannot</em> receive this through components declared in
1833 * manifests, only by explicitly registering for it with
1834 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1835 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001836 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001837 * <p class="note">This is a protected intent that can only be sent
1838 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001839 */
1840 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1841 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001842
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001844 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1845 * <p>
1846 * For historical reasons, the name of this broadcast action refers to the power
1847 * state of the screen but it is actually sent in response to changes in the
1848 * overall interactive state of the device.
1849 * </p><p>
1850 * This broadcast is sent when the device becomes interactive which may have
1851 * nothing to do with the screen turning on. To determine the
1852 * actual state of the screen, use {@link android.view.Display#getState}.
1853 * </p><p>
1854 * See {@link android.os.PowerManager#isInteractive} for details.
1855 * </p>
Casey Hodbf6785c2015-03-17 15:59:39 -07001856 * You <em>cannot</em> receive this through components declared in
1857 * manifests, only by explicitly registering for it with
1858 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1859 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001860 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001861 * <p class="note">This is a protected intent that can only be sent
1862 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001866
1867 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001868 * Broadcast Action: Sent after the system stops dreaming.
1869 *
1870 * <p class="note">This is a protected intent that can only be sent by the system.
1871 * It is only sent to registered receivers.</p>
1872 */
1873 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1874 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1875
1876 /**
1877 * Broadcast Action: Sent after the system starts dreaming.
1878 *
1879 * <p class="note">This is a protected intent that can only be sent by the system.
1880 * It is only sent to registered receivers.</p>
1881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1884
1885 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001886 * 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 -07001887 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001888 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001889 * <p class="note">This is a protected intent that can only be sent
1890 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001891 */
1892 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001893 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001894
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001895 /**
1896 * Broadcast Action: The current time has changed. Sent every
Casey Hodbf6785c2015-03-17 15:59:39 -07001897 * minute. You <em>cannot</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001898 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001899 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1900 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001901 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001902 * <p class="note">This is a protected intent that can only be sent
1903 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 */
1905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1906 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1907 /**
1908 * Broadcast Action: The time was set.
1909 */
1910 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1911 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1912 /**
1913 * Broadcast Action: The date has changed.
1914 */
1915 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1916 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1917 /**
1918 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1919 * <ul>
1920 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1921 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001922 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001923 * <p class="note">This is a protected intent that can only be sent
1924 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001925 */
1926 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1927 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1928 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001929 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1930 * DNS entries should be tossed.
1931 * @hide
1932 */
1933 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1934 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1935 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001936 * Alarm Changed Action: This is broadcast when the AlarmClock
1937 * application's alarm is set or unset. It is used by the
1938 * AlarmClock application and the StatusBar service.
1939 * @hide
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001943
1944 /**
1945 * Broadcast Action: This is broadcast once, after the system has finished
1946 * booting and the user is in a "locked" state. A user is locked when their
1947 * credential-encrypted private app data storage is unavailable. Once the
1948 * user has entered their credentials (such as a lock pattern or PIN) for
1949 * the first time, the {@link #ACTION_BOOT_COMPLETED} broadcast will be
1950 * sent.
1951 * <p>
1952 * You must hold the
1953 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission in
1954 * order to receive this broadcast.
1955 * <p class="note">
1956 * This is a protected intent that can only be sent by the system.
1957 */
1958 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1959 public static final String ACTION_LOCKED_BOOT_COMPLETED = "android.intent.action.LOCKED_BOOT_COMPLETED";
1960
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001961 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 * Broadcast Action: This is broadcast once, after the system has finished
1963 * booting. It can be used to perform application-specific initialization,
1964 * such as installing alarms. You must hold the
1965 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1966 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001967 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001968 * <p class="note">This is a protected intent that can only be sent
1969 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001970 */
1971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1972 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
Jeff Sharkeybedbaa92015-12-02 16:42:25 -07001973
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 /**
1975 * Broadcast Action: This is broadcast when a user action should request a
1976 * temporary system dialog to dismiss. Some examples of temporary system
1977 * dialogs are the notification window-shade and the recent tasks dialog.
1978 */
1979 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1980 /**
1981 * Broadcast Action: Trigger the download and eventual installation
1982 * of a package.
1983 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001984 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001985 * <p class="note">This is a protected intent that can only be sent
1986 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001987 *
1988 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001989 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001990 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1992 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1993 /**
1994 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001995 * device. The data contains the name of the package. Note that the
1996 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001997 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001998 * <ul>
1999 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2000 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
2001 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
2002 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002003 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002004 * <p class="note">This is a protected intent that can only be sent
2005 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
2009 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002010 * Broadcast Action: A new version of an application package has been
2011 * installed, replacing an existing version that was previously installed.
2012 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07002013 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002014 * <ul>
2015 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
2016 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002017 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002018 * <p class="note">This is a protected intent that can only be sent
2019 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
2023 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002024 * Broadcast Action: A new version of your application has been installed
2025 * over an existing one. This is only sent to the application that was
2026 * replaced. It does not contain any additional data; to receive it, just
2027 * use an intent filter for this action.
2028 *
2029 * <p class="note">This is a protected intent that can only be sent
2030 * by the system.
2031 */
2032 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2033 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
2034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 * Broadcast Action: An existing application package has been removed from
2036 * the device. The data contains the name of the package. The package
2037 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 * <ul>
2039 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2040 * to the package.
2041 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
2042 * application -- data and code -- is being removed.
2043 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
2044 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
2045 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002046 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002047 * <p class="note">This is a protected intent that can only be sent
2048 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002049 */
2050 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2051 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
2052 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07002053 * Broadcast Action: An existing application package has been completely
2054 * removed from the device. The data contains the name of the package.
2055 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
2056 * {@link #EXTRA_DATA_REMOVED} is true and
2057 * {@link #EXTRA_REPLACING} is false of that broadcast.
2058 *
2059 * <ul>
2060 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
2061 * to the package.
2062 * </ul>
2063 *
2064 * <p class="note">This is a protected intent that can only be sent
2065 * by the system.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_PACKAGE_FULLY_REMOVED
2069 = "android.intent.action.PACKAGE_FULLY_REMOVED";
2070 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002071 * Broadcast Action: An existing application package has been changed (e.g.
2072 * a component has been enabled or disabled). The data contains the name of
2073 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002074 * <ul>
2075 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002076 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08002077 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002078 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
2079 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002080 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002081 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002082 * <p class="note">This is a protected intent that can only be sent
2083 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
2087 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002088 * @hide
2089 * Broadcast Action: Ask system services if there is any reason to
2090 * restart the given package. The data contains the name of the
2091 * package.
2092 * <ul>
2093 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2094 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
2095 * </ul>
2096 *
2097 * <p class="note">This is a protected intent that can only be sent
2098 * by the system.
2099 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08002100 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002101 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2102 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
2103 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002104 * Broadcast Action: The user has restarted a package, and all of its
2105 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002106 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002107 * be removed. Note that the restarted package does <em>not</em>
2108 * receive this broadcast.
2109 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002110 * <ul>
2111 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2112 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002113 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002114 * <p class="note">This is a protected intent that can only be sent
2115 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116 */
2117 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2118 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
2119 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002120 * Broadcast Action: The user has cleared the data of a package. This should
2121 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07002122 * its persistent data is erased and this broadcast sent.
2123 * Note that the cleared package does <em>not</em>
2124 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002125 * <ul>
2126 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
2127 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002128 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002129 * <p class="note">This is a protected intent that can only be sent
2130 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002131 */
2132 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2133 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
2134 /**
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00002135 * Broadcast Action: Packages have been suspended.
2136 * <p>Includes the following extras:
2137 * <ul>
2138 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been suspended
2139 * </ul>
2140 *
2141 * <p class="note">This is a protected intent that can only be sent
2142 * by the system. It is only sent to registered receivers.
2143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PACKAGES_SUSPENDED = "android.intent.action.PACKAGES_SUSPENDED";
2146 /**
2147 * Broadcast Action: Packages have been unsuspended.
2148 * <p>Includes the following extras:
2149 * <ul>
2150 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages which have been unsuspended
2151 * </ul>
2152 *
2153 * <p class="note">This is a protected intent that can only be sent
2154 * by the system. It is only sent to registered receivers.
2155 */
2156 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2157 public static final String ACTION_PACKAGES_UNSUSPENDED = "android.intent.action.PACKAGES_UNSUSPENDED";
2158 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002159 * Broadcast Action: A user ID has been removed from the system. The user
2160 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08002161 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002162 * <p class="note">This is a protected intent that can only be sent
2163 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2166 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002167
2168 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08002169 * Broadcast Action: Sent to the installer package of an application
2170 * when that application is first launched (that is the first time it
2171 * is moved out of the stopped state). The data contains the name of the package.
2172 *
2173 * <p class="note">This is a protected intent that can only be sent
2174 * by the system.
2175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
2178
2179 /**
Kenny Root5ab21572011-07-27 11:11:19 -07002180 * Broadcast Action: Sent to the system package verifier when a package
2181 * needs to be verified. The data contains the package URI.
2182 * <p class="note">
2183 * This is a protected intent that can only be sent by the system.
2184 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07002185 */
2186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2187 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
2188
2189 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07002190 * Broadcast Action: Sent to the system package verifier when a package is
2191 * verified. The data contains the package URI.
2192 * <p class="note">
2193 * This is a protected intent that can only be sent by the system.
2194 */
2195 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2196 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
2197
2198 /**
Fabrice Di Meglio1c1b4712014-11-19 17:12:32 -08002199 * Broadcast Action: Sent to the system intent filter verifier when an intent filter
2200 * needs to be verified. The data contains the filter data hosts to be verified against.
2201 * <p class="note">
2202 * This is a protected intent that can only be sent by the system.
2203 * </p>
2204 *
2205 * @hide
2206 */
2207 @SystemApi
2208 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2209 public static final String ACTION_INTENT_FILTER_NEEDS_VERIFICATION = "android.intent.action.INTENT_FILTER_NEEDS_VERIFICATION";
2210
2211 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002212 * Broadcast Action: Resources for a set of packages (which were
2213 * previously unavailable) are currently
2214 * available since the media on which they exist is available.
2215 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2216 * list of packages whose availability changed.
2217 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2218 * list of uids of packages whose availability changed.
2219 * Note that the
2220 * packages in this list do <em>not</em> receive this broadcast.
2221 * The specified set of packages are now available on the system.
2222 * <p>Includes the following extras:
2223 * <ul>
2224 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2225 * whose resources(were previously unavailable) are currently available.
2226 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
2227 * packages whose resources(were previously unavailable)
2228 * are currently available.
2229 * </ul>
2230 *
2231 * <p class="note">This is a protected intent that can only be sent
2232 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002235 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
2236 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002237
2238 /**
2239 * Broadcast Action: Resources for a set of packages are currently
2240 * unavailable since the media on which they exist is unavailable.
2241 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
2242 * list of packages whose availability changed.
2243 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
2244 * list of uids of packages whose availability changed.
2245 * The specified set of packages can no longer be
2246 * launched and are practically unavailable on the system.
2247 * <p>Inclues the following extras:
2248 * <ul>
2249 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
2250 * whose resources are no longer available.
2251 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
2252 * whose resources are no longer available.
2253 * </ul>
2254 *
2255 * <p class="note">This is a protected intent that can only be sent
2256 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002257 */
2258 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002259 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05002260 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002261
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002262 /**
2263 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07002264 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002265 * This should <em>only</em> be used to determine when the wallpaper
2266 * has changed to show the new wallpaper to the user. You should certainly
2267 * never, in response to this, change the wallpaper or other attributes of
2268 * it such as the suggested size. That would be crazy, right? You'd cause
2269 * all kinds of loops, especially if other apps are doing similar things,
2270 * right? Of course. So please don't do this.
2271 *
2272 * @deprecated Modern applications should use
2273 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
2274 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
2275 * shown behind their UI, rather than watching for this broadcast and
2276 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002277 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07002278 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002279 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
2280 /**
2281 * Broadcast Action: The current device {@link android.content.res.Configuration}
2282 * (orientation, locale, etc) has changed. When such a change happens, the
2283 * UIs (view hierarchy) will need to be rebuilt based on this new
2284 * information; for the most part, applications don't need to worry about
2285 * this, because the system will take care of stopping and restarting the
2286 * application to make sure it sees the new changes. Some system code that
2287 * can not be restarted will need to watch for this action and handle it
2288 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08002289 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002290 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002291 * You <em>cannot</em> receive this through components declared
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002292 * in manifests, only by explicitly registering for it with
2293 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2294 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08002295 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002296 * <p class="note">This is a protected intent that can only be sent
2297 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 *
2299 * @see android.content.res.Configuration
2300 */
2301 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2302 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
2303 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002304 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08002305 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08002306 * <p class="note">This is a protected intent that can only be sent
2307 * by the system.
2308 */
2309 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2310 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
2311 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002312 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
2313 * charging state, level, and other information about the battery.
2314 * See {@link android.os.BatteryManager} for documentation on the
2315 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07002316 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002317 * <p class="note">
Casey Hodbf6785c2015-03-17 15:59:39 -07002318 * You <em>cannot</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07002319 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002320 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07002321 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
2322 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
2323 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
2324 * broadcasts that are sent and can be received through manifest
2325 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08002326 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002327 * <p class="note">This is a protected intent that can only be sent
2328 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002329 */
2330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2331 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
2332 /**
2333 * Broadcast Action: Indicates low battery condition on the device.
2334 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08002335 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002336 * <p class="note">This is a protected intent that can only be sent
2337 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002338 */
2339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2340 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
2341 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002342 * Broadcast Action: Indicates the battery is now okay after being low.
2343 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
2344 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08002345 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002346 * <p class="note">This is a protected intent that can only be sent
2347 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07002348 */
2349 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2350 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
2351 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002352 * Broadcast Action: External power has been connected to the device.
2353 * This is intended for applications that wish to register specifically to this notification.
2354 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2355 * stay active to receive this notification. This action can be used to implement actions
2356 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002357 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002358 * <p class="note">This is a protected intent that can only be sent
2359 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002360 */
2361 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002362 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002363 /**
2364 * Broadcast Action: External power has been removed from the device.
2365 * This is intended for applications that wish to register specifically to this notification.
2366 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
2367 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07002368 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08002369 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002370 * <p class="note">This is a protected intent that can only be sent
2371 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002372 */
2373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07002374 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002375 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07002376 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07002377 * Broadcast Action: Device is shutting down.
2378 * This is broadcast when the device is being shut down (completely turned
2379 * off, not sleeping). Once the broadcast is complete, the final shutdown
2380 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07002381 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08002382 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002383 * <p class="note">This is a protected intent that can only be sent
2384 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07002385 * <p>May include the following extras:
2386 * <ul>
2387 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
2388 * shutdown is only for userspace processes. If not set, assumed to be false.
2389 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07002390 */
2391 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07002392 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07002393 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002394 * Activity Action: Start this activity to request system shutdown.
2395 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
Yusuke Sato705ffd12015-07-21 15:52:11 -07002396 * to request confirmation from the user before shutting down. The optional boolean
2397 * extra field {@link #EXTRA_USER_REQUESTED_SHUTDOWN} can be set to true to
2398 * indicate that the shutdown is requested by the user.
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002399 *
2400 * <p class="note">This is a protected intent that can only be sent
2401 * by the system.
2402 *
2403 * {@hide}
2404 */
2405 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
2406 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07002407 * Broadcast Action: A sticky broadcast that indicates low memory
2408 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08002409 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002410 * <p class="note">This is a protected intent that can only be sent
2411 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002412 */
2413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2414 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
2415 /**
2416 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08002417 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002418 * <p class="note">This is a protected intent that can only be sent
2419 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002420 */
2421 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2422 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
2423 /**
Jake Hambybb371632010-08-23 18:16:48 -07002424 * Broadcast Action: A sticky broadcast that indicates a memory full
2425 * condition on the device. This is intended for activities that want
2426 * to be able to fill the data partition completely, leaving only
2427 * enough free space to prevent system-wide SQLite failures.
2428 *
2429 * <p class="note">This is a protected intent that can only be sent
2430 * by the system.
2431 *
2432 * {@hide}
2433 */
2434 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2435 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2436 /**
2437 * Broadcast Action: Indicates memory full condition on the device
2438 * no longer exists.
2439 *
2440 * <p class="note">This is a protected intent that can only be sent
2441 * by the system.
2442 *
2443 * {@hide}
2444 */
2445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2446 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2447 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002448 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2449 * and package management should be started.
2450 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2451 * notification.
2452 */
2453 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2454 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2455 /**
2456 * Broadcast Action: The device has entered USB Mass Storage mode.
2457 * This is used mainly for the USB Settings panel.
2458 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2459 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002460 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002461 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002462 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2464
2465 /**
2466 * Broadcast Action: The device has exited USB Mass Storage mode.
2467 * This is used mainly for the USB Settings panel.
2468 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2469 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002470 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002471 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002472 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002473 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2474
2475 /**
2476 * Broadcast Action: External media has been removed.
2477 * The path to the mount point for the removed media is contained in the Intent.mData field.
2478 */
2479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2480 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2481
2482 /**
2483 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002484 * 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 -07002485 */
2486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2487 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2488
2489 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002490 * Broadcast Action: External media is present, and being disk-checked
2491 * 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 -08002492 */
2493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2494 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2495
2496 /**
2497 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2498 * 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 -08002499 */
2500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2501 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2502
2503 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002504 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002505 * 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 -07002506 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2507 * media was mounted read only.
2508 */
2509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2510 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2511
2512 /**
2513 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002514 * 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 -07002515 */
2516 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2517 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2518
2519 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002520 * Broadcast Action: External media is no longer being shared via USB mass storage.
2521 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2522 *
2523 * @hide
2524 */
2525 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2526
2527 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002528 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2529 * The path to the mount point for the removed media is contained in the Intent.mData field.
2530 */
2531 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2532 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2533
2534 /**
2535 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002536 * 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 -07002537 */
2538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2539 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2540
2541 /**
2542 * Broadcast Action: User has expressed the desire to remove the external storage media.
2543 * Applications should close all files they have open within the mount point when they receive this intent.
2544 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2545 */
2546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2547 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2548
2549 /**
2550 * Broadcast Action: The media scanner has started scanning a directory.
2551 * The path to the directory being scanned is contained in the Intent.mData field.
2552 */
2553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2554 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2555
2556 /**
2557 * Broadcast Action: The media scanner has finished scanning a directory.
2558 * The path to the scanned directory is contained in the Intent.mData field.
2559 */
2560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2561 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2562
2563 /**
2564 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2565 * The path to the file is contained in the Intent.mData field.
2566 */
2567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2568 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2569
2570 /**
2571 * Broadcast Action: The "Media Button" was pressed. Includes a single
2572 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2573 * caused the broadcast.
2574 */
2575 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2576 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2577
Jaewan Kim52632e22016-01-14 18:01:52 +09002578 /**
2579 * Broadcast Action: The "Picture-in-picture (PIP) Button" was pressed.
2580 * Includes a single extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2581 * caused the broadcast.
2582 * @hide
2583 */
2584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2585 public static final String ACTION_PICTURE_IN_PICTURE_BUTTON =
2586 "android.intent.action.PICTURE_IN_PICTURE_BUTTON";
2587
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002588 /**
2589 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2590 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2591 * caused the broadcast.
2592 */
2593 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2594 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2595
2596 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2597 // location; they are not general-purpose actions.
2598
2599 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002600 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002601 */
2602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2603 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2604 "android.intent.action.GTALK_CONNECTED";
2605
2606 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002607 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002608 */
2609 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2610 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2611 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002612
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002613 /**
2614 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002615 */
2616 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2617 public static final String ACTION_INPUT_METHOD_CHANGED =
2618 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002619
2620 /**
2621 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2622 * more radios have been turned off or on. The intent will have the following extra value:</p>
2623 * <ul>
2624 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2625 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2626 * turned off</li>
2627 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002628 *
Peng Xua35b5532016-01-20 00:05:45 -08002629 * <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 -07002630 */
2631 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2632 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2633
2634 /**
2635 * Broadcast Action: Some content providers have parts of their namespace
2636 * where they publish new events or items that the user may be especially
2637 * interested in. For these things, they may broadcast this action when the
2638 * set of interesting items change.
2639 *
2640 * For example, GmailProvider sends this notification when the set of unread
2641 * mail in the inbox changes.
2642 *
2643 * <p>The data of the intent identifies which part of which provider
2644 * changed. When queried through the content resolver, the data URI will
2645 * return the data set in question.
2646 *
2647 * <p>The intent will have the following extra values:
2648 * <ul>
2649 * <li><em>count</em> - The number of items in the data set. This is the
2650 * same as the number of items in the cursor returned by querying the
2651 * data URI. </li>
2652 * </ul>
2653 *
2654 * This intent will be sent at boot (if the count is non-zero) and when the
2655 * data set changes. It is possible for the data set to change without the
2656 * count changing (for example, if a new unread message arrives in the same
2657 * sync operation in which a message is archived). The phone should still
2658 * ring/vibrate/etc as normal in this case.
2659 */
2660 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2661 public static final String ACTION_PROVIDER_CHANGED =
2662 "android.intent.action.PROVIDER_CHANGED";
2663
2664 /**
2665 * Broadcast Action: Wired Headset plugged in or unplugged.
2666 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002667 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2668 * and documentation.
2669 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002670 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002671 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002672 */
2673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002674 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002675
2676 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002677 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2678 * <ul>
2679 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2680 * </ul>
2681 *
2682 * <p class="note">This is a protected intent that can only be sent
2683 * by the system.
2684 *
2685 * @hide
2686 */
2687 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2688 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2689 = "android.intent.action.ADVANCED_SETTINGS";
2690
2691 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002692 * Broadcast Action: Sent after application restrictions are changed.
2693 *
2694 * <p class="note">This is a protected intent that can only be sent
2695 * by the system.</p>
2696 */
2697 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2698 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2699 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2700
2701 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002702 * Broadcast Action: An outgoing call is about to be placed.
2703 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002704 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002705 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002706 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002707 * the phone number originally intended to be dialed.</li>
2708 * </ul>
2709 * <p>Once the broadcast is finished, the resultData is used as the actual
2710 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002711 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002712 * outgoing call in turn: for example, a parental control application
2713 * might verify that the user is authorized to place the call at that
2714 * time, then a number-rewriting application might add an area code if
2715 * one was not specified.</p>
2716 * <p>For consistency, any receiver whose purpose is to prohibit phone
2717 * calls should have a priority of 0, to ensure it will see the final
2718 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002719 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 * should have a positive priority.
2721 * Negative priorities are reserved for the system for this broadcast;
2722 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002723 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2724 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002725 * <p>Emergency calls cannot be intercepted using this mechanism, and
2726 * other calls cannot be modified to call emergency numbers using this
2727 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002728 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2729 * call to use their own service instead. Those apps should first prevent
2730 * the call from being placed by setting resultData to <code>null</code>
2731 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002732 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002733 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2734 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002735 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002736 * <p class="note">This is a protected intent that can only be sent
2737 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002738 */
2739 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2740 public static final String ACTION_NEW_OUTGOING_CALL =
2741 "android.intent.action.NEW_OUTGOING_CALL";
2742
2743 /**
2744 * Broadcast Action: Have the device reboot. This is only for use by
2745 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002746 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002747 * <p class="note">This is a protected intent that can only be sent
2748 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002749 */
2750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2751 public static final String ACTION_REBOOT =
2752 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002753
Wei Huang97ecc9c2009-05-11 17:44:20 -07002754 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002755 * Broadcast Action: A sticky broadcast for changes in the physical
2756 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002757 *
2758 * <p>The intent will have the following extra values:
2759 * <ul>
2760 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002761 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002762 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002763 * <p>This is intended for monitoring the current physical dock state.
2764 * See {@link android.app.UiModeManager} for the normal API dealing with
2765 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002766 */
2767 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2768 public static final String ACTION_DOCK_EVENT =
2769 "android.intent.action.DOCK_EVENT";
2770
2771 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002772 * Broadcast Action: A broadcast when idle maintenance can be started.
2773 * This means that the user is not interacting with the device and is
2774 * not expected to do so soon. Typical use of the idle maintenance is
2775 * to perform somehow expensive tasks that can be postponed at a moment
2776 * when they will not degrade user experience.
2777 * <p>
2778 * <p class="note">In order to keep the device responsive in case of an
2779 * unexpected user interaction, implementations of a maintenance task
2780 * should be interruptible. In such a scenario a broadcast with action
2781 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2782 * should not do the maintenance work in
2783 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2784 * maintenance service by {@link Context#startService(Intent)}. Also
2785 * you should hold a wake lock while your maintenance service is running
2786 * to prevent the device going to sleep.
2787 * </p>
2788 * <p>
2789 * <p class="note">This is a protected intent that can only be sent by
2790 * the system.
2791 * </p>
2792 *
2793 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002794 *
2795 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002796 */
2797 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2798 public static final String ACTION_IDLE_MAINTENANCE_START =
2799 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2800
2801 /**
2802 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2803 * This means that the user was not interacting with the device as a result
2804 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2805 * was sent and now the user started interacting with the device. Typical
2806 * use of the idle maintenance is to perform somehow expensive tasks that
2807 * can be postponed at a moment when they will not degrade user experience.
2808 * <p>
2809 * <p class="note">In order to keep the device responsive in case of an
2810 * unexpected user interaction, implementations of a maintenance task
2811 * should be interruptible. Hence, on receiving a broadcast with this
2812 * action, the maintenance task should be interrupted as soon as possible.
2813 * In other words, you should not do the maintenance work in
2814 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2815 * maintenance service that was started on receiving of
2816 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2817 * lock you acquired when your maintenance service started.
2818 * </p>
2819 * <p class="note">This is a protected intent that can only be sent
2820 * by the system.
2821 *
2822 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002823 *
2824 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002825 */
2826 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2827 public static final String ACTION_IDLE_MAINTENANCE_END =
2828 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2829
2830 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002831 * Broadcast Action: a remote intent is to be broadcasted.
2832 *
2833 * A remote intent is used for remote RPC between devices. The remote intent
2834 * is serialized and sent from one device to another device. The receiving
2835 * device parses the remote intent and broadcasts it. Note that anyone can
2836 * broadcast a remote intent. However, if the intent receiver of the remote intent
2837 * does not trust intent broadcasts from arbitrary intent senders, it should require
2838 * the sender to hold certain permissions so only trusted sender's broadcast will be
2839 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002840 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002841 */
2842 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002843 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002844
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002845 /**
2846 * Broadcast Action: hook for permforming cleanup after a system update.
2847 *
2848 * The broadcast is sent when the system is booting, before the
2849 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2850 * image. A receiver for this should do its work and then disable itself
2851 * so that it does not get run again at the next boot.
2852 * @hide
2853 */
2854 public static final String ACTION_PRE_BOOT_COMPLETED =
2855 "android.intent.action.PRE_BOOT_COMPLETED";
2856
Amith Yamasani13593602012-03-22 16:16:17 -07002857 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002858 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002859 * on restricted users. The broadcast intent contains an extra
2860 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2861 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2862 * String[] depending on the restriction type.<p/>
2863 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002864 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2865 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2866 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002867 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2868 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002869 * @see RestrictionEntry
2870 */
2871 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2872 "android.intent.action.GET_RESTRICTION_ENTRIES";
2873
2874 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002875 * Sent the first time a user is starting, to allow system apps to
2876 * perform one time initialization. (This will not be seen by third
2877 * party applications because a newly initialized user does not have any
2878 * third party applications installed for it.) This is sent early in
2879 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002880 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2881 * broadcast, since it is part of a visible user interaction; be as quick
2882 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002883 */
2884 public static final String ACTION_USER_INITIALIZE =
2885 "android.intent.action.USER_INITIALIZE";
2886
2887 /**
2888 * Sent when a user switch is happening, causing the process's user to be
2889 * brought to the foreground. This is only sent to receivers registered
2890 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2891 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002892 * foreground. This is sent as a foreground
2893 * broadcast, since it is part of a visible user interaction; be as quick
2894 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002895 */
2896 public static final String ACTION_USER_FOREGROUND =
2897 "android.intent.action.USER_FOREGROUND";
2898
2899 /**
2900 * Sent when a user switch is happening, causing the process's user to be
2901 * sent to the background. This is only sent to receivers registered
2902 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2903 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002904 * background. This is sent as a foreground
2905 * broadcast, since it is part of a visible user interaction; be as quick
2906 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002907 */
2908 public static final String ACTION_USER_BACKGROUND =
2909 "android.intent.action.USER_BACKGROUND";
2910
2911 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002912 * Broadcast sent to the system when a user is added. Carries an extra
2913 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2914 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002915 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002916 * @hide
2917 */
2918 public static final String ACTION_USER_ADDED =
2919 "android.intent.action.USER_ADDED";
2920
2921 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002922 * Broadcast sent by the system when a user is started. Carries an extra
2923 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002924 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002925 * that has been started. This is sent as a foreground
2926 * broadcast, since it is part of a visible user interaction; be as quick
2927 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002928 * @hide
2929 */
2930 public static final String ACTION_USER_STARTED =
2931 "android.intent.action.USER_STARTED";
2932
2933 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002934 * Broadcast sent when a user is in the process of starting. Carries an extra
2935 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2936 * sent to registered receivers, not manifest receivers. It is sent to all
2937 * users (including the one that is being started). You must hold
2938 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2939 * this broadcast. This is sent as a background broadcast, since
2940 * its result is not part of the primary UX flow; to safely keep track of
2941 * started/stopped state of a user you can use this in conjunction with
2942 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2943 * other user state broadcasts since those are foreground broadcasts so can
2944 * execute in a different order.
2945 * @hide
2946 */
2947 public static final String ACTION_USER_STARTING =
2948 "android.intent.action.USER_STARTING";
2949
2950 /**
2951 * Broadcast sent when a user is going to be stopped. Carries an extra
2952 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2953 * sent to registered receivers, not manifest receivers. It is sent to all
2954 * users (including the one that is being stopped). You must hold
2955 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2956 * this broadcast. The user will not stop until all receivers have
2957 * handled the broadcast. This is sent as a background broadcast, since
2958 * its result is not part of the primary UX flow; to safely keep track of
2959 * started/stopped state of a user you can use this in conjunction with
2960 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2961 * other user state broadcasts since those are foreground broadcasts so can
2962 * execute in a different order.
2963 * @hide
2964 */
2965 public static final String ACTION_USER_STOPPING =
2966 "android.intent.action.USER_STOPPING";
2967
2968 /**
2969 * Broadcast sent to the system when a user is stopped. Carries an extra
2970 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2971 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2972 * specific package. This is only sent to registered receivers, not manifest
2973 * receivers. It is sent to all running users <em>except</em> the one that
2974 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002975 * @hide
2976 */
2977 public static final String ACTION_USER_STOPPED =
2978 "android.intent.action.USER_STOPPED";
2979
2980 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002981 * 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 -07002982 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002983 * one that has been removed. The user will not be completely removed until all receivers have
2984 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002985 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002986 * @hide
2987 */
2988 public static final String ACTION_USER_REMOVED =
2989 "android.intent.action.USER_REMOVED";
2990
2991 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002992 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002993 * the userHandle of the user to become the current one. This is only sent to
2994 * registered receivers, not manifest receivers. It is sent to all running users.
2995 * You must hold
2996 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002997 * @hide
2998 */
2999 public static final String ACTION_USER_SWITCHED =
3000 "android.intent.action.USER_SWITCHED";
3001
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003002 /**
Jeff Sharkey8924e872015-11-30 12:52:10 -07003003 * Broadcast Action: Sent when the credential-encrypted private storage has
3004 * become unlocked for the target user. This is only sent to registered
3005 * receivers, not manifest receivers.
3006 */
3007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3008 public static final String ACTION_USER_UNLOCKED = "android.intent.action.USER_UNLOCKED";
3009
3010 /**
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003011 * Broadcast sent to the system when a user's information changes. Carries an extra
3012 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07003013 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07003014 * @hide
3015 */
3016 public static final String ACTION_USER_INFO_CHANGED =
3017 "android.intent.action.USER_INFO_CHANGED";
3018
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003019 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003020 * Broadcast sent to the primary user when an associated managed profile is added (the profile
3021 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01003022 * the UserHandle of the profile that was added. Only applications (for example Launchers)
3023 * that need to display merged content across both primary and managed profiles need to
3024 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003025 * not manifest receivers.
3026 */
3027 public static final String ACTION_MANAGED_PROFILE_ADDED =
3028 "android.intent.action.MANAGED_PROFILE_ADDED";
3029
3030 /**
3031 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01003032 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
3033 * Only applications (for example Launchers) that need to display merged content across both
3034 * primary and managed profiles need to worry about this broadcast. This is only sent to
3035 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003036 */
3037 public static final String ACTION_MANAGED_PROFILE_REMOVED =
3038 "android.intent.action.MANAGED_PROFILE_REMOVED";
3039
3040 /**
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003041 * Broadcast sent to the primary user when an associated managed profile's availability has
Rubin Xuf13c9802016-01-21 18:06:00 +00003042 * changed. This includes when the user toggles the profile's quiet mode. Carries an extra
3043 * {@link #EXTRA_USER} that specifies the UserHandle of the profile. When quiet mode is changed,
3044 * this broadcast will carry a boolean extra {@link #EXTRA_QUIET_MODE} indicating the new state
3045 * of quiet mode. This is only sent to registered receivers, not manifest receivers.
Rubin Xu0a29ecd2015-11-04 15:11:48 +00003046 */
3047 public static final String ACTION_MANAGED_PROFILE_AVAILABILITY_CHANGED =
3048 "android.intent.action.MANAGED_PROFILE_AVAILABILITY_CHANGED";
3049
3050 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04003051 * Sent when the user taps on the clock widget in the system's "quick settings" area.
3052 */
3053 public static final String ACTION_QUICK_CLOCK =
3054 "android.intent.action.QUICK_CLOCK";
3055
Michael Wright0087a142013-02-05 16:29:39 -08003056 /**
Alan Viverette5a399492014-07-14 16:19:38 -07003057 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08003058 * @hide
3059 */
3060 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
3061 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
3062
Justin Kohd378ad72013-04-01 12:18:26 -07003063 /**
3064 * Broadcast Action: A global button was pressed. Includes a single
3065 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
3066 * caused the broadcast.
3067 * @hide
3068 */
3069 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
3070
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003071 /**
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003072 * Broadcast Action: Sent when media resource is granted.
3073 * <p>
3074 * {@link #EXTRA_PACKAGES} specifies the packages on the process holding the media resource
3075 * granted.
3076 * </p>
3077 * <p class="note">
3078 * This is a protected intent that can only be sent by the system.
3079 * </p>
3080 * <p class="note">
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08003081 * This requires {@link android.Manifest.permission#RECEIVE_MEDIA_RESOURCE_USAGE} permission.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09003082 * </p>
3083 *
3084 * @hide
3085 */
3086 public static final String ACTION_MEDIA_RESOURCE_GRANTED =
3087 "android.intent.action.MEDIA_RESOURCE_GRANTED";
3088
3089 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003090 * Activity Action: Allow the user to select and return one or more existing
3091 * documents. When invoked, the system will display the various
3092 * {@link DocumentsProvider} instances installed on the device, letting the
3093 * user interactively navigate through them. These documents include local
3094 * media, such as photos and video, and documents provided by installed
3095 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003096 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003097 * Each document is represented as a {@code content://} URI backed by a
3098 * {@link DocumentsProvider}, which can be opened as a stream with
3099 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3100 * {@link android.provider.DocumentsContract.Document} metadata.
3101 * <p>
3102 * All selected documents are returned to the calling application with
3103 * persistable read and write permission grants. If you want to maintain
3104 * access to the documents across device reboots, you need to explicitly
3105 * take the persistable permissions using
3106 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
3107 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003108 * Callers must indicate the acceptable document MIME types through
3109 * {@link #setType(String)}. For example, to select photos, use
3110 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
3111 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
3112 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003113 * <p>
3114 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003115 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
3116 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003117 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003118 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3119 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003120 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003121 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003122 * Output: The URI of the item that was picked, returned in
3123 * {@link #getData()}. This must be a {@code content://} URI so that any
3124 * receiver can access it. If multiple documents were selected, they are
3125 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003126 *
3127 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003128 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003129 * @see #ACTION_CREATE_DOCUMENT
3130 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003131 */
3132 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3133 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
3134
3135 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003136 * Activity Action: Allow the user to create a new document. When invoked,
3137 * the system will display the various {@link DocumentsProvider} instances
3138 * installed on the device, letting the user navigate through them. The
3139 * returned document may be a newly created document with no content, or it
3140 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003141 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003142 * Each document is represented as a {@code content://} URI backed by a
3143 * {@link DocumentsProvider}, which can be opened as a stream with
3144 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
3145 * {@link android.provider.DocumentsContract.Document} metadata.
3146 * <p>
3147 * Callers must indicate the concrete MIME type of the document being
3148 * created by setting {@link #setType(String)}. This MIME type cannot be
3149 * changed after the document is created.
3150 * <p>
3151 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
3152 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003153 * <p>
Tomasz Mikolajewskia8057a92015-11-16 11:41:28 +09003154 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent to obtain
3155 * URIs that can be opened with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003156 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003157 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003158 * Output: The URI of the item that was created. This must be a
3159 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07003160 *
3161 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003162 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003163 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003164 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003165 */
3166 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3167 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
3168
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003169 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003170 * Activity Action: Allow the user to pick a directory subtree. When
3171 * invoked, the system will display the various {@link DocumentsProvider}
3172 * instances installed on the device, letting the user navigate through
3173 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003174 * <p>
3175 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003176 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3177 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
3178 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003179 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003180 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003181 *
3182 * @see DocumentsContract
3183 */
3184 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003185 public static final String
3186 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07003187
Felipe Lemec7b1f892016-01-15 15:02:31 -08003188 /**
3189 * Activity Action: Give access to a standard storage directory after obtaining the user's
3190 * approval.
3191 * <p>
3192 * When invoked, the system will ask the user to grant access to the requested directory (and
3193 * its descendants).
3194 * <p>
3195 * To gain access to descendant (child, grandchild, etc) documents, use
3196 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
3197 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)} with the returned URI.
3198 * <p>
3199 * Input: full path to a standard directory, in the form of
3200 * {@code STORAGE_ROOT + STANDARD_DIRECTORY}, where {@code STORAGE_ROOT} is the physical path of
3201 * a storage container, and {@code STANDARD_DIRECTORY} is one of
3202 * {@link Environment#DIRECTORY_MUSIC}, {@link Environment#DIRECTORY_PODCASTS},
3203 * {@link Environment#DIRECTORY_RINGTONES}, {@link Environment#DIRECTORY_ALARMS},
3204 * {@link Environment#DIRECTORY_NOTIFICATIONS}, {@link Environment#DIRECTORY_PICTURES},
3205 * {@link Environment#DIRECTORY_MOVIES}, {@link Environment#DIRECTORY_DOWNLOADS},
3206 * {@link Environment#DIRECTORY_DCIM}, or {@link Environment#DIRECTORY_DOCUMENTS}
3207 * <p>
3208 * For example, to open the "Pictures" folder in the default external storage, the intent's data
3209 * would be: {@code Uri.fromFile(new File(Environment.getExternalStorageDirectory(),
3210 * Environment.DIRECTORY_PICTURES))}.
3211 * <p>
3212 * Output: The URI representing the requested directory tree.
3213 *
3214 * @see DocumentsContract
3215 */
3216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3217 public static final String
3218 ACTION_OPEN_EXTERNAL_DIRECTORY = "android.intent.action.OPEN_EXTERNAL_DIRECTORY";
3219
Peng Xua35b5532016-01-20 00:05:45 -08003220 /**
3221 * Broadcast Action: List of dynamic sensor is changed due to new sensor being connected or
3222 * exisiting sensor being disconnected.
3223 *
3224 * <p class="note">This is a protected intent that can only be sent by the system.</p>
3225 *
3226 * {@hide}
3227 */
3228 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
3229 public static final String
3230 ACTION_DYNAMIC_SENSOR_CHANGED = "android.intent.action.DYNAMIC_SENSOR_CHANGED";
3231
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003232 /** {@hide} */
3233 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
3234
Christopher Tate6597e342015-02-17 12:15:25 -08003235 /**
3236 * Broadcast action: report that a settings element is being restored from backup. The intent
3237 * contains three extras: EXTRA_SETTING_NAME is a string naming the restored setting,
3238 * EXTRA_SETTING_NEW_VALUE is the value being restored, and EXTRA_SETTING_PREVIOUS_VALUE
3239 * is the value of that settings entry prior to the restore operation. All of these values are
3240 * represented as strings.
3241 *
3242 * <p>This broadcast is sent only for settings provider entries known to require special handling
3243 * around restore time. These entries are found in the BROADCAST_ON_RESTORE table within
3244 * the provider's backup agent implementation.
3245 *
3246 * @see #EXTRA_SETTING_NAME
3247 * @see #EXTRA_SETTING_PREVIOUS_VALUE
3248 * @see #EXTRA_SETTING_NEW_VALUE
3249 * {@hide}
3250 */
3251 public static final String ACTION_SETTING_RESTORED = "android.os.action.SETTING_RESTORED";
3252
3253 /** {@hide} */
3254 public static final String EXTRA_SETTING_NAME = "setting_name";
3255 /** {@hide} */
3256 public static final String EXTRA_SETTING_PREVIOUS_VALUE = "previous_value";
3257 /** {@hide} */
3258 public static final String EXTRA_SETTING_NEW_VALUE = "new_value";
3259
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003260 /**
3261 * Activity Action: Process a piece of text.
3262 * <p>Input: {@link #EXTRA_PROCESS_TEXT} contains the text to be processed.
3263 * {@link #EXTRA_PROCESS_TEXT_READONLY} states if the resulting text will be read-only.</p>
3264 * <p>Output: {@link #EXTRA_PROCESS_TEXT} contains the processed text.</p>
3265 */
3266 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3267 public static final String ACTION_PROCESS_TEXT = "android.intent.action.PROCESS_TEXT";
3268 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003269 * The name of the extra used to define the text to be processed, as a
3270 * CharSequence. Note that this may be a styled CharSequence, so you must use
3271 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to retrieve it.
Clara Bayarri0a26157a2015-03-26 18:38:55 +00003272 */
3273 public static final String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT";
3274 /**
Clara Bayarri92c8e6f2015-05-21 17:50:08 +01003275 * 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 +00003276 */
3277 public static final String EXTRA_PROCESS_TEXT_READONLY =
3278 "android.intent.extra.PROCESS_TEXT_READONLY";
3279
Bryce Leebc58f592015-09-25 16:43:01 -07003280 /**
3281 * Broadcast action: reports when a new thermal event has been reached. When the device
3282 * is reaching its maximum temperatue, the thermal level reported
3283 * {@hide}
3284 */
3285 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
3286 public static final String ACTION_THERMAL_EVENT = "android.intent.action.THERMAL_EVENT";
3287
3288 /** {@hide} */
3289 public static final String EXTRA_THERMAL_STATE = "android.intent.extra.THERMAL_STATE";
3290
3291 /**
3292 * Thermal state when the device is normal. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003293 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003294 * {@hide}
3295 */
3296 public static final int EXTRA_THERMAL_STATE_NORMAL = 0;
3297
3298 /**
3299 * Thermal state where the device is approaching its maximum threshold. This state is sent in
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003300 * the {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003301 * {@hide}
3302 */
3303 public static final int EXTRA_THERMAL_STATE_WARNING = 1;
3304
3305 /**
3306 * Thermal state where the device has reached its maximum threshold. This state is sent in the
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08003307 * {@link #ACTION_THERMAL_EVENT} broadcast as {@link #EXTRA_THERMAL_STATE}.
Bryce Leebc58f592015-09-25 16:43:01 -07003308 * {@hide}
3309 */
3310 public static final int EXTRA_THERMAL_STATE_EXCEEDED = 2;
3311
3312
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003313 // ---------------------------------------------------------------------
3314 // ---------------------------------------------------------------------
3315 // Standard intent categories (see addCategory()).
3316
3317 /**
3318 * Set if the activity should be an option for the default action
3319 * (center press) to perform on a piece of data. Setting this will
3320 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04003321 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003322 * Intent when initiating an action -- it is for use in intent filters
3323 * specified in packages.
3324 */
3325 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3326 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
3327 /**
3328 * Activities that can be safely invoked from a browser must support this
3329 * category. For example, if the user is viewing a web page or an e-mail
3330 * and clicks on a link in the text, the Intent generated execute that
3331 * link will require the BROWSABLE category, so that only activities
3332 * supporting this category will be considered as possible actions. By
3333 * supporting this category, you are promising that there is nothing
3334 * damaging (without user intervention) that can happen by invoking any
3335 * matching Intent.
3336 */
3337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3338 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
3339 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07003340 * Categories for activities that can participate in voice interaction.
3341 * An activity that supports this category must be prepared to run with
3342 * no UI shown at all (though in some case it may have a UI shown), and
3343 * rely on {@link android.app.VoiceInteractor} to interact with the user.
3344 */
3345 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3346 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
3347 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003348 * Set if the activity should be considered as an alternative action to
3349 * the data the user is currently viewing. See also
3350 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
3351 * applies to the selection in a list of items.
3352 *
3353 * <p>Supporting this category means that you would like your activity to be
3354 * displayed in the set of alternative things the user can do, usually as
3355 * part of the current activity's options menu. You will usually want to
3356 * include a specific label in the &lt;intent-filter&gt; of this action
3357 * describing to the user what it does.
3358 *
3359 * <p>The action of IntentFilter with this category is important in that it
3360 * describes the specific action the target will perform. This generally
3361 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
3362 * a specific name such as "com.android.camera.action.CROP. Only one
3363 * alternative of any particular action will be shown to the user, so using
3364 * a specific action like this makes sure that your alternative will be
3365 * displayed while also allowing other applications to provide their own
3366 * overrides of that particular action.
3367 */
3368 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3369 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
3370 /**
3371 * Set if the activity should be considered as an alternative selection
3372 * action to the data the user has currently selected. This is like
3373 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
3374 * of items from which the user can select, giving them alternatives to the
3375 * default action that will be performed on it.
3376 */
3377 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3378 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
3379 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003380 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003381 */
3382 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3383 public static final String CATEGORY_TAB = "android.intent.category.TAB";
3384 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003385 * Should be displayed in the top-level launcher.
3386 */
3387 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3388 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
3389 /**
Jose Lima38b75b62014-03-11 10:41:39 -07003390 * Indicates an activity optimized for Leanback mode, and that should
3391 * be displayed in the Leanback launcher.
3392 */
3393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3394 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
3395 /**
Jose Lima73915cf2014-07-29 17:16:31 -07003396 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
3397 * @hide
3398 */
3399 @SystemApi
3400 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
3401 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003402 * Provides information about the package it is in; typically used if
3403 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
3404 * a front-door to the user without having to be shown in the all apps list.
3405 */
3406 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3407 public static final String CATEGORY_INFO = "android.intent.category.INFO";
3408 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003409 * This is the home activity, that is the first activity that is displayed
3410 * when the device boots.
3411 */
3412 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3413 public static final String CATEGORY_HOME = "android.intent.category.HOME";
3414 /**
Anthony Hugh979b81a2015-09-29 16:50:35 -07003415 * This is the home activity that is displayed when the device is finished setting up and ready
3416 * for use.
3417 * @hide
3418 */
3419 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3420 public static final String CATEGORY_HOME_MAIN = "android.intent.category.HOME_MAIN";
3421 /**
Svet Ganov50a8bf42015-07-15 11:04:18 -07003422 * This is the setup wizard activity, that is the first activity that is displayed
3423 * when the user sets up the device for the first time.
3424 * @hide
3425 */
3426 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3427 public static final String CATEGORY_SETUP_WIZARD = "android.intent.category.SETUP_WIZARD";
3428 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003429 * This activity is a preference panel.
3430 */
3431 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3432 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
3433 /**
3434 * This activity is a development preference panel.
3435 */
3436 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3437 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
3438 /**
3439 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003440 */
3441 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3442 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
3443 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07003444 * This activity allows the user to browse and download new applications.
3445 */
3446 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3447 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
3448 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003449 * This activity may be exercised by the monkey or other automated test tools.
3450 */
3451 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3452 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
3453 /**
3454 * To be used as a test (not part of the normal user experience).
3455 */
3456 public static final String CATEGORY_TEST = "android.intent.category.TEST";
3457 /**
3458 * To be used as a unit test (run through the Test Harness).
3459 */
3460 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
3461 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003462 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003463 * experience).
3464 */
3465 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003466
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003467 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003468 * Used to indicate that an intent only wants URIs that can be opened with
3469 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
3470 * must support at least the columns defined in {@link OpenableColumns} when
3471 * queried.
3472 *
3473 * @see #ACTION_GET_CONTENT
3474 * @see #ACTION_OPEN_DOCUMENT
3475 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003476 */
3477 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3478 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
3479
3480 /**
3481 * To be used as code under test for framework instrumentation tests.
3482 */
3483 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
3484 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04003485 /**
3486 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003487 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3488 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003489 */
3490 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3491 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
3492 /**
3493 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08003494 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3495 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04003496 */
3497 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3498 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003499 /**
3500 * An activity to run when device is inserted into a analog (low 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_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3506
3507 /**
3508 * An activity to run when device is inserted into a digital (high end) dock.
3509 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3510 * information, see {@link android.app.UiModeManager}.
3511 */
3512 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3513 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003514
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003515 /**
3516 * Used to indicate that the activity can be used in a car environment.
3517 */
3518 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3519 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3520
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003521 // ---------------------------------------------------------------------
3522 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003523 // Application launch intent categories (see addCategory()).
3524
3525 /**
3526 * Used with {@link #ACTION_MAIN} to launch the browser application.
3527 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003528 * <p>NOTE: This should not be used as the primary key of an Intent,
3529 * since it will not result in the app launching with the correct
3530 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003531 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003532 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003533 */
3534 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3535 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3536
3537 /**
3538 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3539 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003540 * <p>NOTE: This should not be used as the primary key of an Intent,
3541 * since it will not result in the app launching with the correct
3542 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003543 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003544 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003545 */
3546 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3547 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3548
3549 /**
3550 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3551 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003552 * <p>NOTE: This should not be used as the primary key of an Intent,
3553 * since it will not result in the app launching with the correct
3554 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003555 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003556 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003557 */
3558 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3559 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3560
3561 /**
3562 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3563 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003564 * <p>NOTE: This should not be used as the primary key of an Intent,
3565 * since it will not result in the app launching with the correct
3566 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003567 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003568 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003569 */
3570 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3571 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3572
3573 /**
3574 * Used with {@link #ACTION_MAIN} to launch the email application.
3575 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003576 * <p>NOTE: This should not be used as the primary key of an Intent,
3577 * since it will not result in the app launching with the correct
3578 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003579 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003580 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003581 */
3582 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3583 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3584
3585 /**
3586 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3587 * The activity should be able to view and manipulate image and video files
3588 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003589 * <p>NOTE: This should not be used as the primary key of an Intent,
3590 * since it will not result in the app launching with the correct
3591 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003592 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003593 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003594 */
3595 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3596 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3597
3598 /**
3599 * Used with {@link #ACTION_MAIN} to launch the maps application.
3600 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003601 * <p>NOTE: This should not be used as the primary key of an Intent,
3602 * since it will not result in the app launching with the correct
3603 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003604 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003605 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003606 */
3607 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3608 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3609
3610 /**
3611 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3612 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003613 * <p>NOTE: This should not be used as the primary key of an Intent,
3614 * since it will not result in the app launching with the correct
3615 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003616 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003617 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003618 */
3619 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3620 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3621
3622 /**
3623 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003624 * The activity should be able to play, browse, or manipulate music files
3625 * stored on the device.
3626 * <p>NOTE: This should not be used as the primary key of an Intent,
3627 * since it will not result in the app launching with the correct
3628 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003629 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003630 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003631 */
3632 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3633 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3634
3635 // ---------------------------------------------------------------------
3636 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003637 // Standard extra data keys.
3638
3639 /**
3640 * The initial data to place in a newly created record. Use with
3641 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3642 * fields as would be given to the underlying ContentProvider.insert()
3643 * call.
3644 */
3645 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3646
3647 /**
3648 * A constant CharSequence that is associated with the Intent, used with
3649 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3650 * this may be a styled CharSequence, so you must use
3651 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3652 * retrieve it.
3653 */
3654 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3655
3656 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003657 * A constant String that is associated with the Intent, used with
3658 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3659 * as HTML formatted text. Note that you <em>must</em> also supply
3660 * {@link #EXTRA_TEXT}.
3661 */
3662 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3663
3664 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003665 * A content: URI holding a stream of data associated with the Intent,
3666 * used with {@link #ACTION_SEND} to supply the data being sent.
3667 */
3668 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3669
3670 /**
3671 * A String[] holding e-mail addresses that should be delivered to.
3672 */
3673 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3674
3675 /**
3676 * A String[] holding e-mail addresses that should be carbon copied.
3677 */
3678 public static final String EXTRA_CC = "android.intent.extra.CC";
3679
3680 /**
3681 * A String[] holding e-mail addresses that should be blind carbon copied.
3682 */
3683 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3684
3685 /**
3686 * A constant string holding the desired subject line of a message.
3687 */
3688 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3689
3690 /**
3691 * An Intent describing the choices you would like shown with
Adam Powell2ed547e2015-04-29 18:45:04 -07003692 * {@link #ACTION_PICK_ACTIVITY} or {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003693 */
3694 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3695
3696 /**
Clara Bayarrif7fea162015-10-22 16:09:52 +01003697 * An int representing the user id to be used.
3698 *
3699 * @hide
3700 */
3701 public static final String EXTRA_USER_ID = "android.intent.extra.USER_ID";
3702
3703 /**
Clara Bayarriea9b10e2015-12-04 15:36:26 +00003704 * An int representing the task id to be retrieved. This is used when a launch from recents is
3705 * intercepted by another action such as credentials confirmation to remember which task should
3706 * be resumed when complete.
3707 *
3708 * @hide
3709 */
3710 public static final String EXTRA_TASK_ID = "android.intent.extra.TASK_ID";
3711
3712 /**
Adam Powell2ed547e2015-04-29 18:45:04 -07003713 * An Intent[] describing additional, alternate choices you would like shown with
3714 * {@link #ACTION_CHOOSER}.
3715 *
3716 * <p>An app may be capable of providing several different payload types to complete a
3717 * user's intended action. For example, an app invoking {@link #ACTION_SEND} to share photos
3718 * with another app may use EXTRA_ALTERNATE_INTENTS to have the chooser transparently offer
3719 * several different supported sending mechanisms for sharing, such as the actual "image/*"
3720 * photo data or a hosted link where the photos can be viewed.</p>
3721 *
3722 * <p>The intent present in {@link #EXTRA_INTENT} will be treated as the
3723 * first/primary/preferred intent in the set. Additional intents specified in
3724 * this extra are ordered; by default intents that appear earlier in the array will be
3725 * preferred over intents that appear later in the array as matches for the same
3726 * target component. To alter this preference, a calling app may also supply
3727 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER}.</p>
3728 */
3729 public static final String EXTRA_ALTERNATE_INTENTS = "android.intent.extra.ALTERNATE_INTENTS";
3730
3731 /**
3732 * An {@link IntentSender} for an Activity that will be invoked when the user makes a selection
3733 * from the chooser activity presented by {@link #ACTION_CHOOSER}.
3734 *
3735 * <p>An app preparing an action for another app to complete may wish to allow the user to
3736 * disambiguate between several options for completing the action based on the chosen target
3737 * or otherwise refine the action before it is invoked.
3738 * </p>
3739 *
3740 * <p>When sent, this IntentSender may be filled in with the following extras:</p>
3741 * <ul>
3742 * <li>{@link #EXTRA_INTENT} The first intent that matched the user's chosen target</li>
3743 * <li>{@link #EXTRA_ALTERNATE_INTENTS} Any additional intents that also matched the user's
3744 * chosen target beyond the first</li>
3745 * <li>{@link #EXTRA_RESULT_RECEIVER} A {@link ResultReceiver} that the refinement activity
3746 * should fill in and send once the disambiguation is complete</li>
3747 * </ul>
3748 */
3749 public static final String EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER
3750 = "android.intent.extra.CHOOSER_REFINEMENT_INTENT_SENDER";
3751
3752 /**
3753 * A {@link ResultReceiver} used to return data back to the sender.
3754 *
3755 * <p>Used to complete an app-specific
3756 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER refinement} for {@link #ACTION_CHOOSER}.</p>
3757 *
3758 * <p>If {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} is present in the intent
3759 * used to start a {@link #ACTION_CHOOSER} activity this extra will be
3760 * {@link #fillIn(Intent, int) filled in} to that {@link IntentSender} and sent
3761 * when the user selects a target component from the chooser. It is up to the recipient
3762 * to send a result to this ResultReceiver to signal that disambiguation is complete
3763 * and that the chooser should invoke the user's choice.</p>
3764 *
3765 * <p>The disambiguator should provide a Bundle to the ResultReceiver with an intent
3766 * assigned to the key {@link #EXTRA_INTENT}. This supplied intent will be used by the chooser
3767 * to match and fill in the final Intent or ChooserTarget before starting it.
3768 * The supplied intent must {@link #filterEquals(Intent) match} one of the intents from
3769 * {@link #EXTRA_INTENT} or {@link #EXTRA_ALTERNATE_INTENTS} passed to
3770 * {@link #EXTRA_CHOOSER_REFINEMENT_INTENT_SENDER} to be accepted.</p>
3771 *
3772 * <p>The result code passed to the ResultReceiver should be
3773 * {@link android.app.Activity#RESULT_OK} if the refinement succeeded and the supplied intent's
3774 * target in the chooser should be started, or {@link android.app.Activity#RESULT_CANCELED} if
3775 * the chooser should finish without starting a target.</p>
3776 */
3777 public static final String EXTRA_RESULT_RECEIVER
3778 = "android.intent.extra.RESULT_RECEIVER";
3779
3780 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003781 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003782 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003783 */
3784 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3785
3786 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003787 * A Parcelable[] of {@link Intent} or
3788 * {@link android.content.pm.LabeledIntent} objects as set with
3789 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3790 * a the front of the list of choices, when shown to the user with a
3791 * {@link #ACTION_CHOOSER}.
3792 */
3793 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3794
3795 /**
Todd Kennedy7440f172015-12-09 14:31:22 -08003796 * A {@link IntentSender} to start after ephemeral installation success.
3797 * @hide
3798 */
3799 @SystemApi
3800 public static final String EXTRA_EPHEMERAL_SUCCESS = "android.intent.extra.EPHEMERAL_SUCCESS";
3801
3802 /**
3803 * A {@link IntentSender} to start after ephemeral installation failure.
3804 * @hide
3805 */
3806 @SystemApi
3807 public static final String EXTRA_EPHEMERAL_FAILURE = "android.intent.extra.EPHEMERAL_FAILURE";
3808
3809 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003810 * A Bundle forming a mapping of potential target package names to different extras Bundles
3811 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3812 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3813 * be currently installed on the device.
3814 *
3815 * <p>An application may choose to provide alternate extras for the case where a user
3816 * selects an activity from a predetermined set of target packages. If the activity
3817 * the user selects from the chooser belongs to a package with its package name as
3818 * a key in this bundle, the corresponding extras for that package will be merged with
3819 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3820 * extra has the same key as an extra already present in the intent it will overwrite
3821 * the extra from the intent.</p>
3822 *
3823 * <p><em>Examples:</em>
3824 * <ul>
3825 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3826 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3827 * parameters for that target.</li>
3828 * <li>An application may offer additional metadata for known targets of a given intent
3829 * to pass along information only relevant to that target such as account or content
3830 * identifiers already known to that application.</li>
3831 * </ul></p>
3832 */
3833 public static final String EXTRA_REPLACEMENT_EXTRAS =
3834 "android.intent.extra.REPLACEMENT_EXTRAS";
3835
3836 /**
Adam Powell0b3c1122014-10-09 12:50:14 -07003837 * An {@link IntentSender} that will be notified if a user successfully chooses a target
3838 * component to handle an action in an {@link #ACTION_CHOOSER} activity. The IntentSender
3839 * will have the extra {@link #EXTRA_CHOSEN_COMPONENT} appended to it containing the
3840 * {@link ComponentName} of the chosen component.
3841 *
3842 * <p>In some situations this callback may never come, for example if the user abandons
3843 * the chooser, switches to another task or any number of other reasons. Apps should not
3844 * be written assuming that this callback will always occur.</p>
3845 */
3846 public static final String EXTRA_CHOSEN_COMPONENT_INTENT_SENDER =
3847 "android.intent.extra.CHOSEN_COMPONENT_INTENT_SENDER";
3848
3849 /**
3850 * The {@link ComponentName} chosen by the user to complete an action.
3851 *
3852 * @see #EXTRA_CHOSEN_COMPONENT_INTENT_SENDER
3853 */
3854 public static final String EXTRA_CHOSEN_COMPONENT = "android.intent.extra.CHOSEN_COMPONENT";
3855
3856 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003857 * A {@link android.view.KeyEvent} object containing the event that
3858 * triggered the creation of the Intent it is in.
3859 */
3860 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3861
3862 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003863 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3864 * before shutting down.
3865 *
3866 * {@hide}
3867 */
3868 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3869
3870 /**
Yusuke Sato705ffd12015-07-21 15:52:11 -07003871 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to indicate that the shutdown is
3872 * requested by the user.
3873 *
3874 * {@hide}
3875 */
3876 public static final String EXTRA_USER_REQUESTED_SHUTDOWN =
3877 "android.intent.extra.USER_REQUESTED_SHUTDOWN";
3878
3879 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003880 * 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 -07003881 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3882 * of restarting the application.
3883 */
3884 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3885
3886 /**
3887 * A String holding the phone number originally entered in
3888 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3889 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3890 */
3891 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003892
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893 /**
3894 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3895 * intents to supply the uid the package had been assigned. Also an optional
3896 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3897 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3898 * purpose.
3899 */
3900 public static final String EXTRA_UID = "android.intent.extra.UID";
3901
3902 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003903 * @hide String array of package names.
3904 */
Soonil Nagarkar0e8fd092015-02-10 10:37:36 -08003905 @SystemApi
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003906 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3907
3908 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003909 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3910 * intents to indicate whether this represents a full uninstall (removing
3911 * both the code and its data) or a partial uninstall (leaving its data,
3912 * implying that this is an update).
3913 */
3914 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003915
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003916 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003917 * @hide
3918 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3919 * intents to indicate that at this point the package has been removed for
3920 * all users on the device.
3921 */
3922 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3923 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3924
3925 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003926 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3927 * intents to indicate that this is a replacement of the package, so this
3928 * broadcast will immediately be followed by an add broadcast for a
3929 * different version of the same package.
3930 */
3931 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003932
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003933 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003934 * Used as an int extra field in {@link android.app.AlarmManager} intents
3935 * to tell the application being invoked how many pending alarms are being
3936 * delievered with the intent. For one-shot alarms this will always be 1.
3937 * For recurring alarms, this might be greater than 1 if the device was
3938 * asleep or powered off at the time an earlier alarm would have been
3939 * delivered.
3940 */
3941 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003942
Jacek Surazski86b6c532009-05-13 14:38:28 +02003943 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003944 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3945 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003946 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3947 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003948 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3949 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3950 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003951 */
3952 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3953
3954 /**
3955 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3956 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003957 */
3958 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3959
3960 /**
3961 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3962 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003963 */
3964 public static final int EXTRA_DOCK_STATE_DESK = 1;
3965
3966 /**
3967 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3968 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003969 */
3970 public static final int EXTRA_DOCK_STATE_CAR = 2;
3971
3972 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003973 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3974 * to represent that the phone is in a analog (low end) dock.
3975 */
3976 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3977
3978 /**
3979 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3980 * to represent that the phone is in a digital (high end) dock.
3981 */
3982 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3983
3984 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003985 * Boolean that can be supplied as meta-data with a dock activity, to
3986 * indicate that the dock should take over the home key when it is active.
3987 */
3988 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003989
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003990 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003991 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3992 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003993 */
3994 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3995
3996 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003997 * Used in the extra field in the remote intent. It's astring token passed with the
3998 * remote intent.
3999 */
4000 public static final String EXTRA_REMOTE_INTENT_TOKEN =
4001 "android.intent.extra.remote_intent_token";
4002
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004003 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004004 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004005 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004006 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08004007 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07004008 "android.intent.extra.changed_component_name";
4009
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004010 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004011 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08004012 * and contains a string array of all of the components that have changed. If
4013 * the state of the overall package has changed, then it will contain an entry
4014 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08004015 */
4016 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
4017 "android.intent.extra.changed_component_name_list";
4018
4019 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004020 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004021 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
Andrei Stingaceanu69d5ebc2016-01-14 12:59:03 +00004022 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE},
4023 * {@link android.content.Intent#ACTION_PACKAGES_SUSPENDED},
4024 * {@link android.content.Intent#ACTION_PACKAGES_UNSUSPENDED}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004025 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004026 */
4027 public static final String EXTRA_CHANGED_PACKAGE_LIST =
4028 "android.intent.extra.changed_package_list";
4029
4030 /**
4031 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08004032 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
4033 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004034 * and contains an integer array of uids of all of the components
4035 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08004036 */
4037 public static final String EXTRA_CHANGED_UID_LIST =
4038 "android.intent.extra.changed_uid_list";
4039
4040 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07004041 * @hide
4042 * Magic extra system code can use when binding, to give a label for
4043 * who it is that has bound to a service. This is an integer giving
4044 * a framework string resource that can be displayed to the user.
4045 */
4046 public static final String EXTRA_CLIENT_LABEL =
4047 "android.intent.extra.client_label";
4048
4049 /**
4050 * @hide
4051 * Magic extra system code can use when binding, to give a PendingIntent object
4052 * that can be launched for the user to disable the system's use of this
4053 * service.
4054 */
4055 public static final String EXTRA_CLIENT_INTENT =
4056 "android.intent.extra.client_intent";
4057
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004058 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004059 * Extra used to indicate that an intent should only return data that is on
4060 * the local device. This is a boolean extra; the default is false. If true,
4061 * an implementation should only allow the user to select data that is
4062 * already on the device, not requiring it be downloaded from a remote
4063 * service when opened.
4064 *
4065 * @see #ACTION_GET_CONTENT
4066 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07004067 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004068 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08004069 */
4070 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004071 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07004072
Amith Yamasani13593602012-03-22 16:16:17 -07004073 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004074 * Extra used to indicate that an intent can allow the user to select and
4075 * return multiple items. This is a boolean extra; the default is false. If
4076 * true, an implementation is allowed to present the user with a UI where
4077 * they can pick multiple items that are all returned to the caller. When
4078 * this happens, they should be returned as the {@link #getClipData()} part
4079 * of the result Intent.
4080 *
4081 * @see #ACTION_GET_CONTENT
4082 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004083 */
4084 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004085 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08004086
4087 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004088 * The integer userHandle carried with broadcast intents related to addition, removal and
4089 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
4090 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
4091 *
Amith Yamasani13593602012-03-22 16:16:17 -07004092 * @hide
4093 */
Amith Yamasani2a003292012-08-14 18:25:45 -07004094 public static final String EXTRA_USER_HANDLE =
4095 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07004096
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004097 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004098 * The UserHandle carried with broadcasts intents related to addition and removal of managed
4099 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
4100 */
4101 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01004102 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01004103
4104 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004105 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004106 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
4107 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004108 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07004109 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
4110
4111 /**
4112 * Extra sent in the intent to the BroadcastReceiver that handles
4113 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
4114 * the restrictions as key/value pairs.
4115 */
4116 public static final String EXTRA_RESTRICTIONS_BUNDLE =
4117 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08004118
Amith Yamasani86118ba2013-03-28 14:33:16 -07004119 /**
4120 * Extra used in the response from a BroadcastReceiver that handles
4121 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
4122 */
4123 public static final String EXTRA_RESTRICTIONS_INTENT =
4124 "android.intent.extra.restrictions_intent";
4125
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004126 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004127 * Extra used to communicate a set of acceptable MIME types. The type of the
4128 * extra is {@code String[]}. Values may be a combination of concrete MIME
4129 * types (such as "image/png") and/or partial MIME types (such as
4130 * "audio/*").
4131 *
4132 * @see #ACTION_GET_CONTENT
4133 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07004134 */
4135 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
4136
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004137 /**
4138 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
4139 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07004140 * When this is true, hardware devices can use this information to determine that
4141 * they shouldn't do a complete shutdown of their device since this is not a
4142 * complete shutdown down to the kernel, but only user space restarting.
4143 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07004144 */
4145 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
4146 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
4147
Narayan Kamathccb2a0862013-12-19 14:49:36 +00004148 /**
4149 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
4150 * user has set their time format preferences to the 24 hour format.
4151 *
4152 * @hide for internal use only.
4153 */
4154 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
4155 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
4156
Jeff Sharkey004a4b22014-09-24 11:45:24 -07004157 /** {@hide} */
4158 public static final String EXTRA_REASON = "android.intent.extra.REASON";
4159
Rubin Xue8490f12015-06-25 12:17:48 +01004160 /** {@hide} */
4161 public static final String EXTRA_WIPE_EXTERNAL_STORAGE = "android.intent.extra.WIPE_EXTERNAL_STORAGE";
4162
Santos Cordon15a13782015-03-31 18:32:31 -07004163 /**
4164 * Optional {@link android.app.PendingIntent} extra used to deliver the result of the SIM
4165 * activation request.
4166 * TODO: Add information about the structure and response data used with the pending intent.
4167 * @hide
4168 */
4169 public static final String EXTRA_SIM_ACTIVATION_RESPONSE =
4170 "android.intent.extra.SIM_ACTIVATION_RESPONSE";
4171
Tomasz Mikolajewski319fb492016-01-20 12:24:01 +09004172 /**
4173 * Optional index with semantics depending on the intent action.
4174 * @see #ACTION_QUICK_VIEW
4175 */
Steve McKay6eaf38632015-08-04 10:11:01 -07004176 public static final String EXTRA_INDEX = "android.intent.extra.INDEX";
4177
Rubin Xu0a29ecd2015-11-04 15:11:48 +00004178 /**
4179 * Optional boolean extra indicating whether quiet mode has been switched on or off.
4180 */
4181 public static final String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE";
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004182
4183 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004184 * Used as an int extra field in {@link #ACTION_MEDIA_RESOURCE_GRANTED}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004185 * intents to specify the resource type granted. Possible values are
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004186 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC} or
4187 * {@link #EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC}.
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004188 *
4189 * @hide
4190 */
4191 public static final String EXTRA_MEDIA_RESOURCE_TYPE =
4192 "android.intent.extra.MEDIA_RESOURCE_TYPE";
4193
4194 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004195 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004196 * to represent that a video codec is allowed to use.
4197 *
4198 * @hide
4199 */
4200 public static final int EXTRA_MEDIA_RESOURCE_TYPE_VIDEO_CODEC = 0;
4201
4202 /**
Dongwon Kang32cb9ab2016-01-13 18:11:10 -08004203 * Used as an int value for {@link #EXTRA_MEDIA_RESOURCE_TYPE}
Dongwon Kang2034a4c2015-12-14 21:57:34 +09004204 * to represent that a audio codec is allowed to use.
4205 *
4206 * @hide
4207 */
4208 public static final int EXTRA_MEDIA_RESOURCE_TYPE_AUDIO_CODEC = 1;
4209
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004210 // ---------------------------------------------------------------------
4211 // ---------------------------------------------------------------------
4212 // Intent flags (see mFlags variable).
4213
Tor Norbyed9273d62013-05-30 15:59:53 -07004214 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004215 @IntDef(flag = true, value = {
4216 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
4217 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07004218 @Retention(RetentionPolicy.SOURCE)
4219 public @interface GrantUriMode {}
4220
Jeff Sharkey846318a2014-04-04 12:12:41 -07004221 /** @hide */
4222 @IntDef(flag = true, value = {
4223 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
4224 @Retention(RetentionPolicy.SOURCE)
4225 public @interface AccessUriMode {}
4226
4227 /**
4228 * Test if given mode flags specify an access mode, which must be at least
4229 * read and/or write.
4230 *
4231 * @hide
4232 */
4233 public static boolean isAccessUriMode(int modeFlags) {
4234 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
4235 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
4236 }
4237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004238 /**
4239 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004240 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004241 * specified in its ClipData. When applying to an Intent's ClipData,
4242 * all URIs as well as recursive traversals through data or other ClipData
4243 * in Intent items will be granted; only the grant flags of the top-level
4244 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004245 */
4246 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
4247 /**
4248 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004249 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004250 * specified in its ClipData. When applying to an Intent's ClipData,
4251 * all URIs as well as recursive traversals through data or other ClipData
4252 * in Intent items will be granted; only the grant flags of the top-level
4253 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004254 */
4255 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
4256 /**
4257 * Can be set by the caller to indicate that this Intent is coming from
4258 * a background operation, not from direct user interaction.
4259 */
4260 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
4261 /**
4262 * A flag you can enable for debugging: when set, log messages will be
4263 * printed during the resolution of this intent to show you what has
4264 * been found to create the final resolved list.
4265 */
4266 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08004267 /**
4268 * If set, this intent will not match any components in packages that
4269 * are currently stopped. If this is not set, then the default behavior
4270 * is to include such applications in the result.
4271 */
4272 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
4273 /**
4274 * If set, this intent will always match any components in packages that
4275 * are currently stopped. This is the default behavior when
4276 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
4277 * flags are set, this one wins (it allows overriding of exclude for
4278 * places where the framework may automatically set the exclude flag).
4279 */
4280 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004281
4282 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004283 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004284 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004285 * persisted across device reboots until explicitly revoked with
4286 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
4287 * grant for possible persisting; the receiving application must call
4288 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
4289 * actually persist.
4290 *
4291 * @see ContentResolver#takePersistableUriPermission(Uri, int)
4292 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
4293 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07004294 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004295 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07004296 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07004297
4298 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07004299 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
4300 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
4301 * applies to any URI that is a prefix match against the original granted
4302 * URI. (Without this flag, the URI must match exactly for access to be
4303 * granted.) Another URI is considered a prefix match only when scheme,
4304 * authority, and all path segments defined by the prefix are an exact
4305 * match.
4306 */
4307 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
4308
4309 /**
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004310 * Internal flag used to indicate that a system component has done their
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004311 * homework and verified that they correctly handle packages and components
4312 * that come and go over time. In particular:
4313 * <ul>
4314 * <li>Apps installed on external storage, which will appear to be
4315 * uninstalled while the the device is ejected.
4316 * <li>Apps with encryption unaware components, which will appear to not
4317 * exist while the device is locked.
4318 * </ul>
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004319 *
4320 * @hide
4321 */
Jeff Sharkey2f3e3532015-12-21 14:16:43 -07004322 public static final int FLAG_DEBUG_TRIAGED_MISSING = 0x00000100;
Jeff Sharkey2a9e3f82015-12-18 10:57:58 -07004323
4324 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004325 * If set, the new activity is not kept in the history stack. As soon as
4326 * the user navigates away from it, the activity is finished. This may also
4327 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
4328 * noHistory} attribute.
Ricardo Cervera92f6a742014-04-04 11:17:06 -07004329 *
4330 * <p>If set, {@link android.app.Activity#onActivityResult onActivityResult()}
4331 * is never invoked when the current activity starts a new activity which
4332 * sets a result and finishes.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004333 */
4334 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
4335 /**
4336 * If set, the activity will not be launched if it is already running
4337 * at the top of the history stack.
4338 */
4339 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
4340 /**
4341 * If set, this activity will become the start of a new task on this
4342 * history stack. A task (from the activity that started it to the
4343 * next task activity) defines an atomic group of activities that the
4344 * user can move to. Tasks can be moved to the foreground and background;
4345 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07004346 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08004347 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4348 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004349 *
4350 * <p>This flag is generally used by activities that want
4351 * to present a "launcher" style behavior: they give the user a list of
4352 * separate things that can be done, which otherwise run completely
4353 * independently of the activity launching them.
4354 *
4355 * <p>When using this flag, if a task is already running for the activity
4356 * you are now starting, then a new activity will not be started; instead,
4357 * the current task will simply be brought to the front of the screen with
4358 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
4359 * to disable this behavior.
4360 *
4361 * <p>This flag can not be used when the caller is requesting a result from
4362 * the activity being launched.
4363 */
4364 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
4365 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07004366 * This flag is used to create a new task and launch an activity into it.
4367 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
4368 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
4369 * search through existing tasks for ones matching this Intent. Only if no such
4370 * task is found would a new task be created. When paired with
4371 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
4372 * the search for a matching task and unconditionally start a new task.
4373 *
4374 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
4375 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004376 * top-level application launcher.</strong> Used in conjunction with
4377 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
4378 * behavior of bringing an existing task to the foreground. When set,
4379 * a new task is <em>always</em> started to host the Activity for the
4380 * Intent, regardless of whether there is already an existing task running
4381 * the same thing.
4382 *
4383 * <p><strong>Because the default system does not include graphical task management,
4384 * you should not use this flag unless you provide some way for a user to
4385 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07004386 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07004387 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
4388 * creating new document tasks.
4389 *
4390 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07004391 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004392 *
Scott Main7aee61f2011-02-08 11:25:01 -08004393 * <p>See
4394 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4395 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004396 *
4397 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
4398 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004399 */
4400 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
4401 /**
4402 * If set, and the activity being launched is already running in the
4403 * current task, then instead of launching a new instance of that activity,
4404 * all of the other activities on top of it will be closed and this Intent
4405 * will be delivered to the (now on top) old activity as a new Intent.
4406 *
4407 * <p>For example, consider a task consisting of the activities: A, B, C, D.
4408 * If D calls startActivity() with an Intent that resolves to the component
4409 * of activity B, then C and D will be finished and B receive the given
4410 * Intent, resulting in the stack now being: A, B.
4411 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004412 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004413 * either receive the new intent you are starting here in its
4414 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004415 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07004416 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
4417 * the same intent, then it will be finished and re-created; for all other
4418 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
4419 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004420 *
4421 * <p>This launch mode can also be used to good effect in conjunction with
4422 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
4423 * of a task, it will bring any currently running instance of that task
4424 * to the foreground, and then clear it to its root state. This is
4425 * especially useful, for example, when launching an activity from the
4426 * notification manager.
4427 *
Scott Main7aee61f2011-02-08 11:25:01 -08004428 * <p>See
4429 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
4430 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004431 */
4432 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
4433 /**
4434 * If set and this intent is being used to launch a new activity from an
4435 * existing one, then the reply target of the existing activity will be
4436 * transfered to the new activity. This way the new activity can call
4437 * {@link android.app.Activity#setResult} and have that result sent back to
4438 * the reply target of the original activity.
4439 */
4440 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
4441 /**
4442 * If set and this intent is being used to launch a new activity from an
4443 * existing one, the current activity will not be counted as the top
4444 * activity for deciding whether the new intent should be delivered to
4445 * the top instead of starting a new one. The previous activity will
4446 * be used as the top, with the assumption being that the current activity
4447 * will finish itself immediately.
4448 */
4449 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
4450 /**
4451 * If set, the new activity is not kept in the list of recently launched
4452 * activities.
4453 */
4454 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
4455 /**
4456 * This flag is not normally set by application code, but set for you by
4457 * the system as described in the
4458 * {@link android.R.styleable#AndroidManifestActivity_launchMode
4459 * launchMode} documentation for the singleTask mode.
4460 */
4461 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
4462 /**
4463 * If set, and this activity is either being started in a new task or
4464 * bringing to the top an existing task, then it will be launched as
4465 * the front door of the task. This will result in the application of
4466 * any affinities needed to have that task in the proper state (either
4467 * moving activities to or from it), or simply resetting that task to
4468 * its initial state if needed.
4469 */
4470 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
4471 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004472 * This flag is not normally set by application code, but set for you by
4473 * the system if this activity is being launched from history
4474 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004475 */
4476 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004477 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004478 * @deprecated As of API 21 this performs identically to
4479 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004480 */
4481 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004482 /**
Craig Mautner026596b2014-05-21 15:35:44 -07004483 * This flag is used to open a document into a new task rooted at the activity launched
4484 * by this Intent. Through the use of this flag, or its equivalent attribute,
4485 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
Chet Haase0d1c27a2014-11-03 18:35:16 +00004486 * containing different documents will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004487 *
Craig Mautner026596b2014-05-21 15:35:44 -07004488 * <p>The use of the activity attribute form of this,
4489 * {@link android.R.attr#documentLaunchMode}, is
4490 * preferred over the Intent flag described here. The attribute form allows the
4491 * Activity to specify multiple document behavior for all launchers of the Activity
4492 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004493 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07004494 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
4495 * it is kept after the activity is finished is different than the use of
4496 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
4497 * this flag is being used to create a new recents entry, then by default that entry
4498 * will be removed once the activity is finished. You can modify this behavior with
4499 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
4500 *
Craig Mautner026596b2014-05-21 15:35:44 -07004501 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
4502 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
4503 * equivalent of the Activity manifest specifying {@link
4504 * android.R.attr#documentLaunchMode}="intoExisting". When used with
4505 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
4506 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07004507 *
Craig Mautner026596b2014-05-21 15:35:44 -07004508 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07004509 *
Craig Mautner026596b2014-05-21 15:35:44 -07004510 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07004511 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4512 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07004513 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07004514 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004515 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004516 * callback from occurring on the current frontmost activity before it is
4517 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07004518 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004519 * <p>Typically, an activity can rely on that callback to indicate that an
4520 * explicit user action has caused their activity to be moved out of the
4521 * foreground. The callback marks an appropriate point in the activity's
4522 * lifecycle for it to dismiss any notifications that it intends to display
4523 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07004524 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004525 * <p>If an activity is ever started via any non-user-driven events such as
4526 * phone-call receipt or an alarm handler, this flag should be passed to {@link
4527 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07004528 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004529 */
4530 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004531 /**
4532 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4533 * this flag will cause the launched activity to be brought to the front of its
4534 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07004535 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004536 * <p>For example, consider a task consisting of four activities: A, B, C, D.
4537 * If D calls startActivity() with an Intent that resolves to the component
4538 * of activity B, then B will be brought to the front of the history stack,
4539 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07004540 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004541 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07004542 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004543 */
4544 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004545 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004546 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4547 * this flag will prevent the system from applying an activity transition
4548 * animation to go to the next activity state. This doesn't mean an
4549 * animation will never run -- if another activity change happens that doesn't
4550 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004551 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07004552 * when you are going to do a series of activity operations but the
4553 * animation seen by the user shouldn't be driven by the first activity
4554 * change but rather a later one.
4555 */
4556 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
4557 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08004558 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4559 * this flag will cause any existing task that would be associated with the
4560 * activity to be cleared before the activity is started. That is, the activity
4561 * becomes the new root of an otherwise empty task, and any old activities
4562 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4563 */
4564 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
4565 /**
4566 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
4567 * this flag will cause a newly launching task to be placed on top of the current
4568 * home activity task (if there is one). That is, pressing back from the task
4569 * will always return the user to home even if that was not the last activity they
4570 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
4571 */
4572 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
4573 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07004574 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
4575 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004576 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07004577 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07004578 * this flag. When set and the task's activity is finished, the recents
4579 * entry will remain in the interface for the user to re-launch it, like a
4580 * recents entry for a top-level application.
4581 * <p>
4582 * The receiving activity can override this request with
4583 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
4584 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07004585 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07004586 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07004587 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07004588
4589 /**
Filip Gruszczynski80e29f12015-12-14 14:58:30 -08004590 * This flag is only used in the multi-window mode. The new activity will be displayed on
4591 * the other side than the one that is launching it. This can only be used in conjunction with
4592 * {@link #FLAG_ACTIVITY_NEW_TASK}.
4593 */
4594 public static final int FLAG_ACTIVITY_LAUNCH_TO_SIDE = 0x00001000;
4595
4596 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004597 * If set, when sending a broadcast only registered receivers will be
4598 * called -- no BroadcastReceiver components will be launched.
4599 */
4600 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004601 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004602 * If set, when sending a broadcast the new broadcast will replace
4603 * any existing pending broadcast that matches it. Matching is defined
4604 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
4605 * true for the intents of the two broadcasts. When a match is found,
4606 * the new broadcast (and receivers associated with it) will replace the
4607 * existing one in the pending broadcast list, remaining at the same
4608 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08004609 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08004610 * <p>This flag is most typically used with sticky broadcasts, which
4611 * only care about delivering the most recent values of the broadcast
4612 * to their receivers.
4613 */
4614 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
4615 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08004616 * If set, when sending a broadcast the recipient is allowed to run at
4617 * foreground priority, with a shorter timeout interval. During normal
4618 * broadcasts the receivers are not automatically hoisted out of the
4619 * background priority class.
4620 */
4621 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
4622 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07004623 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
4624 * They can still propagate results through to later receivers, but they can not prevent
4625 * later receivers from seeing the broadcast.
4626 */
4627 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
4628 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004629 * If set, when sending a broadcast <i>before boot has completed</i> only
4630 * registered receivers will be called -- no BroadcastReceiver components
4631 * will be launched. Sticky intent state will be recorded properly even
4632 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
4633 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07004634 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004635 * <p>This flag is only for use by system sevices as a convenience to
4636 * avoid having to implement a more complex mechanism around detection
4637 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07004638 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004639 * @hide
4640 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004641 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07004642 /**
4643 * Set when this broadcast is for a boot upgrade, a special mode that
4644 * allows the broadcast to be sent before the system is ready and launches
4645 * the app process with no providers running in it.
4646 * @hide
4647 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07004648 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
Dianne Hackborn6ac42ae2015-12-08 17:22:10 -08004649 /**
4650 * If set, the broadcast will always go to manifest receivers in background (cached
4651 * or not running) apps, regardless of whether that would be done by default. By
4652 * default they will only receive broadcasts if the broadcast has specified an
4653 * explicit component or package name.
4654 * @hide
4655 */
4656 public static final int FLAG_RECEIVER_INCLUDE_BACKGROUND = 0x01000000;
4657 /**
4658 * If set, the broadcast will never go to manifest receivers in background (cached
4659 * or not running) apps, regardless of whether that would be done by default. By
4660 * default they will receive broadcasts if the broadcast has specified an
4661 * explicit component or package name.
4662 * @hide
4663 */
4664 public static final int FLAG_RECEIVER_EXCLUDE_BACKGROUND = 0x00800000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004665
Dianne Hackbornfa82f222009-09-17 15:14:12 -07004666 /**
4667 * @hide Flags that can't be changed with PendingIntent.
4668 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07004669 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
4670 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
4671 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08004672
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004673 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004674 // ---------------------------------------------------------------------
4675 // toUri() and parseUri() options.
4676
4677 /**
4678 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4679 * always has the "intent:" scheme. This syntax can be used when you want
4680 * to later disambiguate between URIs that are intended to describe an
4681 * Intent vs. all others that should be treated as raw URIs. When used
4682 * with {@link #parseUri}, any other scheme will result in a generic
4683 * VIEW action for that raw URI.
4684 */
4685 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08004686
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004687 /**
4688 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
4689 * always has the "android-app:" scheme. This is a variation of
4690 * {@link #URI_INTENT_SCHEME} whose format is simpler for the case of an
4691 * http/https URI being delivered to a specific package name. The format
4692 * is:
4693 *
4694 * <pre class="prettyprint">
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004695 * android-app://{package_id}[/{scheme}[/{host}[/{path}]]][#Intent;{...}]</pre>
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004696 *
Dianne Hackborn0ee10f62015-01-14 16:16:13 -08004697 * <p>In this scheme, only the <code>package_id</code> is required. If you include a host,
4698 * you must also include a scheme; including a path also requires both a host and a scheme.
4699 * The final #Intent; fragment can be used without a scheme, host, or path.
4700 * Note that this can not be
Dianne Hackborn85d558c2014-11-04 10:31:54 -08004701 * used with intents that have a {@link #setSelector}, since the base intent
4702 * will always have an explicit package name.</p>
4703 *
4704 * <p>Some examples of how this scheme maps to Intent objects:</p>
4705 * <table border="2" width="85%" align="center" frame="hsides" rules="rows">
4706 * <colgroup align="left" />
4707 * <colgroup align="left" />
4708 * <thead>
4709 * <tr><th>URI</th> <th>Intent</th></tr>
4710 * </thead>
4711 *
4712 * <tbody>
4713 * <tr><td><code>android-app://com.example.app</code></td>
4714 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4715 * <tr><td>Action: </td><td>{@link #ACTION_MAIN}</td></tr>
4716 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4717 * </table></td>
4718 * </tr>
4719 * <tr><td><code>android-app://com.example.app/http/example.com</code></td>
4720 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4721 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4722 * <tr><td>Data: </td><td><code>http://example.com/</code></td></tr>
4723 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4724 * </table></td>
4725 * </tr>
4726 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234</code></td>
4727 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4728 * <tr><td>Action: </td><td>{@link #ACTION_VIEW}</td></tr>
4729 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</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/<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>Package: </td><td><code>com.example.app</code></td></tr>
4737 * </table></td>
4738 * </tr>
4739 * <tr><td><code>android-app://com.example.app/http/example.com/foo?1234<br />#Intent;action=com.example.MY_ACTION;end</code></td>
4740 * <td><table style="margin:0;border:0;cellpadding:0;cellspacing:0">
4741 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4742 * <tr><td>Data: </td><td><code>http://example.com/foo?1234</code></td></tr>
4743 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4744 * </table></td>
4745 * </tr>
4746 * <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>
4747 * <td><table border="" style="margin:0" >
4748 * <tr><td>Action: </td><td><code>com.example.MY_ACTION</code></td></tr>
4749 * <tr><td>Package: </td><td><code>com.example.app</code></td></tr>
4750 * <tr><td>Extras: </td><td><code>some_int=(int)100<br />some_str=(String)hello</code></td></tr>
4751 * </table></td>
4752 * </tr>
4753 * </tbody>
4754 * </table>
4755 */
4756 public static final int URI_ANDROID_APP_SCHEME = 1<<1;
4757
Dianne Hackborn24b1c232014-11-20 17:17:39 -08004758 /**
4759 * Flag for use with {@link #toUri} and {@link #parseUri}: allow parsing
4760 * of unsafe information. In particular, the flags {@link #FLAG_GRANT_READ_URI_PERMISSION},
4761 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, {@link #FLAG_GRANT_PERSISTABLE_URI_PERMISSION},
4762 * and {@link #FLAG_GRANT_PREFIX_URI_PERMISSION} flags can not be set, so that the
4763 * generated Intent can not cause unexpected data access to happen.
4764 *
4765 * <p>If you do not trust the source of the URI being parsed, you should still do further
4766 * processing to protect yourself from it. In particular, when using it to start an
4767 * activity you should usually add in {@link #CATEGORY_BROWSABLE} to limit the activities
4768 * that can handle it.</p>
4769 */
4770 public static final int URI_ALLOW_UNSAFE = 1<<2;
4771
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004772 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004773
4774 private String mAction;
4775 private Uri mData;
4776 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004777 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004778 private ComponentName mComponent;
4779 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004780 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004781 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004782 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004783 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004784 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004785 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004786
4787 // ---------------------------------------------------------------------
4788
4789 /**
4790 * Create an empty intent.
4791 */
4792 public Intent() {
4793 }
4794
4795 /**
4796 * Copy constructor.
4797 */
4798 public Intent(Intent o) {
4799 this.mAction = o.mAction;
4800 this.mData = o.mData;
4801 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004802 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004803 this.mComponent = o.mComponent;
4804 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004805 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004806 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004807 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004808 }
4809 if (o.mExtras != null) {
4810 this.mExtras = new Bundle(o.mExtras);
4811 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004812 if (o.mSourceBounds != null) {
4813 this.mSourceBounds = new Rect(o.mSourceBounds);
4814 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004815 if (o.mSelector != null) {
4816 this.mSelector = new Intent(o.mSelector);
4817 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004818 if (o.mClipData != null) {
4819 this.mClipData = new ClipData(o.mClipData);
4820 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004821 }
4822
4823 @Override
4824 public Object clone() {
4825 return new Intent(this);
4826 }
4827
4828 private Intent(Intent o, boolean all) {
4829 this.mAction = o.mAction;
4830 this.mData = o.mData;
4831 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004832 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004833 this.mComponent = o.mComponent;
4834 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004835 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836 }
4837 }
4838
4839 /**
4840 * Make a clone of only the parts of the Intent that are relevant for
4841 * filter matching: the action, data, type, component, and categories.
4842 */
4843 public Intent cloneFilter() {
4844 return new Intent(this, false);
4845 }
4846
4847 /**
4848 * Create an intent with a given action. All other fields (data, type,
4849 * class) are null. Note that the action <em>must</em> be in a
4850 * namespace because Intents are used globally in the system -- for
4851 * example the system VIEW action is android.intent.action.VIEW; an
4852 * application's custom action would be something like
4853 * com.google.app.myapp.CUSTOM_ACTION.
4854 *
4855 * @param action The Intent action, such as ACTION_VIEW.
4856 */
4857 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004858 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004859 }
4860
4861 /**
4862 * Create an intent with a given action and for a given data url. Note
4863 * that the action <em>must</em> be in a namespace because Intents are
4864 * used globally in the system -- for example the system VIEW action is
4865 * android.intent.action.VIEW; an application's custom action would be
4866 * something like com.google.app.myapp.CUSTOM_ACTION.
4867 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004868 * <p><em>Note: scheme and host name matching in the Android framework is
4869 * case-sensitive, unlike the formal RFC. As a result,
4870 * you should always ensure that you write your Uri with these elements
4871 * using lower case letters, and normalize any Uris you receive from
4872 * outside of Android to ensure the scheme and host is lower case.</em></p>
4873 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 * @param action The Intent action, such as ACTION_VIEW.
4875 * @param uri The Intent data URI.
4876 */
4877 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004878 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004879 mData = uri;
4880 }
4881
4882 /**
4883 * Create an intent for a specific component. All other fields (action, data,
4884 * type, class) are null, though they can be modified later with explicit
4885 * calls. This provides a convenient way to create an intent that is
4886 * intended to execute a hard-coded class name, rather than relying on the
4887 * system to find an appropriate class for you; see {@link #setComponent}
4888 * for more information on the repercussions of this.
4889 *
4890 * @param packageContext A Context of the application package implementing
4891 * this class.
4892 * @param cls The component class that is to be used for the intent.
4893 *
4894 * @see #setClass
4895 * @see #setComponent
4896 * @see #Intent(String, android.net.Uri , Context, Class)
4897 */
4898 public Intent(Context packageContext, Class<?> cls) {
4899 mComponent = new ComponentName(packageContext, cls);
4900 }
4901
4902 /**
4903 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004904 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004905 * construct the Intent and then calling {@link #setClass} to set its
4906 * class.
4907 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004908 * <p><em>Note: scheme and host name matching in the Android framework is
4909 * case-sensitive, unlike the formal RFC. As a result,
4910 * you should always ensure that you write your Uri with these elements
4911 * using lower case letters, and normalize any Uris you receive from
4912 * outside of Android to ensure the scheme and host is lower case.</em></p>
4913 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004914 * @param action The Intent action, such as ACTION_VIEW.
4915 * @param uri The Intent data URI.
4916 * @param packageContext A Context of the application package implementing
4917 * this class.
4918 * @param cls The component class that is to be used for the intent.
4919 *
4920 * @see #Intent(String, android.net.Uri)
4921 * @see #Intent(Context, Class)
4922 * @see #setClass
4923 * @see #setComponent
4924 */
4925 public Intent(String action, Uri uri,
4926 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004927 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004928 mData = uri;
4929 mComponent = new ComponentName(packageContext, cls);
4930 }
4931
4932 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004933 * Create an intent to launch the main (root) activity of a task. This
4934 * is the Intent that is started when the application's is launched from
4935 * Home. For anything else that wants to launch an application in the
4936 * same way, it is important that they use an Intent structured the same
4937 * way, and can use this function to ensure this is the case.
4938 *
4939 * <p>The returned Intent has the given Activity component as its explicit
4940 * component, {@link #ACTION_MAIN} as its action, and includes the
4941 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4942 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4943 * to do that through {@link #addFlags(int)} on the returned Intent.
4944 *
4945 * @param mainActivity The main activity component that this Intent will
4946 * launch.
4947 * @return Returns a newly created Intent that can be used to launch the
4948 * activity as a main application entry.
4949 *
4950 * @see #setClass
4951 * @see #setComponent
4952 */
4953 public static Intent makeMainActivity(ComponentName mainActivity) {
4954 Intent intent = new Intent(ACTION_MAIN);
4955 intent.setComponent(mainActivity);
4956 intent.addCategory(CATEGORY_LAUNCHER);
4957 return intent;
4958 }
4959
4960 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004961 * Make an Intent for the main activity of an application, without
4962 * specifying a specific activity to run but giving a selector to find
4963 * the activity. This results in a final Intent that is structured
4964 * the same as when the application is launched from
4965 * Home. For anything else that wants to launch an application in the
4966 * same way, it is important that they use an Intent structured the same
4967 * way, and can use this function to ensure this is the case.
4968 *
4969 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4970 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4971 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4972 * to do that through {@link #addFlags(int)} on the returned Intent.
4973 *
4974 * @param selectorAction The action name of the Intent's selector.
4975 * @param selectorCategory The name of a category to add to the Intent's
4976 * selector.
4977 * @return Returns a newly created Intent that can be used to launch the
4978 * activity as a main application entry.
4979 *
4980 * @see #setSelector(Intent)
4981 */
4982 public static Intent makeMainSelectorActivity(String selectorAction,
4983 String selectorCategory) {
4984 Intent intent = new Intent(ACTION_MAIN);
4985 intent.addCategory(CATEGORY_LAUNCHER);
4986 Intent selector = new Intent();
4987 selector.setAction(selectorAction);
4988 selector.addCategory(selectorCategory);
4989 intent.setSelector(selector);
4990 return intent;
4991 }
4992
4993 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004994 * Make an Intent that can be used to re-launch an application's task
4995 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4996 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4997 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4998 *
4999 * @param mainActivity The activity component that is the root of the
5000 * task; this is the activity that has been published in the application's
5001 * manifest as the main launcher icon.
5002 *
5003 * @return Returns a newly created Intent that can be used to relaunch the
5004 * activity's task in its root state.
5005 */
5006 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
5007 Intent intent = makeMainActivity(mainActivity);
5008 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
5009 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
5010 return intent;
5011 }
5012
5013 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005014 * Call {@link #parseUri} with 0 flags.
5015 * @deprecated Use {@link #parseUri} instead.
5016 */
5017 @Deprecated
5018 public static Intent getIntent(String uri) throws URISyntaxException {
5019 return parseUri(uri, 0);
5020 }
Tom Taylord4a47292009-12-21 13:59:18 -08005021
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005022 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005023 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005024 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07005025 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005026 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005027 *
5028 * <p>The URI given here must not be relative -- that is, it must include
5029 * the scheme and full path.
5030 *
5031 * @param uri The URI to turn into an Intent.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005032 * @param flags Additional processing flags. Either 0,
5033 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 *
5035 * @return Intent The newly created Intent object.
5036 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005037 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
5038 * it bad (as parsed by the Uri class) or the Intent data within the
5039 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08005040 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005041 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005042 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005043 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005044 int i = 0;
5045 try {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005046 final boolean androidApp = uri.startsWith("android-app:");
5047
5048 // Validate intent scheme if requested.
5049 if ((flags&(URI_INTENT_SCHEME|URI_ANDROID_APP_SCHEME)) != 0) {
5050 if (!uri.startsWith("intent:") && !androidApp) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005051 Intent intent = new Intent(ACTION_VIEW);
5052 try {
5053 intent.setData(Uri.parse(uri));
5054 } catch (IllegalArgumentException e) {
5055 throw new URISyntaxException(uri, e.getMessage());
5056 }
5057 return intent;
5058 }
5059 }
Tom Taylord4a47292009-12-21 13:59:18 -08005060
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005061 i = uri.lastIndexOf("#");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005062 // simple case
5063 if (i == -1) {
5064 if (!androidApp) {
5065 return new Intent(ACTION_VIEW, Uri.parse(uri));
5066 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005067
5068 // old format Intent URI
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005069 } else if (!uri.startsWith("#Intent;", i)) {
5070 if (!androidApp) {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005071 return getIntentOld(uri, flags);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005072 } else {
5073 i = -1;
5074 }
5075 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005076
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005077 // new format
5078 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005079 Intent baseIntent = intent;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005080 boolean explicitAction = false;
5081 boolean inSelector = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005082
5083 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005084 String scheme = null;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005085 String data;
5086 if (i >= 0) {
5087 data = uri.substring(0, i);
5088 i += 8; // length of "#Intent;"
5089 } else {
5090 data = uri;
5091 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005092
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005093 // loop over contents of Intent, all name=value;
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005094 while (i >= 0 && !uri.startsWith("end", i)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005095 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005096 if (eq < 0) eq = i-1;
5097 int semi = uri.indexOf(';', i);
5098 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005099
5100 // action
5101 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005102 intent.setAction(value);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005103 if (!inSelector) {
5104 explicitAction = true;
5105 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 }
5107
5108 // categories
5109 else if (uri.startsWith("category=", i)) {
5110 intent.addCategory(value);
5111 }
5112
5113 // type
5114 else if (uri.startsWith("type=", i)) {
5115 intent.mType = value;
5116 }
5117
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005118 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005119 else if (uri.startsWith("launchFlags=", i)) {
5120 intent.mFlags = Integer.decode(value).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005121 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5122 intent.mFlags &= ~IMMUTABLE_FLAGS;
5123 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005124 }
5125
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005126 // package
5127 else if (uri.startsWith("package=", i)) {
5128 intent.mPackage = value;
5129 }
5130
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005131 // component
5132 else if (uri.startsWith("component=", i)) {
5133 intent.mComponent = ComponentName.unflattenFromString(value);
5134 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005135
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005136 // scheme
5137 else if (uri.startsWith("scheme=", i)) {
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005138 if (inSelector) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005139 intent.mData = Uri.parse(value + ":");
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005140 } else {
5141 scheme = value;
5142 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005143 }
5144
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005145 // source bounds
5146 else if (uri.startsWith("sourceBounds=", i)) {
5147 intent.mSourceBounds = Rect.unflattenFromString(value);
5148 }
5149
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005150 // selector
5151 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
5152 intent = new Intent();
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005153 inSelector = true;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005154 }
5155
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005156 // extra
5157 else {
5158 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005159 // create Bundle if it doesn't already exist
5160 if (intent.mExtras == null) intent.mExtras = new Bundle();
5161 Bundle b = intent.mExtras;
5162 // add EXTRA
5163 if (uri.startsWith("S.", i)) b.putString(key, value);
5164 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
5165 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
5166 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
5167 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
5168 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
5169 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
5170 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
5171 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
5172 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
5173 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005174
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 // move to the next item
5176 i = semi + 1;
5177 }
5178
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005179 if (inSelector) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005180 // The Intent had a selector; fix it up.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005181 if (baseIntent.mPackage == null) {
5182 baseIntent.setSelector(intent);
5183 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005184 intent = baseIntent;
5185 }
5186
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005187 if (data != null) {
5188 if (data.startsWith("intent:")) {
5189 data = data.substring(7);
5190 if (scheme != null) {
5191 data = scheme + ':' + data;
5192 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005193 } else if (data.startsWith("android-app:")) {
5194 if (data.charAt(12) == '/' && data.charAt(13) == '/') {
5195 // Correctly formed android-app, first part is package name.
5196 int end = data.indexOf('/', 14);
5197 if (end < 0) {
5198 // All we have is a package name.
5199 intent.mPackage = data.substring(14);
5200 if (!explicitAction) {
5201 intent.setAction(ACTION_MAIN);
5202 }
5203 data = "";
5204 } else {
5205 // Target the Intent at the given package name always.
5206 String authority = null;
5207 intent.mPackage = data.substring(14, end);
5208 int newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005209 if ((end+1) < data.length()) {
5210 if ((newEnd=data.indexOf('/', end+1)) >= 0) {
5211 // Found a scheme, remember it.
5212 scheme = data.substring(end+1, newEnd);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005213 end = newEnd;
Dianne Hackborn80b1c562014-12-09 20:22:08 -08005214 if (end < data.length() && (newEnd=data.indexOf('/', end+1)) >= 0) {
5215 // Found a authority, remember it.
5216 authority = data.substring(end+1, newEnd);
5217 end = newEnd;
5218 }
5219 } else {
5220 // All we have is a scheme.
5221 scheme = data.substring(end+1);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08005222 }
5223 }
5224 if (scheme == null) {
5225 // If there was no scheme, then this just targets the package.
5226 if (!explicitAction) {
5227 intent.setAction(ACTION_MAIN);
5228 }
5229 data = "";
5230 } else if (authority == null) {
5231 data = scheme + ":";
5232 } else {
5233 data = scheme + "://" + authority + data.substring(end);
5234 }
5235 }
5236 } else {
5237 data = "";
5238 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005239 }
Tom Taylord4a47292009-12-21 13:59:18 -08005240
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005241 if (data.length() > 0) {
5242 try {
5243 intent.mData = Uri.parse(data);
5244 } catch (IllegalArgumentException e) {
5245 throw new URISyntaxException(uri, e.getMessage());
5246 }
5247 }
5248 }
Tom Taylord4a47292009-12-21 13:59:18 -08005249
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005250 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07005251
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005252 } catch (IndexOutOfBoundsException e) {
5253 throw new URISyntaxException(uri, "illegal Intent URI format", i);
5254 }
5255 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005256
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005257 public static Intent getIntentOld(String uri) throws URISyntaxException {
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005258 return getIntentOld(uri, 0);
5259 }
5260
5261 private static Intent getIntentOld(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005262 Intent intent;
5263
5264 int i = uri.lastIndexOf('#');
5265 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005266 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005267 final int intentFragmentStart = i;
5268 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005269
5270 i++;
5271
5272 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005273 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005274 i += 7;
5275 int j = uri.indexOf(')', i);
5276 action = uri.substring(i, j);
5277 i = j + 1;
5278 }
5279
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005280 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005281
5282 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005283 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005284 i += 11;
5285 int j = uri.indexOf(')', i);
5286 while (i < j) {
5287 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07005288 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005289 if (i < sep) {
5290 intent.addCategory(uri.substring(i, sep));
5291 }
5292 i = sep + 1;
5293 }
5294 i = j + 1;
5295 }
5296
5297 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005298 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005299 i += 5;
5300 int j = uri.indexOf(')', i);
5301 intent.mType = uri.substring(i, j);
5302 i = j + 1;
5303 }
5304
5305 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005306 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005307 i += 12;
5308 int j = uri.indexOf(')', i);
5309 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
Dianne Hackborn24b1c232014-11-20 17:17:39 -08005310 if ((flags& URI_ALLOW_UNSAFE) == 0) {
5311 intent.mFlags &= ~IMMUTABLE_FLAGS;
5312 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 i = j + 1;
5314 }
5315
5316 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005317 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005318 i += 10;
5319 int j = uri.indexOf(')', i);
5320 int sep = uri.indexOf('!', i);
5321 if (sep >= 0 && sep < j) {
5322 String pkg = uri.substring(i, sep);
5323 String cls = uri.substring(sep + 1, j);
5324 intent.mComponent = new ComponentName(pkg, cls);
5325 }
5326 i = j + 1;
5327 }
5328
5329 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005330 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005331 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07005332
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005333 final int closeParen = uri.indexOf(')', i);
5334 if (closeParen == -1) throw new URISyntaxException(uri,
5335 "EXTRA missing trailing ')'", i);
5336
5337 while (i < closeParen) {
5338 // fetch the key value
5339 int j = uri.indexOf('=', i);
5340 if (j <= i + 1 || i >= closeParen) {
5341 throw new URISyntaxException(uri, "EXTRA missing '='", i);
5342 }
5343 char type = uri.charAt(i);
5344 i++;
5345 String key = uri.substring(i, j);
5346 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07005347
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005348 // get type-value
5349 j = uri.indexOf('!', i);
5350 if (j == -1 || j >= closeParen) j = closeParen;
5351 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5352 String value = uri.substring(i, j);
5353 i = j;
5354
5355 // create Bundle if it doesn't already exist
5356 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07005357
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005358 // add item to bundle
5359 try {
5360 switch (type) {
5361 case 'S':
5362 intent.mExtras.putString(key, Uri.decode(value));
5363 break;
5364 case 'B':
5365 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
5366 break;
5367 case 'b':
5368 intent.mExtras.putByte(key, Byte.parseByte(value));
5369 break;
5370 case 'c':
5371 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
5372 break;
5373 case 'd':
5374 intent.mExtras.putDouble(key, Double.parseDouble(value));
5375 break;
5376 case 'f':
5377 intent.mExtras.putFloat(key, Float.parseFloat(value));
5378 break;
5379 case 'i':
5380 intent.mExtras.putInt(key, Integer.parseInt(value));
5381 break;
5382 case 'l':
5383 intent.mExtras.putLong(key, Long.parseLong(value));
5384 break;
5385 case 's':
5386 intent.mExtras.putShort(key, Short.parseShort(value));
5387 break;
5388 default:
5389 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
5390 }
5391 } catch (NumberFormatException e) {
5392 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
5393 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 char ch = uri.charAt(i);
5396 if (ch == ')') break;
5397 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
5398 i++;
5399 }
5400 }
5401
Dianne Hackborn6cca1592009-09-20 12:40:03 -07005402 if (isIntentFragment) {
5403 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
5404 } else {
5405 intent.mData = Uri.parse(uri);
5406 }
Tom Taylord4a47292009-12-21 13:59:18 -08005407
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005408 if (intent.mAction == null) {
5409 // By default, if no action is specified, then use VIEW.
5410 intent.mAction = ACTION_VIEW;
5411 }
5412
5413 } else {
5414 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
5415 }
5416
5417 return intent;
5418 }
5419
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005420 /** @hide */
5421 public interface CommandOptionHandler {
5422 boolean handleOption(String opt, ShellCommand cmd);
5423 }
5424
5425 /** @hide */
5426 public static Intent parseCommandArgs(ShellCommand cmd, CommandOptionHandler optionHandler)
5427 throws URISyntaxException {
5428 Intent intent = new Intent();
5429 Intent baseIntent = intent;
5430 boolean hasIntentInfo = false;
5431
5432 Uri data = null;
5433 String type = null;
5434
5435 String opt;
5436 while ((opt=cmd.getNextOption()) != null) {
5437 switch (opt) {
5438 case "-a":
5439 intent.setAction(cmd.getNextArgRequired());
5440 if (intent == baseIntent) {
5441 hasIntentInfo = true;
5442 }
5443 break;
5444 case "-d":
5445 data = Uri.parse(cmd.getNextArgRequired());
5446 if (intent == baseIntent) {
5447 hasIntentInfo = true;
5448 }
5449 break;
5450 case "-t":
5451 type = cmd.getNextArgRequired();
5452 if (intent == baseIntent) {
5453 hasIntentInfo = true;
5454 }
5455 break;
5456 case "-c":
5457 intent.addCategory(cmd.getNextArgRequired());
5458 if (intent == baseIntent) {
5459 hasIntentInfo = true;
5460 }
5461 break;
5462 case "-e":
5463 case "--es": {
5464 String key = cmd.getNextArgRequired();
5465 String value = cmd.getNextArgRequired();
5466 intent.putExtra(key, value);
5467 }
5468 break;
5469 case "--esn": {
5470 String key = cmd.getNextArgRequired();
5471 intent.putExtra(key, (String) null);
5472 }
5473 break;
5474 case "--ei": {
5475 String key = cmd.getNextArgRequired();
5476 String value = cmd.getNextArgRequired();
5477 intent.putExtra(key, Integer.decode(value));
5478 }
5479 break;
5480 case "--eu": {
5481 String key = cmd.getNextArgRequired();
5482 String value = cmd.getNextArgRequired();
5483 intent.putExtra(key, Uri.parse(value));
5484 }
5485 break;
5486 case "--ecn": {
5487 String key = cmd.getNextArgRequired();
5488 String value = cmd.getNextArgRequired();
5489 ComponentName cn = ComponentName.unflattenFromString(value);
5490 if (cn == null)
5491 throw new IllegalArgumentException("Bad component name: " + value);
5492 intent.putExtra(key, cn);
5493 }
5494 break;
5495 case "--eia": {
5496 String key = cmd.getNextArgRequired();
5497 String value = cmd.getNextArgRequired();
5498 String[] strings = value.split(",");
5499 int[] list = new int[strings.length];
5500 for (int i = 0; i < strings.length; i++) {
5501 list[i] = Integer.decode(strings[i]);
5502 }
5503 intent.putExtra(key, list);
5504 }
5505 break;
5506 case "--eial": {
5507 String key = cmd.getNextArgRequired();
5508 String value = cmd.getNextArgRequired();
5509 String[] strings = value.split(",");
5510 ArrayList<Integer> list = new ArrayList<>(strings.length);
5511 for (int i = 0; i < strings.length; i++) {
5512 list.add(Integer.decode(strings[i]));
5513 }
5514 intent.putExtra(key, list);
5515 }
5516 break;
5517 case "--el": {
5518 String key = cmd.getNextArgRequired();
5519 String value = cmd.getNextArgRequired();
5520 intent.putExtra(key, Long.valueOf(value));
5521 }
5522 break;
5523 case "--ela": {
5524 String key = cmd.getNextArgRequired();
5525 String value = cmd.getNextArgRequired();
5526 String[] strings = value.split(",");
5527 long[] list = new long[strings.length];
5528 for (int i = 0; i < strings.length; i++) {
5529 list[i] = Long.valueOf(strings[i]);
5530 }
5531 intent.putExtra(key, list);
5532 hasIntentInfo = true;
5533 }
5534 break;
5535 case "--elal": {
5536 String key = cmd.getNextArgRequired();
5537 String value = cmd.getNextArgRequired();
5538 String[] strings = value.split(",");
5539 ArrayList<Long> list = new ArrayList<>(strings.length);
5540 for (int i = 0; i < strings.length; i++) {
5541 list.add(Long.valueOf(strings[i]));
5542 }
5543 intent.putExtra(key, list);
5544 hasIntentInfo = true;
5545 }
5546 break;
5547 case "--ef": {
5548 String key = cmd.getNextArgRequired();
5549 String value = cmd.getNextArgRequired();
5550 intent.putExtra(key, Float.valueOf(value));
5551 hasIntentInfo = true;
5552 }
5553 break;
5554 case "--efa": {
5555 String key = cmd.getNextArgRequired();
5556 String value = cmd.getNextArgRequired();
5557 String[] strings = value.split(",");
5558 float[] list = new float[strings.length];
5559 for (int i = 0; i < strings.length; i++) {
5560 list[i] = Float.valueOf(strings[i]);
5561 }
5562 intent.putExtra(key, list);
5563 hasIntentInfo = true;
5564 }
5565 break;
5566 case "--efal": {
5567 String key = cmd.getNextArgRequired();
5568 String value = cmd.getNextArgRequired();
5569 String[] strings = value.split(",");
5570 ArrayList<Float> list = new ArrayList<>(strings.length);
5571 for (int i = 0; i < strings.length; i++) {
5572 list.add(Float.valueOf(strings[i]));
5573 }
5574 intent.putExtra(key, list);
5575 hasIntentInfo = true;
5576 }
5577 break;
5578 case "--esa": {
5579 String key = cmd.getNextArgRequired();
5580 String value = cmd.getNextArgRequired();
5581 // Split on commas unless they are preceeded by an escape.
5582 // The escape character must be escaped for the string and
5583 // again for the regex, thus four escape characters become one.
5584 String[] strings = value.split("(?<!\\\\),");
5585 intent.putExtra(key, strings);
5586 hasIntentInfo = true;
5587 }
5588 break;
5589 case "--esal": {
5590 String key = cmd.getNextArgRequired();
5591 String value = cmd.getNextArgRequired();
5592 // Split on commas unless they are preceeded by an escape.
5593 // The escape character must be escaped for the string and
5594 // again for the regex, thus four escape characters become one.
5595 String[] strings = value.split("(?<!\\\\),");
5596 ArrayList<String> list = new ArrayList<>(strings.length);
5597 for (int i = 0; i < strings.length; i++) {
5598 list.add(strings[i]);
5599 }
5600 intent.putExtra(key, list);
5601 hasIntentInfo = true;
5602 }
5603 break;
5604 case "--ez": {
5605 String key = cmd.getNextArgRequired();
5606 String value = cmd.getNextArgRequired().toLowerCase();
5607 // Boolean.valueOf() results in false for anything that is not "true", which is
5608 // error-prone in shell commands
5609 boolean arg;
5610 if ("true".equals(value) || "t".equals(value)) {
5611 arg = true;
5612 } else if ("false".equals(value) || "f".equals(value)) {
5613 arg = false;
5614 } else {
5615 try {
5616 arg = Integer.decode(value) != 0;
5617 } catch (NumberFormatException ex) {
5618 throw new IllegalArgumentException("Invalid boolean value: " + value);
5619 }
5620 }
5621
5622 intent.putExtra(key, arg);
5623 }
5624 break;
5625 case "-n": {
5626 String str = cmd.getNextArgRequired();
5627 ComponentName cn = ComponentName.unflattenFromString(str);
5628 if (cn == null)
5629 throw new IllegalArgumentException("Bad component name: " + str);
5630 intent.setComponent(cn);
5631 if (intent == baseIntent) {
5632 hasIntentInfo = true;
5633 }
5634 }
5635 break;
5636 case "-p": {
5637 String str = cmd.getNextArgRequired();
5638 intent.setPackage(str);
5639 if (intent == baseIntent) {
5640 hasIntentInfo = true;
5641 }
5642 }
5643 break;
5644 case "-f":
5645 String str = cmd.getNextArgRequired();
5646 intent.setFlags(Integer.decode(str).intValue());
5647 break;
5648 case "--grant-read-uri-permission":
5649 intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
5650 break;
5651 case "--grant-write-uri-permission":
5652 intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
5653 break;
5654 case "--grant-persistable-uri-permission":
5655 intent.addFlags(Intent.FLAG_GRANT_PERSISTABLE_URI_PERMISSION);
5656 break;
5657 case "--grant-prefix-uri-permission":
5658 intent.addFlags(Intent.FLAG_GRANT_PREFIX_URI_PERMISSION);
5659 break;
5660 case "--exclude-stopped-packages":
5661 intent.addFlags(Intent.FLAG_EXCLUDE_STOPPED_PACKAGES);
5662 break;
5663 case "--include-stopped-packages":
5664 intent.addFlags(Intent.FLAG_INCLUDE_STOPPED_PACKAGES);
5665 break;
5666 case "--debug-log-resolution":
5667 intent.addFlags(Intent.FLAG_DEBUG_LOG_RESOLUTION);
5668 break;
5669 case "--activity-brought-to-front":
5670 intent.addFlags(Intent.FLAG_ACTIVITY_BROUGHT_TO_FRONT);
5671 break;
5672 case "--activity-clear-top":
5673 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
5674 break;
5675 case "--activity-clear-when-task-reset":
5676 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET);
5677 break;
5678 case "--activity-exclude-from-recents":
5679 intent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
5680 break;
5681 case "--activity-launched-from-history":
5682 intent.addFlags(Intent.FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY);
5683 break;
5684 case "--activity-multiple-task":
5685 intent.addFlags(Intent.FLAG_ACTIVITY_MULTIPLE_TASK);
5686 break;
5687 case "--activity-no-animation":
5688 intent.addFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
5689 break;
5690 case "--activity-no-history":
5691 intent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
5692 break;
5693 case "--activity-no-user-action":
5694 intent.addFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION);
5695 break;
5696 case "--activity-previous-is-top":
5697 intent.addFlags(Intent.FLAG_ACTIVITY_PREVIOUS_IS_TOP);
5698 break;
5699 case "--activity-reorder-to-front":
5700 intent.addFlags(Intent.FLAG_ACTIVITY_REORDER_TO_FRONT);
5701 break;
5702 case "--activity-reset-task-if-needed":
5703 intent.addFlags(Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
5704 break;
5705 case "--activity-single-top":
5706 intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);
5707 break;
5708 case "--activity-clear-task":
5709 intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
5710 break;
5711 case "--activity-task-on-home":
5712 intent.addFlags(Intent.FLAG_ACTIVITY_TASK_ON_HOME);
5713 break;
5714 case "--receiver-registered-only":
5715 intent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
5716 break;
5717 case "--receiver-replace-pending":
5718 intent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING);
5719 break;
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005720 case "--receiver-foreground":
5721 intent.addFlags(Intent.FLAG_RECEIVER_FOREGROUND);
5722 break;
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005723 case "--selector":
5724 intent.setDataAndType(data, type);
5725 intent = new Intent();
5726 break;
5727 default:
5728 if (optionHandler != null && optionHandler.handleOption(opt, cmd)) {
5729 // Okay, caller handled this option.
5730 } else {
5731 throw new IllegalArgumentException("Unknown option: " + opt);
5732 }
5733 break;
5734 }
5735 }
5736 intent.setDataAndType(data, type);
5737
5738 final boolean hasSelector = intent != baseIntent;
5739 if (hasSelector) {
5740 // A selector was specified; fix up.
5741 baseIntent.setSelector(intent);
5742 intent = baseIntent;
5743 }
5744
5745 String arg = cmd.getNextArg();
5746 baseIntent = null;
5747 if (arg == null) {
5748 if (hasSelector) {
5749 // If a selector has been specified, and no arguments
5750 // have been supplied for the main Intent, then we can
5751 // assume it is ACTION_MAIN CATEGORY_LAUNCHER; we don't
5752 // need to have a component name specified yet, the
5753 // selector will take care of that.
5754 baseIntent = new Intent(Intent.ACTION_MAIN);
5755 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5756 }
5757 } else if (arg.indexOf(':') >= 0) {
5758 // The argument is a URI. Fully parse it, and use that result
5759 // to fill in any data not specified so far.
5760 baseIntent = Intent.parseUri(arg, Intent.URI_INTENT_SCHEME
5761 | Intent.URI_ANDROID_APP_SCHEME | Intent.URI_ALLOW_UNSAFE);
5762 } else if (arg.indexOf('/') >= 0) {
5763 // The argument is a component name. Build an Intent to launch
5764 // it.
5765 baseIntent = new Intent(Intent.ACTION_MAIN);
5766 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5767 baseIntent.setComponent(ComponentName.unflattenFromString(arg));
5768 } else {
5769 // Assume the argument is a package name.
5770 baseIntent = new Intent(Intent.ACTION_MAIN);
5771 baseIntent.addCategory(Intent.CATEGORY_LAUNCHER);
5772 baseIntent.setPackage(arg);
5773 }
5774 if (baseIntent != null) {
5775 Bundle extras = intent.getExtras();
5776 intent.replaceExtras((Bundle)null);
5777 Bundle uriExtras = baseIntent.getExtras();
5778 baseIntent.replaceExtras((Bundle)null);
5779 if (intent.getAction() != null && baseIntent.getCategories() != null) {
5780 HashSet<String> cats = new HashSet<String>(baseIntent.getCategories());
5781 for (String c : cats) {
5782 baseIntent.removeCategory(c);
5783 }
5784 }
5785 intent.fillIn(baseIntent, Intent.FILL_IN_COMPONENT | Intent.FILL_IN_SELECTOR);
5786 if (extras == null) {
5787 extras = uriExtras;
5788 } else if (uriExtras != null) {
5789 uriExtras.putAll(extras);
5790 extras = uriExtras;
5791 }
5792 intent.replaceExtras(extras);
5793 hasIntentInfo = true;
5794 }
5795
5796 if (!hasIntentInfo) throw new IllegalArgumentException("No intent supplied");
5797 return intent;
5798 }
5799
5800 /** @hide */
5801 public static void printIntentArgsHelp(PrintWriter pw, String prefix) {
5802 final String[] lines = new String[] {
5803 "<INTENT> specifications include these flags and arguments:",
5804 " [-a <ACTION>] [-d <DATA_URI>] [-t <MIME_TYPE>]",
5805 " [-c <CATEGORY> [-c <CATEGORY>] ...]",
5806 " [-e|--es <EXTRA_KEY> <EXTRA_STRING_VALUE> ...]",
5807 " [--esn <EXTRA_KEY> ...]",
5808 " [--ez <EXTRA_KEY> <EXTRA_BOOLEAN_VALUE> ...]",
5809 " [--ei <EXTRA_KEY> <EXTRA_INT_VALUE> ...]",
5810 " [--el <EXTRA_KEY> <EXTRA_LONG_VALUE> ...]",
5811 " [--ef <EXTRA_KEY> <EXTRA_FLOAT_VALUE> ...]",
5812 " [--eu <EXTRA_KEY> <EXTRA_URI_VALUE> ...]",
5813 " [--ecn <EXTRA_KEY> <EXTRA_COMPONENT_NAME_VALUE>]",
5814 " [--eia <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5815 " (mutiple extras passed as Integer[])",
5816 " [--eial <EXTRA_KEY> <EXTRA_INT_VALUE>[,<EXTRA_INT_VALUE...]]",
5817 " (mutiple extras passed as List<Integer>)",
5818 " [--ela <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5819 " (mutiple extras passed as Long[])",
5820 " [--elal <EXTRA_KEY> <EXTRA_LONG_VALUE>[,<EXTRA_LONG_VALUE...]]",
5821 " (mutiple extras passed as List<Long>)",
5822 " [--efa <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5823 " (mutiple extras passed as Float[])",
5824 " [--efal <EXTRA_KEY> <EXTRA_FLOAT_VALUE>[,<EXTRA_FLOAT_VALUE...]]",
5825 " (mutiple extras passed as List<Float>)",
5826 " [--esa <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5827 " (mutiple extras passed as String[]; to embed a comma into a string,",
5828 " escape it using \"\\,\")",
5829 " [--esal <EXTRA_KEY> <EXTRA_STRING_VALUE>[,<EXTRA_STRING_VALUE...]]",
5830 " (mutiple extras passed as List<String>; to embed a comma into a string,",
5831 " escape it using \"\\,\")",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005832 " [--f <FLAG>]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005833 " [--grant-read-uri-permission] [--grant-write-uri-permission]",
5834 " [--grant-persistable-uri-permission] [--grant-prefix-uri-permission]",
5835 " [--debug-log-resolution] [--exclude-stopped-packages]",
5836 " [--include-stopped-packages]",
5837 " [--activity-brought-to-front] [--activity-clear-top]",
5838 " [--activity-clear-when-task-reset] [--activity-exclude-from-recents]",
5839 " [--activity-launched-from-history] [--activity-multiple-task]",
5840 " [--activity-no-animation] [--activity-no-history]",
5841 " [--activity-no-user-action] [--activity-previous-is-top]",
5842 " [--activity-reorder-to-front] [--activity-reset-task-if-needed]",
5843 " [--activity-single-top] [--activity-clear-task]",
5844 " [--activity-task-on-home]",
5845 " [--receiver-registered-only] [--receiver-replace-pending]",
Felipe Leme3cb48cd2016-01-27 08:39:09 -08005846 " [--receiver-foreground]",
Dianne Hackborn3cdb56e2015-11-11 12:45:44 -08005847 " [--selector]",
5848 " [<URI> | <PACKAGE> | <COMPONENT>]"
5849 };
5850 for (String line : lines) {
5851 pw.print(prefix);
5852 pw.println(line);
5853 }
5854 }
5855
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005856 /**
5857 * Retrieve the general action to be performed, such as
5858 * {@link #ACTION_VIEW}. The action describes the general way the rest of
5859 * the information in the intent should be interpreted -- most importantly,
5860 * what to do with the data returned by {@link #getData}.
5861 *
5862 * @return The action of this intent or null if none is specified.
5863 *
5864 * @see #setAction
5865 */
5866 public String getAction() {
5867 return mAction;
5868 }
5869
5870 /**
5871 * Retrieve data this intent is operating on. This URI specifies the name
5872 * of the data; often it uses the content: scheme, specifying data in a
5873 * content provider. Other schemes may be handled by specific activities,
5874 * such as http: by the web browser.
5875 *
5876 * @return The URI of the data this intent is targeting or null.
5877 *
5878 * @see #getScheme
5879 * @see #setData
5880 */
5881 public Uri getData() {
5882 return mData;
5883 }
5884
5885 /**
5886 * The same as {@link #getData()}, but returns the URI as an encoded
5887 * String.
5888 */
5889 public String getDataString() {
5890 return mData != null ? mData.toString() : null;
5891 }
5892
5893 /**
5894 * Return the scheme portion of the intent's data. If the data is null or
5895 * does not include a scheme, null is returned. Otherwise, the scheme
5896 * prefix without the final ':' is returned, i.e. "http".
5897 *
5898 * <p>This is the same as calling getData().getScheme() (and checking for
5899 * null data).
5900 *
5901 * @return The scheme of this intent.
5902 *
5903 * @see #getData
5904 */
5905 public String getScheme() {
5906 return mData != null ? mData.getScheme() : null;
5907 }
5908
5909 /**
5910 * Retrieve any explicit MIME type included in the intent. This is usually
5911 * null, as the type is determined by the intent data.
5912 *
5913 * @return If a type was manually set, it is returned; else null is
5914 * returned.
5915 *
5916 * @see #resolveType(ContentResolver)
5917 * @see #setType
5918 */
5919 public String getType() {
5920 return mType;
5921 }
5922
5923 /**
5924 * Return the MIME data type of this intent. If the type field is
5925 * explicitly set, that is simply returned. Otherwise, if the data is set,
5926 * the type of that data is returned. If neither fields are set, a null is
5927 * returned.
5928 *
5929 * @return The MIME type of this intent.
5930 *
5931 * @see #getType
5932 * @see #resolveType(ContentResolver)
5933 */
5934 public String resolveType(Context context) {
5935 return resolveType(context.getContentResolver());
5936 }
5937
5938 /**
5939 * Return the MIME data type of this intent. If the type field is
5940 * explicitly set, that is simply returned. Otherwise, if the data is set,
5941 * the type of that data is returned. If neither fields are set, a null is
5942 * returned.
5943 *
5944 * @param resolver A ContentResolver that can be used to determine the MIME
5945 * type of the intent's data.
5946 *
5947 * @return The MIME type of this intent.
5948 *
5949 * @see #getType
5950 * @see #resolveType(Context)
5951 */
5952 public String resolveType(ContentResolver resolver) {
5953 if (mType != null) {
5954 return mType;
5955 }
5956 if (mData != null) {
5957 if ("content".equals(mData.getScheme())) {
5958 return resolver.getType(mData);
5959 }
5960 }
5961 return null;
5962 }
5963
5964 /**
5965 * Return the MIME data type of this intent, only if it will be needed for
5966 * intent resolution. This is not generally useful for application code;
5967 * it is used by the frameworks for communicating with back-end system
5968 * services.
5969 *
5970 * @param resolver A ContentResolver that can be used to determine the MIME
5971 * type of the intent's data.
5972 *
5973 * @return The MIME type of this intent, or null if it is unknown or not
5974 * needed.
5975 */
5976 public String resolveTypeIfNeeded(ContentResolver resolver) {
5977 if (mComponent != null) {
5978 return mType;
5979 }
5980 return resolveType(resolver);
5981 }
5982
5983 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005984 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005985 *
5986 * @param category The category to check.
5987 *
5988 * @return boolean True if the intent contains the category, else false.
5989 *
5990 * @see #getCategories
5991 * @see #addCategory
5992 */
5993 public boolean hasCategory(String category) {
5994 return mCategories != null && mCategories.contains(category);
5995 }
5996
5997 /**
5998 * Return the set of all categories in the intent. If there are no categories,
5999 * returns NULL.
6000 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006001 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006002 *
6003 * @see #hasCategory
6004 * @see #addCategory
6005 */
6006 public Set<String> getCategories() {
6007 return mCategories;
6008 }
6009
6010 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006011 * Return the specific selector associated with this Intent. If there is
6012 * none, returns null. See {@link #setSelector} for more information.
6013 *
6014 * @see #setSelector
6015 */
6016 public Intent getSelector() {
6017 return mSelector;
6018 }
6019
6020 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006021 * Return the {@link ClipData} associated with this Intent. If there is
6022 * none, returns null. See {@link #setClipData} for more information.
6023 *
John Spurlock125d1332013-11-25 11:58:37 -05006024 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006025 */
6026 public ClipData getClipData() {
6027 return mClipData;
6028 }
6029
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006030 /** @hide */
6031 public int getContentUserHint() {
6032 return mContentUserHint;
6033 }
6034
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006035 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006036 * Sets the ClassLoader that will be used when unmarshalling
6037 * any Parcelable values from the extras of this Intent.
6038 *
6039 * @param loader a ClassLoader, or null to use the default loader
6040 * at the time of unmarshalling.
6041 */
6042 public void setExtrasClassLoader(ClassLoader loader) {
6043 if (mExtras != null) {
6044 mExtras.setClassLoader(loader);
6045 }
6046 }
6047
6048 /**
6049 * Returns true if an extra value is associated with the given name.
6050 * @param name the extra's name
6051 * @return true if the given extra is present.
6052 */
6053 public boolean hasExtra(String name) {
6054 return mExtras != null && mExtras.containsKey(name);
6055 }
6056
6057 /**
6058 * Returns true if the Intent's extras contain a parcelled file descriptor.
6059 * @return true if the Intent contains a parcelled file descriptor.
6060 */
6061 public boolean hasFileDescriptors() {
6062 return mExtras != null && mExtras.hasFileDescriptors();
6063 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006064
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04006065 /** @hide */
6066 public void setAllowFds(boolean allowFds) {
6067 if (mExtras != null) {
6068 mExtras.setAllowFds(allowFds);
6069 }
6070 }
6071
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006072 /**
6073 * Retrieve extended data from the intent.
6074 *
6075 * @param name The name of the desired item.
6076 *
6077 * @return the value of an item that previously added with putExtra()
6078 * or null if none was found.
6079 *
6080 * @deprecated
6081 * @hide
6082 */
6083 @Deprecated
6084 public Object getExtra(String name) {
6085 return getExtra(name, null);
6086 }
6087
6088 /**
6089 * Retrieve extended data from the intent.
6090 *
6091 * @param name The name of the desired item.
6092 * @param defaultValue the value to be returned if no value of the desired
6093 * type is stored with the given name.
6094 *
6095 * @return the value of an item that previously added with putExtra()
6096 * or the default value if none was found.
6097 *
6098 * @see #putExtra(String, boolean)
6099 */
6100 public boolean getBooleanExtra(String name, boolean defaultValue) {
6101 return mExtras == null ? defaultValue :
6102 mExtras.getBoolean(name, defaultValue);
6103 }
6104
6105 /**
6106 * Retrieve extended data from the intent.
6107 *
6108 * @param name The name of the desired item.
6109 * @param defaultValue the value to be returned if no value of the desired
6110 * type is stored with the given name.
6111 *
6112 * @return the value of an item that previously added with putExtra()
6113 * or the default value if none was found.
6114 *
6115 * @see #putExtra(String, byte)
6116 */
6117 public byte getByteExtra(String name, byte defaultValue) {
6118 return mExtras == null ? defaultValue :
6119 mExtras.getByte(name, defaultValue);
6120 }
6121
6122 /**
6123 * Retrieve extended data from the intent.
6124 *
6125 * @param name The name of the desired item.
6126 * @param defaultValue the value to be returned if no value of the desired
6127 * type is stored with the given name.
6128 *
6129 * @return the value of an item that previously added with putExtra()
6130 * or the default value if none was found.
6131 *
6132 * @see #putExtra(String, short)
6133 */
6134 public short getShortExtra(String name, short defaultValue) {
6135 return mExtras == null ? defaultValue :
6136 mExtras.getShort(name, defaultValue);
6137 }
6138
6139 /**
6140 * Retrieve extended data from the intent.
6141 *
6142 * @param name The name of the desired item.
6143 * @param defaultValue the value to be returned if no value of the desired
6144 * type is stored with the given name.
6145 *
6146 * @return the value of an item that previously added with putExtra()
6147 * or the default value if none was found.
6148 *
6149 * @see #putExtra(String, char)
6150 */
6151 public char getCharExtra(String name, char defaultValue) {
6152 return mExtras == null ? defaultValue :
6153 mExtras.getChar(name, defaultValue);
6154 }
6155
6156 /**
6157 * Retrieve extended data from the intent.
6158 *
6159 * @param name The name of the desired item.
6160 * @param defaultValue the value to be returned if no value of the desired
6161 * type is stored with the given name.
6162 *
6163 * @return the value of an item that previously added with putExtra()
6164 * or the default value if none was found.
6165 *
6166 * @see #putExtra(String, int)
6167 */
6168 public int getIntExtra(String name, int defaultValue) {
6169 return mExtras == null ? defaultValue :
6170 mExtras.getInt(name, defaultValue);
6171 }
6172
6173 /**
6174 * Retrieve extended data from the intent.
6175 *
6176 * @param name The name of the desired item.
6177 * @param defaultValue the value to be returned if no value of the desired
6178 * type is stored with the given name.
6179 *
6180 * @return the value of an item that previously added with putExtra()
6181 * or the default value if none was found.
6182 *
6183 * @see #putExtra(String, long)
6184 */
6185 public long getLongExtra(String name, long defaultValue) {
6186 return mExtras == null ? defaultValue :
6187 mExtras.getLong(name, defaultValue);
6188 }
6189
6190 /**
6191 * Retrieve extended data from the intent.
6192 *
6193 * @param name The name of the desired item.
6194 * @param defaultValue the value to be returned if no value of the desired
6195 * type is stored with the given name.
6196 *
6197 * @return the value of an item that previously added with putExtra(),
6198 * or the default value if no such item is present
6199 *
6200 * @see #putExtra(String, float)
6201 */
6202 public float getFloatExtra(String name, float defaultValue) {
6203 return mExtras == null ? defaultValue :
6204 mExtras.getFloat(name, defaultValue);
6205 }
6206
6207 /**
6208 * Retrieve extended data from the intent.
6209 *
6210 * @param name The name of the desired item.
6211 * @param defaultValue the value to be returned if no value of the desired
6212 * type is stored with the given name.
6213 *
6214 * @return the value of an item that previously added with putExtra()
6215 * or the default value if none was found.
6216 *
6217 * @see #putExtra(String, double)
6218 */
6219 public double getDoubleExtra(String name, double defaultValue) {
6220 return mExtras == null ? defaultValue :
6221 mExtras.getDouble(name, defaultValue);
6222 }
6223
6224 /**
6225 * Retrieve extended data from the intent.
6226 *
6227 * @param name The name of the desired item.
6228 *
6229 * @return the value of an item that previously added with putExtra()
6230 * or null if no String value was found.
6231 *
6232 * @see #putExtra(String, String)
6233 */
6234 public String getStringExtra(String name) {
6235 return mExtras == null ? null : mExtras.getString(name);
6236 }
6237
6238 /**
6239 * Retrieve extended data from the intent.
6240 *
6241 * @param name The name of the desired item.
6242 *
6243 * @return the value of an item that previously added with putExtra()
6244 * or null if no CharSequence value was found.
6245 *
6246 * @see #putExtra(String, CharSequence)
6247 */
6248 public CharSequence getCharSequenceExtra(String name) {
6249 return mExtras == null ? null : mExtras.getCharSequence(name);
6250 }
6251
6252 /**
6253 * Retrieve extended data from the intent.
6254 *
6255 * @param name The name of the desired item.
6256 *
6257 * @return the value of an item that previously added with putExtra()
6258 * or null if no Parcelable value was found.
6259 *
6260 * @see #putExtra(String, Parcelable)
6261 */
6262 public <T extends Parcelable> T getParcelableExtra(String name) {
6263 return mExtras == null ? null : mExtras.<T>getParcelable(name);
6264 }
6265
6266 /**
6267 * Retrieve extended data from the intent.
6268 *
6269 * @param name The name of the desired item.
6270 *
6271 * @return the value of an item that previously added with putExtra()
6272 * or null if no Parcelable[] value was found.
6273 *
6274 * @see #putExtra(String, Parcelable[])
6275 */
6276 public Parcelable[] getParcelableArrayExtra(String name) {
6277 return mExtras == null ? null : mExtras.getParcelableArray(name);
6278 }
6279
6280 /**
6281 * Retrieve extended data from the intent.
6282 *
6283 * @param name The name of the desired item.
6284 *
6285 * @return the value of an item that previously added with putExtra()
6286 * or null if no ArrayList<Parcelable> value was found.
6287 *
6288 * @see #putParcelableArrayListExtra(String, ArrayList)
6289 */
6290 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
6291 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
6292 }
6293
6294 /**
6295 * Retrieve extended data from the intent.
6296 *
6297 * @param name The name of the desired item.
6298 *
6299 * @return the value of an item that previously added with putExtra()
6300 * or null if no Serializable value was found.
6301 *
6302 * @see #putExtra(String, Serializable)
6303 */
6304 public Serializable getSerializableExtra(String name) {
6305 return mExtras == null ? null : mExtras.getSerializable(name);
6306 }
6307
6308 /**
6309 * Retrieve extended data from the intent.
6310 *
6311 * @param name The name of the desired item.
6312 *
6313 * @return the value of an item that previously added with putExtra()
6314 * or null if no ArrayList<Integer> value was found.
6315 *
6316 * @see #putIntegerArrayListExtra(String, ArrayList)
6317 */
6318 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
6319 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
6320 }
6321
6322 /**
6323 * Retrieve extended data from the intent.
6324 *
6325 * @param name The name of the desired item.
6326 *
6327 * @return the value of an item that previously added with putExtra()
6328 * or null if no ArrayList<String> value was found.
6329 *
6330 * @see #putStringArrayListExtra(String, ArrayList)
6331 */
6332 public ArrayList<String> getStringArrayListExtra(String name) {
6333 return mExtras == null ? null : mExtras.getStringArrayList(name);
6334 }
6335
6336 /**
6337 * Retrieve extended data from the intent.
6338 *
6339 * @param name The name of the desired item.
6340 *
6341 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006342 * or null if no ArrayList<CharSequence> value was found.
6343 *
6344 * @see #putCharSequenceArrayListExtra(String, ArrayList)
6345 */
6346 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
6347 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
6348 }
6349
6350 /**
6351 * Retrieve extended data from the intent.
6352 *
6353 * @param name The name of the desired item.
6354 *
6355 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006356 * or null if no boolean array value was found.
6357 *
6358 * @see #putExtra(String, boolean[])
6359 */
6360 public boolean[] getBooleanArrayExtra(String name) {
6361 return mExtras == null ? null : mExtras.getBooleanArray(name);
6362 }
6363
6364 /**
6365 * Retrieve extended data from the intent.
6366 *
6367 * @param name The name of the desired item.
6368 *
6369 * @return the value of an item that previously added with putExtra()
6370 * or null if no byte array value was found.
6371 *
6372 * @see #putExtra(String, byte[])
6373 */
6374 public byte[] getByteArrayExtra(String name) {
6375 return mExtras == null ? null : mExtras.getByteArray(name);
6376 }
6377
6378 /**
6379 * Retrieve extended data from the intent.
6380 *
6381 * @param name The name of the desired item.
6382 *
6383 * @return the value of an item that previously added with putExtra()
6384 * or null if no short array value was found.
6385 *
6386 * @see #putExtra(String, short[])
6387 */
6388 public short[] getShortArrayExtra(String name) {
6389 return mExtras == null ? null : mExtras.getShortArray(name);
6390 }
6391
6392 /**
6393 * Retrieve extended data from the intent.
6394 *
6395 * @param name The name of the desired item.
6396 *
6397 * @return the value of an item that previously added with putExtra()
6398 * or null if no char array value was found.
6399 *
6400 * @see #putExtra(String, char[])
6401 */
6402 public char[] getCharArrayExtra(String name) {
6403 return mExtras == null ? null : mExtras.getCharArray(name);
6404 }
6405
6406 /**
6407 * Retrieve extended data from the intent.
6408 *
6409 * @param name The name of the desired item.
6410 *
6411 * @return the value of an item that previously added with putExtra()
6412 * or null if no int array value was found.
6413 *
6414 * @see #putExtra(String, int[])
6415 */
6416 public int[] getIntArrayExtra(String name) {
6417 return mExtras == null ? null : mExtras.getIntArray(name);
6418 }
6419
6420 /**
6421 * Retrieve extended data from the intent.
6422 *
6423 * @param name The name of the desired item.
6424 *
6425 * @return the value of an item that previously added with putExtra()
6426 * or null if no long array value was found.
6427 *
6428 * @see #putExtra(String, long[])
6429 */
6430 public long[] getLongArrayExtra(String name) {
6431 return mExtras == null ? null : mExtras.getLongArray(name);
6432 }
6433
6434 /**
6435 * Retrieve extended data from the intent.
6436 *
6437 * @param name The name of the desired item.
6438 *
6439 * @return the value of an item that previously added with putExtra()
6440 * or null if no float array value was found.
6441 *
6442 * @see #putExtra(String, float[])
6443 */
6444 public float[] getFloatArrayExtra(String name) {
6445 return mExtras == null ? null : mExtras.getFloatArray(name);
6446 }
6447
6448 /**
6449 * Retrieve extended data from the intent.
6450 *
6451 * @param name The name of the desired item.
6452 *
6453 * @return the value of an item that previously added with putExtra()
6454 * or null if no double array value was found.
6455 *
6456 * @see #putExtra(String, double[])
6457 */
6458 public double[] getDoubleArrayExtra(String name) {
6459 return mExtras == null ? null : mExtras.getDoubleArray(name);
6460 }
6461
6462 /**
6463 * Retrieve extended data from the intent.
6464 *
6465 * @param name The name of the desired item.
6466 *
6467 * @return the value of an item that previously added with putExtra()
6468 * or null if no String array value was found.
6469 *
6470 * @see #putExtra(String, String[])
6471 */
6472 public String[] getStringArrayExtra(String name) {
6473 return mExtras == null ? null : mExtras.getStringArray(name);
6474 }
6475
6476 /**
6477 * Retrieve extended data from the intent.
6478 *
6479 * @param name The name of the desired item.
6480 *
6481 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006482 * or null if no CharSequence array value was found.
6483 *
6484 * @see #putExtra(String, CharSequence[])
6485 */
6486 public CharSequence[] getCharSequenceArrayExtra(String name) {
6487 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
6488 }
6489
6490 /**
6491 * Retrieve extended data from the intent.
6492 *
6493 * @param name The name of the desired item.
6494 *
6495 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006496 * or null if no Bundle value was found.
6497 *
6498 * @see #putExtra(String, Bundle)
6499 */
6500 public Bundle getBundleExtra(String name) {
6501 return mExtras == null ? null : mExtras.getBundle(name);
6502 }
6503
6504 /**
6505 * Retrieve extended data from the intent.
6506 *
6507 * @param name The name of the desired item.
6508 *
6509 * @return the value of an item that previously added with putExtra()
6510 * or null if no IBinder value was found.
6511 *
6512 * @see #putExtra(String, IBinder)
6513 *
6514 * @deprecated
6515 * @hide
6516 */
6517 @Deprecated
6518 public IBinder getIBinderExtra(String name) {
6519 return mExtras == null ? null : mExtras.getIBinder(name);
6520 }
6521
6522 /**
6523 * Retrieve extended data from the intent.
6524 *
6525 * @param name The name of the desired item.
6526 * @param defaultValue The default value to return in case no item is
6527 * associated with the key 'name'
6528 *
6529 * @return the value of an item that previously added with putExtra()
6530 * or defaultValue if none was found.
6531 *
6532 * @see #putExtra
6533 *
6534 * @deprecated
6535 * @hide
6536 */
6537 @Deprecated
6538 public Object getExtra(String name, Object defaultValue) {
6539 Object result = defaultValue;
6540 if (mExtras != null) {
6541 Object result2 = mExtras.get(name);
6542 if (result2 != null) {
6543 result = result2;
6544 }
6545 }
6546
6547 return result;
6548 }
6549
6550 /**
6551 * Retrieves a map of extended data from the intent.
6552 *
6553 * @return the map of all extras previously added with putExtra(),
6554 * or null if none have been added.
6555 */
6556 public Bundle getExtras() {
6557 return (mExtras != null)
6558 ? new Bundle(mExtras)
6559 : null;
6560 }
6561
6562 /**
Dianne Hackborna83ce1d2015-03-11 15:16:13 -07006563 * Filter extras to only basic types.
6564 * @hide
6565 */
6566 public void removeUnsafeExtras() {
6567 if (mExtras != null) {
6568 mExtras.filterValues();
6569 }
6570 }
6571
6572 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006573 * Retrieve any special flags associated with this intent. You will
6574 * normally just set them with {@link #setFlags} and let the system
6575 * take the appropriate action with them.
6576 *
6577 * @return int The currently set flags.
6578 *
6579 * @see #setFlags
6580 */
6581 public int getFlags() {
6582 return mFlags;
6583 }
6584
Dianne Hackborne7f97212011-02-24 14:40:20 -08006585 /** @hide */
6586 public boolean isExcludingStopped() {
6587 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
6588 == FLAG_EXCLUDE_STOPPED_PACKAGES;
6589 }
6590
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006591 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006592 * Retrieve the application package name this Intent is limited to. When
6593 * resolving an Intent, if non-null this limits the resolution to only
6594 * components in the given application package.
6595 *
6596 * @return The name of the application package for the Intent.
6597 *
6598 * @see #resolveActivity
6599 * @see #setPackage
6600 */
6601 public String getPackage() {
6602 return mPackage;
6603 }
6604
6605 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006606 * Retrieve the concrete component associated with the intent. When receiving
6607 * an intent, this is the component that was found to best handle it (that is,
6608 * yourself) and will always be non-null; in all other cases it will be
6609 * null unless explicitly set.
6610 *
6611 * @return The name of the application component to handle the intent.
6612 *
6613 * @see #resolveActivity
6614 * @see #setComponent
6615 */
6616 public ComponentName getComponent() {
6617 return mComponent;
6618 }
6619
6620 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006621 * Get the bounds of the sender of this intent, in screen coordinates. This can be
6622 * used as a hint to the receiver for animations and the like. Null means that there
6623 * is no source bounds.
6624 */
6625 public Rect getSourceBounds() {
6626 return mSourceBounds;
6627 }
6628
6629 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006630 * Return the Activity component that should be used to handle this intent.
6631 * The appropriate component is determined based on the information in the
6632 * intent, evaluated as follows:
6633 *
6634 * <p>If {@link #getComponent} returns an explicit class, that is returned
6635 * without any further consideration.
6636 *
6637 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
6638 * category to be considered.
6639 *
6640 * <p>If {@link #getAction} is non-NULL, the activity must handle this
6641 * action.
6642 *
6643 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
6644 * this type.
6645 *
6646 * <p>If {@link #addCategory} has added any categories, the activity must
6647 * handle ALL of the categories specified.
6648 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006649 * <p>If {@link #getPackage} is non-NULL, only activity components in
6650 * that application package will be considered.
6651 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006652 * <p>If there are no activities that satisfy all of these conditions, a
6653 * null string is returned.
6654 *
6655 * <p>If multiple activities are found to satisfy the intent, the one with
6656 * the highest priority will be used. If there are multiple activities
6657 * with the same priority, the system will either pick the best activity
6658 * based on user preference, or resolve to a system class that will allow
6659 * the user to pick an activity and forward from there.
6660 *
6661 * <p>This method is implemented simply by calling
6662 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
6663 * true.</p>
6664 * <p> This API is called for you as part of starting an activity from an
6665 * intent. You do not normally need to call it yourself.</p>
6666 *
6667 * @param pm The package manager with which to resolve the Intent.
6668 *
6669 * @return Name of the component implementing an activity that can
6670 * display the intent.
6671 *
6672 * @see #setComponent
6673 * @see #getComponent
6674 * @see #resolveActivityInfo
6675 */
6676 public ComponentName resolveActivity(PackageManager pm) {
6677 if (mComponent != null) {
6678 return mComponent;
6679 }
6680
6681 ResolveInfo info = pm.resolveActivity(
6682 this, PackageManager.MATCH_DEFAULT_ONLY);
6683 if (info != null) {
6684 return new ComponentName(
6685 info.activityInfo.applicationInfo.packageName,
6686 info.activityInfo.name);
6687 }
6688
6689 return null;
6690 }
6691
6692 /**
6693 * Resolve the Intent into an {@link ActivityInfo}
6694 * describing the activity that should execute the intent. Resolution
6695 * follows the same rules as described for {@link #resolveActivity}, but
6696 * you get back the completely information about the resolved activity
6697 * instead of just its class name.
6698 *
6699 * @param pm The package manager with which to resolve the Intent.
6700 * @param flags Addition information to retrieve as per
6701 * {@link PackageManager#getActivityInfo(ComponentName, int)
6702 * PackageManager.getActivityInfo()}.
6703 *
6704 * @return PackageManager.ActivityInfo
6705 *
6706 * @see #resolveActivity
6707 */
6708 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
6709 ActivityInfo ai = null;
6710 if (mComponent != null) {
6711 try {
6712 ai = pm.getActivityInfo(mComponent, flags);
6713 } catch (PackageManager.NameNotFoundException e) {
6714 // ignore
6715 }
6716 } else {
6717 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07006718 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006719 if (info != null) {
6720 ai = info.activityInfo;
6721 }
6722 }
6723
6724 return ai;
6725 }
6726
6727 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07006728 * Special function for use by the system to resolve service
6729 * intents to system apps. Throws an exception if there are
6730 * multiple potential matches to the Intent. Returns null if
6731 * there are no matches.
6732 * @hide
6733 */
6734 public ComponentName resolveSystemService(PackageManager pm, int flags) {
6735 if (mComponent != null) {
6736 return mComponent;
6737 }
6738
6739 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
6740 if (results == null) {
6741 return null;
6742 }
6743 ComponentName comp = null;
6744 for (int i=0; i<results.size(); i++) {
6745 ResolveInfo ri = results.get(i);
6746 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
6747 continue;
6748 }
6749 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
6750 ri.serviceInfo.name);
6751 if (comp != null) {
6752 throw new IllegalStateException("Multiple system services handle " + this
6753 + ": " + comp + ", " + foundComp);
6754 }
6755 comp = foundComp;
6756 }
6757 return comp;
6758 }
6759
6760 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006761 * Set the general action to be performed.
6762 *
6763 * @param action An action name, such as ACTION_VIEW. Application-specific
6764 * actions should be prefixed with the vendor's package name.
6765 *
6766 * @return Returns the same Intent object, for chaining multiple calls
6767 * into a single statement.
6768 *
6769 * @see #getAction
6770 */
6771 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006772 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006773 return this;
6774 }
6775
6776 /**
6777 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08006778 * clears any type that was previously set by {@link #setType} or
6779 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006780 *
Nick Pellyccae4122012-01-09 14:12:58 -08006781 * <p><em>Note: scheme matching in the Android framework is
6782 * case-sensitive, unlike the formal RFC. As a result,
6783 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006784 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006785 * {@link #setDataAndNormalize}
6786 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006787 *
Nick Pellyccae4122012-01-09 14:12:58 -08006788 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006789 *
6790 * @return Returns the same Intent object, for chaining multiple calls
6791 * into a single statement.
6792 *
6793 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08006794 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07006795 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006796 */
6797 public Intent setData(Uri data) {
6798 mData = data;
6799 mType = null;
6800 return this;
6801 }
6802
6803 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006804 * Normalize and set the data this intent is operating on.
6805 *
6806 * <p>This method automatically clears any type that was
6807 * previously set (for example, by {@link #setType}).
6808 *
6809 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006810 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08006811 * so really this is just a convenience method for
6812 * <pre>
6813 * setData(data.normalize())
6814 * </pre>
6815 *
6816 * @param data The Uri of the data this intent is now targeting.
6817 *
6818 * @return Returns the same Intent object, for chaining multiple calls
6819 * into a single statement.
6820 *
6821 * @see #getData
6822 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006823 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006824 */
6825 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006826 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08006827 }
6828
6829 /**
6830 * Set an explicit MIME data type.
6831 *
6832 * <p>This is used to create intents that only specify a type and not data,
6833 * for example to indicate the type of data to return.
6834 *
6835 * <p>This method automatically clears any data that was
6836 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07006837 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006838 * <p><em>Note: MIME type matching in the Android framework is
6839 * case-sensitive, unlike formal RFC MIME types. As a result,
6840 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08006841 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
6842 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006843 *
6844 * @param type The MIME type of the data being handled by this intent.
6845 *
6846 * @return Returns the same Intent object, for chaining multiple calls
6847 * into a single statement.
6848 *
6849 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08006850 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006851 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08006852 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006853 */
6854 public Intent setType(String type) {
6855 mData = null;
6856 mType = type;
6857 return this;
6858 }
6859
6860 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006861 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006862 *
Nick Pellyccae4122012-01-09 14:12:58 -08006863 * <p>This is used to create intents that only specify a type and not data,
6864 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07006865 *
Nick Pellyccae4122012-01-09 14:12:58 -08006866 * <p>This method automatically clears any data that was
6867 * previously set (for example by {@link #setData}).
6868 *
6869 * <p>The MIME type is normalized using
6870 * {@link #normalizeMimeType} before it is set,
6871 * so really this is just a convenience method for
6872 * <pre>
6873 * setType(Intent.normalizeMimeType(type))
6874 * </pre>
6875 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006876 * @param type The MIME type of the data being handled by this intent.
6877 *
6878 * @return Returns the same Intent object, for chaining multiple calls
6879 * into a single statement.
6880 *
Nick Pellyccae4122012-01-09 14:12:58 -08006881 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006882 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08006883 * @see #normalizeMimeType
6884 */
6885 public Intent setTypeAndNormalize(String type) {
6886 return setType(normalizeMimeType(type));
6887 }
6888
6889 /**
6890 * (Usually optional) Set the data for the intent along with an explicit
6891 * MIME data type. This method should very rarely be used -- it allows you
6892 * to override the MIME type that would ordinarily be inferred from the
6893 * data with your own type given here.
6894 *
6895 * <p><em>Note: MIME type and Uri scheme matching in the
6896 * Android framework is case-sensitive, unlike the formal RFC definitions.
6897 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006898 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08006899 * {@link #setDataAndTypeAndNormalize}
6900 * to ensure that they are converted to lower case.</em>
6901 *
6902 * @param data The Uri of the data this intent is now targeting.
6903 * @param type The MIME type of the data being handled by this intent.
6904 *
6905 * @return Returns the same Intent object, for chaining multiple calls
6906 * into a single statement.
6907 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006908 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08006909 * @see #setData
6910 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006911 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006912 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006913 */
6914 public Intent setDataAndType(Uri data, String type) {
6915 mData = data;
6916 mType = type;
6917 return this;
6918 }
6919
6920 /**
Nick Pellyccae4122012-01-09 14:12:58 -08006921 * (Usually optional) Normalize and set both the data Uri and an explicit
6922 * MIME data type. This method should very rarely be used -- it allows you
6923 * to override the MIME type that would ordinarily be inferred from the
6924 * data with your own type given here.
6925 *
6926 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006927 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08006928 * before they are set, so really this is just a convenience method for
6929 * <pre>
6930 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
6931 * </pre>
6932 *
6933 * @param data The Uri of the data this intent is now targeting.
6934 * @param type The MIME type of the data being handled by this intent.
6935 *
6936 * @return Returns the same Intent object, for chaining multiple calls
6937 * into a single statement.
6938 *
6939 * @see #setType
6940 * @see #setData
6941 * @see #setDataAndType
6942 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006943 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08006944 */
6945 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04006946 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08006947 }
6948
6949 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006950 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006951 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006952 * activities that provide <em>all</em> of the requested categories will be
6953 * used.
6954 *
6955 * @param category The desired category. This can be either one of the
6956 * predefined Intent categories, or a custom category in your own
6957 * namespace.
6958 *
6959 * @return Returns the same Intent object, for chaining multiple calls
6960 * into a single statement.
6961 *
6962 * @see #hasCategory
6963 * @see #removeCategory
6964 */
6965 public Intent addCategory(String category) {
6966 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006967 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006968 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08006969 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006970 return this;
6971 }
6972
6973 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09006974 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006975 *
6976 * @param category The category to remove.
6977 *
6978 * @see #addCategory
6979 */
6980 public void removeCategory(String category) {
6981 if (mCategories != null) {
6982 mCategories.remove(category);
6983 if (mCategories.size() == 0) {
6984 mCategories = null;
6985 }
6986 }
6987 }
6988
6989 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006990 * Set a selector for this Intent. This is a modification to the kinds of
6991 * things the Intent will match. If the selector is set, it will be used
6992 * when trying to find entities that can handle the Intent, instead of the
6993 * main contents of the Intent. This allows you build an Intent containing
6994 * a generic protocol while targeting it more specifically.
6995 *
6996 * <p>An example of where this may be used is with things like
6997 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
6998 * Intent that will launch the Browser application. However, the correct
6999 * main entry point of an application is actually {@link #ACTION_MAIN}
7000 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
7001 * used to specify the actual Activity to launch. If you launch the browser
7002 * with something different, undesired behavior may happen if the user has
7003 * previously or later launches it the normal way, since they do not match.
7004 * Instead, you can build an Intent with the MAIN action (but no ComponentName
7005 * yet specified) and set a selector with {@link #ACTION_MAIN} and
7006 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
7007 *
7008 * <p>Setting a selector does not impact the behavior of
7009 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
7010 * desired behavior of a selector -- it does not impact the base meaning
7011 * of the Intent, just what kinds of things will be matched against it
7012 * when determining who can handle it.</p>
7013 *
7014 * <p>You can not use both a selector and {@link #setPackage(String)} on
7015 * the same base Intent.</p>
7016 *
7017 * @param selector The desired selector Intent; set to null to not use
7018 * a special selector.
7019 */
7020 public void setSelector(Intent selector) {
7021 if (selector == this) {
7022 throw new IllegalArgumentException(
7023 "Intent being set as a selector of itself");
7024 }
7025 if (selector != null && mPackage != null) {
7026 throw new IllegalArgumentException(
7027 "Can't set selector when package name is already set");
7028 }
7029 mSelector = selector;
7030 }
7031
7032 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007033 * Set a {@link ClipData} associated with this Intent. This replaces any
7034 * previously set ClipData.
7035 *
7036 * <p>The ClipData in an intent is not used for Intent matching or other
7037 * such operations. Semantically it is like extras, used to transmit
7038 * additional data with the Intent. The main feature of using this over
7039 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
7040 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
7041 * items included in the clip data. This is useful, in particular, if
7042 * you want to transmit an Intent containing multiple <code>content:</code>
7043 * URIs for which the recipient may not have global permission to access the
7044 * content provider.
7045 *
7046 * <p>If the ClipData contains items that are themselves Intents, any
7047 * grant flags in those Intents will be ignored. Only the top-level flags
7048 * of the main Intent are respected, and will be applied to all Uri or
7049 * Intent items in the clip (or sub-items of the clip).
7050 *
7051 * <p>The MIME type, label, and icon in the ClipData object are not
7052 * directly used by Intent. Applications should generally rely on the
7053 * MIME type of the Intent itself, not what it may find in the ClipData.
7054 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05007055 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007056 *
7057 * @param clip The new clip to set. May be null to clear the current clip.
7058 */
7059 public void setClipData(ClipData clip) {
7060 mClipData = clip;
7061 }
7062
7063 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007064 * This is NOT a secure mechanism to identify the user who sent the intent.
7065 * When the intent is sent to a different user, it is used to fix uris by adding the userId
7066 * who sent the intent.
7067 * @hide
7068 */
Nicolas Prevot107f7b72015-07-01 16:31:48 +01007069 public void prepareToLeaveUser(int userId) {
7070 // If mContentUserHint is not UserHandle.USER_CURRENT, the intent has already left a user.
7071 // We want mContentUserHint to refer to the original user, so don't do anything.
7072 if (mContentUserHint == UserHandle.USER_CURRENT) {
7073 mContentUserHint = userId;
7074 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007075 }
7076
7077 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007078 * Add extended data to the intent. The name must include a package
7079 * prefix, for example the app com.android.contacts would use names
7080 * like "com.android.contacts.ShowAll".
7081 *
7082 * @param name The name of the extra data, with package prefix.
7083 * @param value The boolean data value.
7084 *
7085 * @return Returns the same Intent object, for chaining multiple calls
7086 * into a single statement.
7087 *
7088 * @see #putExtras
7089 * @see #removeExtra
7090 * @see #getBooleanExtra(String, boolean)
7091 */
7092 public Intent putExtra(String name, boolean value) {
7093 if (mExtras == null) {
7094 mExtras = new Bundle();
7095 }
7096 mExtras.putBoolean(name, value);
7097 return this;
7098 }
7099
7100 /**
7101 * Add extended data to the intent. The name must include a package
7102 * prefix, for example the app com.android.contacts would use names
7103 * like "com.android.contacts.ShowAll".
7104 *
7105 * @param name The name of the extra data, with package prefix.
7106 * @param value The byte data value.
7107 *
7108 * @return Returns the same Intent object, for chaining multiple calls
7109 * into a single statement.
7110 *
7111 * @see #putExtras
7112 * @see #removeExtra
7113 * @see #getByteExtra(String, byte)
7114 */
7115 public Intent putExtra(String name, byte value) {
7116 if (mExtras == null) {
7117 mExtras = new Bundle();
7118 }
7119 mExtras.putByte(name, value);
7120 return this;
7121 }
7122
7123 /**
7124 * Add extended data to the intent. The name must include a package
7125 * prefix, for example the app com.android.contacts would use names
7126 * like "com.android.contacts.ShowAll".
7127 *
7128 * @param name The name of the extra data, with package prefix.
7129 * @param value The char data value.
7130 *
7131 * @return Returns the same Intent object, for chaining multiple calls
7132 * into a single statement.
7133 *
7134 * @see #putExtras
7135 * @see #removeExtra
7136 * @see #getCharExtra(String, char)
7137 */
7138 public Intent putExtra(String name, char value) {
7139 if (mExtras == null) {
7140 mExtras = new Bundle();
7141 }
7142 mExtras.putChar(name, value);
7143 return this;
7144 }
7145
7146 /**
7147 * Add extended data to the intent. The name must include a package
7148 * prefix, for example the app com.android.contacts would use names
7149 * like "com.android.contacts.ShowAll".
7150 *
7151 * @param name The name of the extra data, with package prefix.
7152 * @param value The short data value.
7153 *
7154 * @return Returns the same Intent object, for chaining multiple calls
7155 * into a single statement.
7156 *
7157 * @see #putExtras
7158 * @see #removeExtra
7159 * @see #getShortExtra(String, short)
7160 */
7161 public Intent putExtra(String name, short value) {
7162 if (mExtras == null) {
7163 mExtras = new Bundle();
7164 }
7165 mExtras.putShort(name, value);
7166 return this;
7167 }
7168
7169 /**
7170 * Add extended data to the intent. The name must include a package
7171 * prefix, for example the app com.android.contacts would use names
7172 * like "com.android.contacts.ShowAll".
7173 *
7174 * @param name The name of the extra data, with package prefix.
7175 * @param value The integer data value.
7176 *
7177 * @return Returns the same Intent object, for chaining multiple calls
7178 * into a single statement.
7179 *
7180 * @see #putExtras
7181 * @see #removeExtra
7182 * @see #getIntExtra(String, int)
7183 */
7184 public Intent putExtra(String name, int value) {
7185 if (mExtras == null) {
7186 mExtras = new Bundle();
7187 }
7188 mExtras.putInt(name, value);
7189 return this;
7190 }
7191
7192 /**
7193 * Add extended data to the intent. The name must include a package
7194 * prefix, for example the app com.android.contacts would use names
7195 * like "com.android.contacts.ShowAll".
7196 *
7197 * @param name The name of the extra data, with package prefix.
7198 * @param value The long data value.
7199 *
7200 * @return Returns the same Intent object, for chaining multiple calls
7201 * into a single statement.
7202 *
7203 * @see #putExtras
7204 * @see #removeExtra
7205 * @see #getLongExtra(String, long)
7206 */
7207 public Intent putExtra(String name, long value) {
7208 if (mExtras == null) {
7209 mExtras = new Bundle();
7210 }
7211 mExtras.putLong(name, value);
7212 return this;
7213 }
7214
7215 /**
7216 * Add extended data to the intent. The name must include a package
7217 * prefix, for example the app com.android.contacts would use names
7218 * like "com.android.contacts.ShowAll".
7219 *
7220 * @param name The name of the extra data, with package prefix.
7221 * @param value The float data value.
7222 *
7223 * @return Returns the same Intent object, for chaining multiple calls
7224 * into a single statement.
7225 *
7226 * @see #putExtras
7227 * @see #removeExtra
7228 * @see #getFloatExtra(String, float)
7229 */
7230 public Intent putExtra(String name, float value) {
7231 if (mExtras == null) {
7232 mExtras = new Bundle();
7233 }
7234 mExtras.putFloat(name, value);
7235 return this;
7236 }
7237
7238 /**
7239 * Add extended data to the intent. The name must include a package
7240 * prefix, for example the app com.android.contacts would use names
7241 * like "com.android.contacts.ShowAll".
7242 *
7243 * @param name The name of the extra data, with package prefix.
7244 * @param value The double data value.
7245 *
7246 * @return Returns the same Intent object, for chaining multiple calls
7247 * into a single statement.
7248 *
7249 * @see #putExtras
7250 * @see #removeExtra
7251 * @see #getDoubleExtra(String, double)
7252 */
7253 public Intent putExtra(String name, double value) {
7254 if (mExtras == null) {
7255 mExtras = new Bundle();
7256 }
7257 mExtras.putDouble(name, value);
7258 return this;
7259 }
7260
7261 /**
7262 * Add extended data to the intent. The name must include a package
7263 * prefix, for example the app com.android.contacts would use names
7264 * like "com.android.contacts.ShowAll".
7265 *
7266 * @param name The name of the extra data, with package prefix.
7267 * @param value The String data value.
7268 *
7269 * @return Returns the same Intent object, for chaining multiple calls
7270 * into a single statement.
7271 *
7272 * @see #putExtras
7273 * @see #removeExtra
7274 * @see #getStringExtra(String)
7275 */
7276 public Intent putExtra(String name, String value) {
7277 if (mExtras == null) {
7278 mExtras = new Bundle();
7279 }
7280 mExtras.putString(name, value);
7281 return this;
7282 }
7283
7284 /**
7285 * Add extended data to the intent. The name must include a package
7286 * prefix, for example the app com.android.contacts would use names
7287 * like "com.android.contacts.ShowAll".
7288 *
7289 * @param name The name of the extra data, with package prefix.
7290 * @param value The CharSequence data value.
7291 *
7292 * @return Returns the same Intent object, for chaining multiple calls
7293 * into a single statement.
7294 *
7295 * @see #putExtras
7296 * @see #removeExtra
7297 * @see #getCharSequenceExtra(String)
7298 */
7299 public Intent putExtra(String name, CharSequence value) {
7300 if (mExtras == null) {
7301 mExtras = new Bundle();
7302 }
7303 mExtras.putCharSequence(name, value);
7304 return this;
7305 }
7306
7307 /**
7308 * Add extended data to the intent. The name must include a package
7309 * prefix, for example the app com.android.contacts would use names
7310 * like "com.android.contacts.ShowAll".
7311 *
7312 * @param name The name of the extra data, with package prefix.
7313 * @param value The Parcelable data value.
7314 *
7315 * @return Returns the same Intent object, for chaining multiple calls
7316 * into a single statement.
7317 *
7318 * @see #putExtras
7319 * @see #removeExtra
7320 * @see #getParcelableExtra(String)
7321 */
7322 public Intent putExtra(String name, Parcelable value) {
7323 if (mExtras == null) {
7324 mExtras = new Bundle();
7325 }
7326 mExtras.putParcelable(name, value);
7327 return this;
7328 }
7329
7330 /**
7331 * Add extended data to the intent. The name must include a package
7332 * prefix, for example the app com.android.contacts would use names
7333 * like "com.android.contacts.ShowAll".
7334 *
7335 * @param name The name of the extra data, with package prefix.
7336 * @param value The Parcelable[] data value.
7337 *
7338 * @return Returns the same Intent object, for chaining multiple calls
7339 * into a single statement.
7340 *
7341 * @see #putExtras
7342 * @see #removeExtra
7343 * @see #getParcelableArrayExtra(String)
7344 */
7345 public Intent putExtra(String name, Parcelable[] value) {
7346 if (mExtras == null) {
7347 mExtras = new Bundle();
7348 }
7349 mExtras.putParcelableArray(name, value);
7350 return this;
7351 }
7352
7353 /**
7354 * Add extended data to the intent. The name must include a package
7355 * prefix, for example the app com.android.contacts would use names
7356 * like "com.android.contacts.ShowAll".
7357 *
7358 * @param name The name of the extra data, with package prefix.
7359 * @param value The ArrayList<Parcelable> data value.
7360 *
7361 * @return Returns the same Intent object, for chaining multiple calls
7362 * into a single statement.
7363 *
7364 * @see #putExtras
7365 * @see #removeExtra
7366 * @see #getParcelableArrayListExtra(String)
7367 */
7368 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
7369 if (mExtras == null) {
7370 mExtras = new Bundle();
7371 }
7372 mExtras.putParcelableArrayList(name, value);
7373 return this;
7374 }
7375
7376 /**
7377 * Add extended data to the intent. The name must include a package
7378 * prefix, for example the app com.android.contacts would use names
7379 * like "com.android.contacts.ShowAll".
7380 *
7381 * @param name The name of the extra data, with package prefix.
7382 * @param value The ArrayList<Integer> data value.
7383 *
7384 * @return Returns the same Intent object, for chaining multiple calls
7385 * into a single statement.
7386 *
7387 * @see #putExtras
7388 * @see #removeExtra
7389 * @see #getIntegerArrayListExtra(String)
7390 */
7391 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
7392 if (mExtras == null) {
7393 mExtras = new Bundle();
7394 }
7395 mExtras.putIntegerArrayList(name, value);
7396 return this;
7397 }
7398
7399 /**
7400 * Add extended data to the intent. The name must include a package
7401 * prefix, for example the app com.android.contacts would use names
7402 * like "com.android.contacts.ShowAll".
7403 *
7404 * @param name The name of the extra data, with package prefix.
7405 * @param value The ArrayList<String> data value.
7406 *
7407 * @return Returns the same Intent object, for chaining multiple calls
7408 * into a single statement.
7409 *
7410 * @see #putExtras
7411 * @see #removeExtra
7412 * @see #getStringArrayListExtra(String)
7413 */
7414 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
7415 if (mExtras == null) {
7416 mExtras = new Bundle();
7417 }
7418 mExtras.putStringArrayList(name, value);
7419 return this;
7420 }
7421
7422 /**
7423 * Add extended data to the intent. The name must include a package
7424 * prefix, for example the app com.android.contacts would use names
7425 * like "com.android.contacts.ShowAll".
7426 *
7427 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007428 * @param value The ArrayList<CharSequence> data value.
7429 *
7430 * @return Returns the same Intent object, for chaining multiple calls
7431 * into a single statement.
7432 *
7433 * @see #putExtras
7434 * @see #removeExtra
7435 * @see #getCharSequenceArrayListExtra(String)
7436 */
7437 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
7438 if (mExtras == null) {
7439 mExtras = new Bundle();
7440 }
7441 mExtras.putCharSequenceArrayList(name, value);
7442 return this;
7443 }
7444
7445 /**
7446 * Add extended data to the intent. The name must include a package
7447 * prefix, for example the app com.android.contacts would use names
7448 * like "com.android.contacts.ShowAll".
7449 *
7450 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007451 * @param value The Serializable data value.
7452 *
7453 * @return Returns the same Intent object, for chaining multiple calls
7454 * into a single statement.
7455 *
7456 * @see #putExtras
7457 * @see #removeExtra
7458 * @see #getSerializableExtra(String)
7459 */
7460 public Intent putExtra(String name, Serializable value) {
7461 if (mExtras == null) {
7462 mExtras = new Bundle();
7463 }
7464 mExtras.putSerializable(name, value);
7465 return this;
7466 }
7467
7468 /**
7469 * Add extended data to the intent. The name must include a package
7470 * prefix, for example the app com.android.contacts would use names
7471 * like "com.android.contacts.ShowAll".
7472 *
7473 * @param name The name of the extra data, with package prefix.
7474 * @param value The boolean array data value.
7475 *
7476 * @return Returns the same Intent object, for chaining multiple calls
7477 * into a single statement.
7478 *
7479 * @see #putExtras
7480 * @see #removeExtra
7481 * @see #getBooleanArrayExtra(String)
7482 */
7483 public Intent putExtra(String name, boolean[] value) {
7484 if (mExtras == null) {
7485 mExtras = new Bundle();
7486 }
7487 mExtras.putBooleanArray(name, value);
7488 return this;
7489 }
7490
7491 /**
7492 * Add extended data to the intent. The name must include a package
7493 * prefix, for example the app com.android.contacts would use names
7494 * like "com.android.contacts.ShowAll".
7495 *
7496 * @param name The name of the extra data, with package prefix.
7497 * @param value The byte array data value.
7498 *
7499 * @return Returns the same Intent object, for chaining multiple calls
7500 * into a single statement.
7501 *
7502 * @see #putExtras
7503 * @see #removeExtra
7504 * @see #getByteArrayExtra(String)
7505 */
7506 public Intent putExtra(String name, byte[] value) {
7507 if (mExtras == null) {
7508 mExtras = new Bundle();
7509 }
7510 mExtras.putByteArray(name, value);
7511 return this;
7512 }
7513
7514 /**
7515 * Add extended data to the intent. The name must include a package
7516 * prefix, for example the app com.android.contacts would use names
7517 * like "com.android.contacts.ShowAll".
7518 *
7519 * @param name The name of the extra data, with package prefix.
7520 * @param value The short array data value.
7521 *
7522 * @return Returns the same Intent object, for chaining multiple calls
7523 * into a single statement.
7524 *
7525 * @see #putExtras
7526 * @see #removeExtra
7527 * @see #getShortArrayExtra(String)
7528 */
7529 public Intent putExtra(String name, short[] value) {
7530 if (mExtras == null) {
7531 mExtras = new Bundle();
7532 }
7533 mExtras.putShortArray(name, value);
7534 return this;
7535 }
7536
7537 /**
7538 * Add extended data to the intent. The name must include a package
7539 * prefix, for example the app com.android.contacts would use names
7540 * like "com.android.contacts.ShowAll".
7541 *
7542 * @param name The name of the extra data, with package prefix.
7543 * @param value The char array data value.
7544 *
7545 * @return Returns the same Intent object, for chaining multiple calls
7546 * into a single statement.
7547 *
7548 * @see #putExtras
7549 * @see #removeExtra
7550 * @see #getCharArrayExtra(String)
7551 */
7552 public Intent putExtra(String name, char[] value) {
7553 if (mExtras == null) {
7554 mExtras = new Bundle();
7555 }
7556 mExtras.putCharArray(name, value);
7557 return this;
7558 }
7559
7560 /**
7561 * Add extended data to the intent. The name must include a package
7562 * prefix, for example the app com.android.contacts would use names
7563 * like "com.android.contacts.ShowAll".
7564 *
7565 * @param name The name of the extra data, with package prefix.
7566 * @param value The int array data value.
7567 *
7568 * @return Returns the same Intent object, for chaining multiple calls
7569 * into a single statement.
7570 *
7571 * @see #putExtras
7572 * @see #removeExtra
7573 * @see #getIntArrayExtra(String)
7574 */
7575 public Intent putExtra(String name, int[] value) {
7576 if (mExtras == null) {
7577 mExtras = new Bundle();
7578 }
7579 mExtras.putIntArray(name, value);
7580 return this;
7581 }
7582
7583 /**
7584 * Add extended data to the intent. The name must include a package
7585 * prefix, for example the app com.android.contacts would use names
7586 * like "com.android.contacts.ShowAll".
7587 *
7588 * @param name The name of the extra data, with package prefix.
7589 * @param value The byte array data value.
7590 *
7591 * @return Returns the same Intent object, for chaining multiple calls
7592 * into a single statement.
7593 *
7594 * @see #putExtras
7595 * @see #removeExtra
7596 * @see #getLongArrayExtra(String)
7597 */
7598 public Intent putExtra(String name, long[] value) {
7599 if (mExtras == null) {
7600 mExtras = new Bundle();
7601 }
7602 mExtras.putLongArray(name, value);
7603 return this;
7604 }
7605
7606 /**
7607 * Add extended data to the intent. The name must include a package
7608 * prefix, for example the app com.android.contacts would use names
7609 * like "com.android.contacts.ShowAll".
7610 *
7611 * @param name The name of the extra data, with package prefix.
7612 * @param value The float array data value.
7613 *
7614 * @return Returns the same Intent object, for chaining multiple calls
7615 * into a single statement.
7616 *
7617 * @see #putExtras
7618 * @see #removeExtra
7619 * @see #getFloatArrayExtra(String)
7620 */
7621 public Intent putExtra(String name, float[] value) {
7622 if (mExtras == null) {
7623 mExtras = new Bundle();
7624 }
7625 mExtras.putFloatArray(name, value);
7626 return this;
7627 }
7628
7629 /**
7630 * Add extended data to the intent. The name must include a package
7631 * prefix, for example the app com.android.contacts would use names
7632 * like "com.android.contacts.ShowAll".
7633 *
7634 * @param name The name of the extra data, with package prefix.
7635 * @param value The double array data value.
7636 *
7637 * @return Returns the same Intent object, for chaining multiple calls
7638 * into a single statement.
7639 *
7640 * @see #putExtras
7641 * @see #removeExtra
7642 * @see #getDoubleArrayExtra(String)
7643 */
7644 public Intent putExtra(String name, double[] value) {
7645 if (mExtras == null) {
7646 mExtras = new Bundle();
7647 }
7648 mExtras.putDoubleArray(name, value);
7649 return this;
7650 }
7651
7652 /**
7653 * Add extended data to the intent. The name must include a package
7654 * prefix, for example the app com.android.contacts would use names
7655 * like "com.android.contacts.ShowAll".
7656 *
7657 * @param name The name of the extra data, with package prefix.
7658 * @param value The String array data value.
7659 *
7660 * @return Returns the same Intent object, for chaining multiple calls
7661 * into a single statement.
7662 *
7663 * @see #putExtras
7664 * @see #removeExtra
7665 * @see #getStringArrayExtra(String)
7666 */
7667 public Intent putExtra(String name, String[] value) {
7668 if (mExtras == null) {
7669 mExtras = new Bundle();
7670 }
7671 mExtras.putStringArray(name, value);
7672 return this;
7673 }
7674
7675 /**
7676 * Add extended data to the intent. The name must include a package
7677 * prefix, for example the app com.android.contacts would use names
7678 * like "com.android.contacts.ShowAll".
7679 *
7680 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00007681 * @param value The CharSequence array data value.
7682 *
7683 * @return Returns the same Intent object, for chaining multiple calls
7684 * into a single statement.
7685 *
7686 * @see #putExtras
7687 * @see #removeExtra
7688 * @see #getCharSequenceArrayExtra(String)
7689 */
7690 public Intent putExtra(String name, CharSequence[] value) {
7691 if (mExtras == null) {
7692 mExtras = new Bundle();
7693 }
7694 mExtras.putCharSequenceArray(name, value);
7695 return this;
7696 }
7697
7698 /**
7699 * Add extended data to the intent. The name must include a package
7700 * prefix, for example the app com.android.contacts would use names
7701 * like "com.android.contacts.ShowAll".
7702 *
7703 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007704 * @param value The Bundle data value.
7705 *
7706 * @return Returns the same Intent object, for chaining multiple calls
7707 * into a single statement.
7708 *
7709 * @see #putExtras
7710 * @see #removeExtra
7711 * @see #getBundleExtra(String)
7712 */
7713 public Intent putExtra(String name, Bundle value) {
7714 if (mExtras == null) {
7715 mExtras = new Bundle();
7716 }
7717 mExtras.putBundle(name, value);
7718 return this;
7719 }
7720
7721 /**
7722 * Add extended data to the intent. The name must include a package
7723 * prefix, for example the app com.android.contacts would use names
7724 * like "com.android.contacts.ShowAll".
7725 *
7726 * @param name The name of the extra data, with package prefix.
7727 * @param value The IBinder data value.
7728 *
7729 * @return Returns the same Intent object, for chaining multiple calls
7730 * into a single statement.
7731 *
7732 * @see #putExtras
7733 * @see #removeExtra
7734 * @see #getIBinderExtra(String)
7735 *
7736 * @deprecated
7737 * @hide
7738 */
7739 @Deprecated
7740 public Intent putExtra(String name, IBinder value) {
7741 if (mExtras == null) {
7742 mExtras = new Bundle();
7743 }
7744 mExtras.putIBinder(name, value);
7745 return this;
7746 }
7747
7748 /**
7749 * Copy all extras in 'src' in to this intent.
7750 *
7751 * @param src Contains the extras to copy.
7752 *
7753 * @see #putExtra
7754 */
7755 public Intent putExtras(Intent src) {
7756 if (src.mExtras != null) {
7757 if (mExtras == null) {
7758 mExtras = new Bundle(src.mExtras);
7759 } else {
7760 mExtras.putAll(src.mExtras);
7761 }
7762 }
7763 return this;
7764 }
7765
7766 /**
7767 * Add a set of extended data to the intent. The keys must include a package
7768 * prefix, for example the app com.android.contacts would use names
7769 * like "com.android.contacts.ShowAll".
7770 *
7771 * @param extras The Bundle of extras to add to this intent.
7772 *
7773 * @see #putExtra
7774 * @see #removeExtra
7775 */
7776 public Intent putExtras(Bundle extras) {
7777 if (mExtras == null) {
7778 mExtras = new Bundle();
7779 }
7780 mExtras.putAll(extras);
7781 return this;
7782 }
7783
7784 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007785 * Completely replace the extras in the Intent with the extras in the
7786 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07007787 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007788 * @param src The exact extras contained in this Intent are copied
7789 * into the target intent, replacing any that were previously there.
7790 */
7791 public Intent replaceExtras(Intent src) {
7792 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
7793 return this;
7794 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007795
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007796 /**
7797 * Completely replace the extras in the Intent with the given Bundle of
7798 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07007799 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007800 * @param extras The new set of extras in the Intent, or null to erase
7801 * all extras.
7802 */
7803 public Intent replaceExtras(Bundle extras) {
7804 mExtras = extras != null ? new Bundle(extras) : null;
7805 return this;
7806 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007807
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007808 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007809 * Remove extended data from the intent.
7810 *
7811 * @see #putExtra
7812 */
7813 public void removeExtra(String name) {
7814 if (mExtras != null) {
7815 mExtras.remove(name);
7816 if (mExtras.size() == 0) {
7817 mExtras = null;
7818 }
7819 }
7820 }
7821
7822 /**
7823 * Set special flags controlling how this intent is handled. Most values
7824 * here depend on the type of component being executed by the Intent,
7825 * specifically the FLAG_ACTIVITY_* flags are all for use with
7826 * {@link Context#startActivity Context.startActivity()} and the
7827 * FLAG_RECEIVER_* flags are all for use with
7828 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
7829 *
Scott Main7aee61f2011-02-08 11:25:01 -08007830 * <p>See the
7831 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
7832 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007833 * the behavior of your application.
7834 *
7835 * @param flags The desired flags.
7836 *
7837 * @return Returns the same Intent object, for chaining multiple calls
7838 * into a single statement.
7839 *
7840 * @see #getFlags
7841 * @see #addFlags
7842 *
7843 * @see #FLAG_GRANT_READ_URI_PERMISSION
7844 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07007845 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7846 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007847 * @see #FLAG_DEBUG_LOG_RESOLUTION
7848 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007849 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007850 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007851 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007852 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007853 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
7854 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007855 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007856 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07007857 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007858 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007859 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007860 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08007861 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007862 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
7863 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007864 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007865 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08007866 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007867 * @see #FLAG_RECEIVER_REGISTERED_ONLY
7868 */
7869 public Intent setFlags(int flags) {
7870 mFlags = flags;
7871 return this;
7872 }
7873
7874 /**
7875 * Add additional flags to the intent (or with existing flags
7876 * value).
7877 *
7878 * @param flags The new flags to set.
7879 *
7880 * @return Returns the same Intent object, for chaining multiple calls
7881 * into a single statement.
7882 *
7883 * @see #setFlags
7884 */
7885 public Intent addFlags(int flags) {
7886 mFlags |= flags;
7887 return this;
7888 }
7889
7890 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007891 * (Usually optional) Set an explicit application package name that limits
7892 * the components this Intent will resolve to. If left to the default
7893 * value of null, all components in all applications will considered.
7894 * If non-null, the Intent can only match the components in the given
7895 * application package.
7896 *
7897 * @param packageName The name of the application package to handle the
7898 * intent, or null to allow any application package.
7899 *
7900 * @return Returns the same Intent object, for chaining multiple calls
7901 * into a single statement.
7902 *
7903 * @see #getPackage
7904 * @see #resolveActivity
7905 */
7906 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007907 if (packageName != null && mSelector != null) {
7908 throw new IllegalArgumentException(
7909 "Can't set package name when selector is already set");
7910 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007911 mPackage = packageName;
7912 return this;
7913 }
7914
7915 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007916 * (Usually optional) Explicitly set the component to handle the intent.
7917 * If left with the default value of null, the system will determine the
7918 * appropriate class to use based on the other fields (action, data,
7919 * type, categories) in the Intent. If this class is defined, the
7920 * specified class will always be used regardless of the other fields. You
7921 * should only set this value when you know you absolutely want a specific
7922 * class to be used; otherwise it is better to let the system find the
7923 * appropriate class so that you will respect the installed applications
7924 * and user preferences.
7925 *
7926 * @param component The name of the application component to handle the
7927 * intent, or null to let the system find one for you.
7928 *
7929 * @return Returns the same Intent object, for chaining multiple calls
7930 * into a single statement.
7931 *
7932 * @see #setClass
7933 * @see #setClassName(Context, String)
7934 * @see #setClassName(String, String)
7935 * @see #getComponent
7936 * @see #resolveActivity
7937 */
7938 public Intent setComponent(ComponentName component) {
7939 mComponent = component;
7940 return this;
7941 }
7942
7943 /**
7944 * Convenience for calling {@link #setComponent} with an
7945 * explicit class name.
7946 *
7947 * @param packageContext A Context of the application package implementing
7948 * this class.
7949 * @param className The name of a class inside of the application package
7950 * that will be used as the component for this Intent.
7951 *
7952 * @return Returns the same Intent object, for chaining multiple calls
7953 * into a single statement.
7954 *
7955 * @see #setComponent
7956 * @see #setClass
7957 */
7958 public Intent setClassName(Context packageContext, String className) {
7959 mComponent = new ComponentName(packageContext, className);
7960 return this;
7961 }
7962
7963 /**
7964 * Convenience for calling {@link #setComponent} with an
7965 * explicit application package name and class name.
7966 *
7967 * @param packageName The name of the package implementing the desired
7968 * component.
7969 * @param className The name of a class inside of the application package
7970 * that will be used as the component for this Intent.
7971 *
7972 * @return Returns the same Intent object, for chaining multiple calls
7973 * into a single statement.
7974 *
7975 * @see #setComponent
7976 * @see #setClass
7977 */
7978 public Intent setClassName(String packageName, String className) {
7979 mComponent = new ComponentName(packageName, className);
7980 return this;
7981 }
7982
7983 /**
7984 * Convenience for calling {@link #setComponent(ComponentName)} with the
7985 * name returned by a {@link Class} object.
7986 *
7987 * @param packageContext A Context of the application package implementing
7988 * this class.
7989 * @param cls The class name to set, equivalent to
7990 * <code>setClassName(context, cls.getName())</code>.
7991 *
7992 * @return Returns the same Intent object, for chaining multiple calls
7993 * into a single statement.
7994 *
7995 * @see #setComponent
7996 */
7997 public Intent setClass(Context packageContext, Class<?> cls) {
7998 mComponent = new ComponentName(packageContext, cls);
7999 return this;
8000 }
8001
8002 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008003 * Set the bounds of the sender of this intent, in screen coordinates. This can be
8004 * used as a hint to the receiver for animations and the like. Null means that there
8005 * is no source bounds.
8006 */
8007 public void setSourceBounds(Rect r) {
8008 if (r != null) {
8009 mSourceBounds = new Rect(r);
8010 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07008011 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008012 }
8013 }
8014
Tor Norbyed9273d62013-05-30 15:59:53 -07008015 /** @hide */
8016 @IntDef(flag = true,
8017 value = {
8018 FILL_IN_ACTION,
8019 FILL_IN_DATA,
8020 FILL_IN_CATEGORIES,
8021 FILL_IN_COMPONENT,
8022 FILL_IN_PACKAGE,
8023 FILL_IN_SOURCE_BOUNDS,
8024 FILL_IN_SELECTOR,
8025 FILL_IN_CLIP_DATA
8026 })
8027 @Retention(RetentionPolicy.SOURCE)
8028 public @interface FillInFlags {}
8029
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008030 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008031 * Use with {@link #fillIn} to allow the current action value to be
8032 * overwritten, even if it is already set.
8033 */
8034 public static final int FILL_IN_ACTION = 1<<0;
8035
8036 /**
8037 * Use with {@link #fillIn} to allow the current data or type value
8038 * overwritten, even if it is already set.
8039 */
8040 public static final int FILL_IN_DATA = 1<<1;
8041
8042 /**
8043 * Use with {@link #fillIn} to allow the current categories to be
8044 * overwritten, even if they are already set.
8045 */
8046 public static final int FILL_IN_CATEGORIES = 1<<2;
8047
8048 /**
8049 * Use with {@link #fillIn} to allow the current component value to be
8050 * overwritten, even if it is already set.
8051 */
8052 public static final int FILL_IN_COMPONENT = 1<<3;
8053
8054 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008055 * Use with {@link #fillIn} to allow the current package value to be
8056 * overwritten, even if it is already set.
8057 */
8058 public static final int FILL_IN_PACKAGE = 1<<4;
8059
8060 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008061 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008062 * overwritten, even if it is already set.
8063 */
8064 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
8065
8066 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008067 * Use with {@link #fillIn} to allow the current selector to be
8068 * overwritten, even if it is already set.
8069 */
8070 public static final int FILL_IN_SELECTOR = 1<<6;
8071
8072 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008073 * Use with {@link #fillIn} to allow the current ClipData to be
8074 * overwritten, even if it is already set.
8075 */
8076 public static final int FILL_IN_CLIP_DATA = 1<<7;
8077
8078 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008079 * Copy the contents of <var>other</var> in to this object, but only
8080 * where fields are not defined by this object. For purposes of a field
8081 * being defined, the following pieces of data in the Intent are
8082 * considered to be separate fields:
8083 *
8084 * <ul>
8085 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08008086 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008087 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
8088 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008089 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008090 * <li> component, as set by {@link #setComponent(ComponentName)} or
8091 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008092 * <li> source bounds, as set by {@link #setSourceBounds}.
8093 * <li> selector, as set by {@link #setSelector(Intent)}.
8094 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008095 * <li> each top-level name in the associated extras.
8096 * </ul>
8097 *
8098 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008099 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008100 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8101 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
8102 * the restriction where the corresponding field will not be replaced if
8103 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008104 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008105 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
8106 * is explicitly specified. The selector will only be copied if
8107 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07008108 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008109 * <p>For example, consider Intent A with {data="foo", categories="bar"}
8110 * and Intent B with {action="gotit", data-type="some/thing",
8111 * categories="one","two"}.
8112 *
8113 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
8114 * containing: {action="gotit", data-type="some/thing",
8115 * categories="bar"}.
8116 *
8117 * @param other Another Intent whose values are to be used to fill in
8118 * the current one.
8119 * @param flags Options to control which fields can be filled in.
8120 *
8121 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008122 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07008123 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
8124 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
8125 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008126 */
Tor Norbyed9273d62013-05-30 15:59:53 -07008127 @FillInFlags
8128 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008129 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008130 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008131 if (other.mAction != null
8132 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008133 mAction = other.mAction;
8134 changes |= FILL_IN_ACTION;
8135 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008136 if ((other.mData != null || other.mType != null)
8137 && ((mData == null && mType == null)
8138 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008139 mData = other.mData;
8140 mType = other.mType;
8141 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008142 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008143 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008144 if (other.mCategories != null
8145 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008146 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008147 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008148 }
8149 changes |= FILL_IN_CATEGORIES;
8150 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008151 if (other.mPackage != null
8152 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008153 // Only do this if mSelector is not set.
8154 if (mSelector == null) {
8155 mPackage = other.mPackage;
8156 changes |= FILL_IN_PACKAGE;
8157 }
8158 }
8159 // Selector is special: it can only be set if explicitly allowed,
8160 // for the same reason as the component name.
8161 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
8162 if (mPackage == null) {
8163 mSelector = new Intent(other.mSelector);
8164 mPackage = null;
8165 changes |= FILL_IN_SELECTOR;
8166 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008167 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008168 if (other.mClipData != null
8169 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
8170 mClipData = other.mClipData;
8171 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008172 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008173 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008174 // Component is special: it can -only- be set if explicitly allowed,
8175 // since otherwise the sender could force the intent somewhere the
8176 // originator didn't intend.
8177 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008178 mComponent = other.mComponent;
8179 changes |= FILL_IN_COMPONENT;
8180 }
8181 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008182 if (other.mSourceBounds != null
8183 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
8184 mSourceBounds = new Rect(other.mSourceBounds);
8185 changes |= FILL_IN_SOURCE_BOUNDS;
8186 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008187 if (mExtras == null) {
8188 if (other.mExtras != null) {
8189 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008190 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008191 }
8192 } else if (other.mExtras != null) {
8193 try {
8194 Bundle newb = new Bundle(other.mExtras);
8195 newb.putAll(mExtras);
8196 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008197 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008198 } catch (RuntimeException e) {
8199 // Modifying the extras can cause us to unparcel the contents
8200 // of the bundle, and if we do this in the system process that
8201 // may fail. We really should handle this (i.e., the Bundle
8202 // impl shouldn't be on top of a plain map), but for now just
8203 // ignore it and keep the original contents. :(
8204 Log.w("Intent", "Failure filling in extras", e);
8205 }
8206 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008207 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
8208 && other.mContentUserHint != UserHandle.USER_CURRENT) {
8209 mContentUserHint = other.mContentUserHint;
8210 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008211 return changes;
8212 }
8213
8214 /**
8215 * Wrapper class holding an Intent and implementing comparisons on it for
8216 * the purpose of filtering. The class implements its
8217 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
8218 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
8219 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
8220 * on the wrapped Intent.
8221 */
8222 public static final class FilterComparison {
8223 private final Intent mIntent;
8224 private final int mHashCode;
8225
8226 public FilterComparison(Intent intent) {
8227 mIntent = intent;
8228 mHashCode = intent.filterHashCode();
8229 }
8230
8231 /**
8232 * Return the Intent that this FilterComparison represents.
8233 * @return Returns the Intent held by the FilterComparison. Do
8234 * not modify!
8235 */
8236 public Intent getIntent() {
8237 return mIntent;
8238 }
8239
8240 @Override
8241 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008242 if (obj instanceof FilterComparison) {
8243 Intent other = ((FilterComparison)obj).mIntent;
8244 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008245 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008246 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008247 }
8248
8249 @Override
8250 public int hashCode() {
8251 return mHashCode;
8252 }
8253 }
8254
8255 /**
8256 * Determine if two intents are the same for the purposes of intent
8257 * resolution (filtering). That is, if their action, data, type,
8258 * class, and categories are the same. This does <em>not</em> compare
8259 * any extra data included in the intents.
8260 *
8261 * @param other The other Intent to compare against.
8262 *
8263 * @return Returns true if action, data, type, class, and categories
8264 * are the same.
8265 */
8266 public boolean filterEquals(Intent other) {
8267 if (other == null) {
8268 return false;
8269 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07008270 if (!Objects.equals(this.mAction, other.mAction)) return false;
8271 if (!Objects.equals(this.mData, other.mData)) return false;
8272 if (!Objects.equals(this.mType, other.mType)) return false;
8273 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
8274 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
8275 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008276
8277 return true;
8278 }
8279
8280 /**
8281 * Generate hash code that matches semantics of filterEquals().
8282 *
8283 * @return Returns the hash value of the action, data, type, class, and
8284 * categories.
8285 *
8286 * @see #filterEquals
8287 */
8288 public int filterHashCode() {
8289 int code = 0;
8290 if (mAction != null) {
8291 code += mAction.hashCode();
8292 }
8293 if (mData != null) {
8294 code += mData.hashCode();
8295 }
8296 if (mType != null) {
8297 code += mType.hashCode();
8298 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008299 if (mPackage != null) {
8300 code += mPackage.hashCode();
8301 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008302 if (mComponent != null) {
8303 code += mComponent.hashCode();
8304 }
8305 if (mCategories != null) {
8306 code += mCategories.hashCode();
8307 }
8308 return code;
8309 }
8310
8311 @Override
8312 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008313 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008314
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008315 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008316 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008317 b.append(" }");
8318
8319 return b.toString();
8320 }
8321
8322 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008323 public String toInsecureString() {
8324 StringBuilder b = new StringBuilder(128);
8325
8326 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008327 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008328 b.append(" }");
8329
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008330 return b.toString();
8331 }
Romain Guy4969af72009-06-17 10:53:19 -07008332
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008333 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008334 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008335 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008336
8337 b.append("Intent { ");
8338 toShortString(b, false, true, true, true);
8339 b.append(" }");
8340
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008341 return b.toString();
8342 }
8343
8344 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008345 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
8346 StringBuilder b = new StringBuilder(128);
8347 toShortString(b, secure, comp, extras, clip);
8348 return b.toString();
8349 }
8350
8351 /** @hide */
8352 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
8353 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008354 boolean first = true;
8355 if (mAction != null) {
8356 b.append("act=").append(mAction);
8357 first = false;
8358 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008359 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008360 if (!first) {
8361 b.append(' ');
8362 }
8363 first = false;
8364 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008365 for (int i=0; i<mCategories.size(); i++) {
8366 if (i > 0) b.append(',');
8367 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008368 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008369 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008370 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008371 if (mData != null) {
8372 if (!first) {
8373 b.append(' ');
8374 }
8375 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07008376 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07008377 if (secure) {
8378 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07008379 } else {
8380 b.append(mData);
8381 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008382 }
8383 if (mType != null) {
8384 if (!first) {
8385 b.append(' ');
8386 }
8387 first = false;
8388 b.append("typ=").append(mType);
8389 }
8390 if (mFlags != 0) {
8391 if (!first) {
8392 b.append(' ');
8393 }
8394 first = false;
8395 b.append("flg=0x").append(Integer.toHexString(mFlags));
8396 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008397 if (mPackage != null) {
8398 if (!first) {
8399 b.append(' ');
8400 }
8401 first = false;
8402 b.append("pkg=").append(mPackage);
8403 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008404 if (comp && mComponent != null) {
8405 if (!first) {
8406 b.append(' ');
8407 }
8408 first = false;
8409 b.append("cmp=").append(mComponent.flattenToShortString());
8410 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008411 if (mSourceBounds != null) {
8412 if (!first) {
8413 b.append(' ');
8414 }
8415 first = false;
8416 b.append("bnds=").append(mSourceBounds.toShortString());
8417 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008418 if (mClipData != null) {
8419 if (!first) {
8420 b.append(' ');
8421 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008422 b.append("clip={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008423 if (clip) {
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008424 mClipData.toShortString(b);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008425 } else {
Dianne Hackbornae498722015-08-14 13:29:47 -07008426 if (mClipData.getDescription() != null) {
8427 first = !mClipData.getDescription().toShortStringTypesOnly(b);
8428 } else {
8429 first = true;
8430 }
8431 mClipData.toShortStringShortItems(b, first);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008432 }
Dianne Hackbornae498722015-08-14 13:29:47 -07008433 first = false;
8434 b.append('}');
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008435 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008436 if (extras && mExtras != null) {
8437 if (!first) {
8438 b.append(' ');
8439 }
8440 first = false;
8441 b.append("(has extras)");
8442 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008443 if (mContentUserHint != UserHandle.USER_CURRENT) {
8444 if (!first) {
8445 b.append(' ');
8446 }
8447 first = false;
8448 b.append("u=").append(mContentUserHint);
8449 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008450 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008451 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008452 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008453 b.append("}");
8454 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008455 }
8456
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008457 /**
8458 * Call {@link #toUri} with 0 flags.
8459 * @deprecated Use {@link #toUri} instead.
8460 */
8461 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008462 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008463 return toUri(0);
8464 }
8465
8466 /**
8467 * Convert this Intent into a String holding a URI representation of it.
8468 * The returned URI string has been properly URI encoded, so it can be
8469 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
8470 * Intent's data as the base URI, with an additional fragment describing
8471 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08008472 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008473 * <p>You can convert the returned string back to an Intent with
8474 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08008475 *
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008476 * @param flags Additional operating flags. Either 0,
8477 * {@link #URI_INTENT_SCHEME}, or {@link #URI_ANDROID_APP_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08008478 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008479 * @return Returns a URI encoding URI string describing the entire contents
8480 * of the Intent.
8481 */
8482 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07008483 StringBuilder uri = new StringBuilder(128);
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008484 if ((flags&URI_ANDROID_APP_SCHEME) != 0) {
8485 if (mPackage == null) {
8486 throw new IllegalArgumentException(
8487 "Intent must include an explicit package name to build an android-app: "
8488 + this);
8489 }
8490 uri.append("android-app://");
8491 uri.append(mPackage);
8492 String scheme = null;
8493 if (mData != null) {
8494 scheme = mData.getScheme();
8495 if (scheme != null) {
8496 uri.append('/');
8497 uri.append(scheme);
8498 String authority = mData.getEncodedAuthority();
8499 if (authority != null) {
8500 uri.append('/');
8501 uri.append(authority);
8502 String path = mData.getEncodedPath();
8503 if (path != null) {
8504 uri.append(path);
8505 }
8506 String queryParams = mData.getEncodedQuery();
8507 if (queryParams != null) {
8508 uri.append('?');
8509 uri.append(queryParams);
8510 }
8511 String fragment = mData.getEncodedFragment();
8512 if (fragment != null) {
8513 uri.append('#');
8514 uri.append(fragment);
8515 }
8516 }
8517 }
8518 }
8519 toUriFragment(uri, null, scheme == null ? Intent.ACTION_MAIN : Intent.ACTION_VIEW,
8520 mPackage, flags);
8521 return uri.toString();
8522 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008523 String scheme = null;
8524 if (mData != null) {
8525 String data = mData.toString();
8526 if ((flags&URI_INTENT_SCHEME) != 0) {
8527 final int N = data.length();
8528 for (int i=0; i<N; i++) {
8529 char c = data.charAt(i);
8530 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
8531 || c == '.' || c == '-') {
8532 continue;
8533 }
8534 if (c == ':' && i > 0) {
8535 // Valid scheme.
8536 scheme = data.substring(0, i);
8537 uri.append("intent:");
8538 data = data.substring(i+1);
8539 break;
8540 }
Tom Taylord4a47292009-12-21 13:59:18 -08008541
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008542 // No scheme.
8543 break;
8544 }
8545 }
8546 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08008547
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008548 } else if ((flags&URI_INTENT_SCHEME) != 0) {
8549 uri.append("intent:");
8550 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008551
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008552 toUriFragment(uri, scheme, Intent.ACTION_VIEW, null, flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008553
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008554 return uri.toString();
8555 }
8556
8557 private void toUriFragment(StringBuilder uri, String scheme, String defAction,
8558 String defPackage, int flags) {
8559 StringBuilder frag = new StringBuilder(128);
8560
8561 toUriInner(frag, scheme, defAction, defPackage, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008562 if (mSelector != null) {
Dianne Hackborn80b1c562014-12-09 20:22:08 -08008563 frag.append("SEL;");
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008564 // Note that for now we are not going to try to handle the
8565 // data part; not clear how to represent this as a URI, and
8566 // not much utility in it.
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008567 mSelector.toUriInner(frag, mSelector.mData != null ? mSelector.mData.getScheme() : null,
8568 null, null, flags);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008569 }
8570
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008571 if (frag.length() > 0) {
8572 uri.append("#Intent;");
8573 uri.append(frag);
8574 uri.append("end");
8575 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008576 }
8577
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008578 private void toUriInner(StringBuilder uri, String scheme, String defAction,
8579 String defPackage, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008580 if (scheme != null) {
8581 uri.append("scheme=").append(scheme).append(';');
8582 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008583 if (mAction != null && !mAction.equals(defAction)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008584 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008585 }
8586 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008587 for (int i=0; i<mCategories.size(); i++) {
8588 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008589 }
8590 }
8591 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008592 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008593 }
8594 if (mFlags != 0) {
8595 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
8596 }
Dianne Hackborn85d558c2014-11-04 10:31:54 -08008597 if (mPackage != null && !mPackage.equals(defPackage)) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008598 uri.append("package=").append(Uri.encode(mPackage)).append(';');
8599 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008600 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008601 uri.append("component=").append(Uri.encode(
8602 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008603 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008604 if (mSourceBounds != null) {
8605 uri.append("sourceBounds=")
8606 .append(Uri.encode(mSourceBounds.flattenToString()))
8607 .append(';');
8608 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008609 if (mExtras != null) {
8610 for (String key : mExtras.keySet()) {
8611 final Object value = mExtras.get(key);
8612 char entryType =
8613 value instanceof String ? 'S' :
8614 value instanceof Boolean ? 'B' :
8615 value instanceof Byte ? 'b' :
8616 value instanceof Character ? 'c' :
8617 value instanceof Double ? 'd' :
8618 value instanceof Float ? 'f' :
8619 value instanceof Integer ? 'i' :
8620 value instanceof Long ? 'l' :
8621 value instanceof Short ? 's' :
8622 '\0';
8623
8624 if (entryType != '\0') {
8625 uri.append(entryType);
8626 uri.append('.');
8627 uri.append(Uri.encode(key));
8628 uri.append('=');
8629 uri.append(Uri.encode(value.toString()));
8630 uri.append(';');
8631 }
8632 }
8633 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008634 }
The Android Open Source Project10592532009-03-18 17:39:46 -07008635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008636 public int describeContents() {
8637 return (mExtras != null) ? mExtras.describeContents() : 0;
8638 }
8639
8640 public void writeToParcel(Parcel out, int flags) {
8641 out.writeString(mAction);
8642 Uri.writeToParcel(out, mData);
8643 out.writeString(mType);
8644 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008645 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008646 ComponentName.writeToParcel(mComponent, out);
8647
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008648 if (mSourceBounds != null) {
8649 out.writeInt(1);
8650 mSourceBounds.writeToParcel(out, flags);
8651 } else {
8652 out.writeInt(0);
8653 }
8654
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008655 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008656 final int N = mCategories.size();
8657 out.writeInt(N);
8658 for (int i=0; i<N; i++) {
8659 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008660 }
8661 } else {
8662 out.writeInt(0);
8663 }
8664
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008665 if (mSelector != null) {
8666 out.writeInt(1);
8667 mSelector.writeToParcel(out, flags);
8668 } else {
8669 out.writeInt(0);
8670 }
8671
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008672 if (mClipData != null) {
8673 out.writeInt(1);
8674 mClipData.writeToParcel(out, flags);
8675 } else {
8676 out.writeInt(0);
8677 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008678 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008679 out.writeBundle(mExtras);
8680 }
8681
8682 public static final Parcelable.Creator<Intent> CREATOR
8683 = new Parcelable.Creator<Intent>() {
8684 public Intent createFromParcel(Parcel in) {
8685 return new Intent(in);
8686 }
8687 public Intent[] newArray(int size) {
8688 return new Intent[size];
8689 }
8690 };
8691
Dianne Hackborneb034652009-09-07 00:49:58 -07008692 /** @hide */
8693 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008694 readFromParcel(in);
8695 }
8696
8697 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008698 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008699 mData = Uri.CREATOR.createFromParcel(in);
8700 mType = in.readString();
8701 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07008702 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008703 mComponent = ComponentName.readFromParcel(in);
8704
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08008705 if (in.readInt() != 0) {
8706 mSourceBounds = Rect.CREATOR.createFromParcel(in);
8707 }
8708
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008709 int N = in.readInt();
8710 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07008711 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008712 int i;
8713 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08008714 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008715 }
8716 } else {
8717 mCategories = null;
8718 }
8719
Dianne Hackbornf5b86712011-12-05 17:42:41 -08008720 if (in.readInt() != 0) {
8721 mSelector = new Intent(in);
8722 }
8723
Dianne Hackborn21c241e2012-03-08 13:57:23 -08008724 if (in.readInt() != 0) {
8725 mClipData = new ClipData(in);
8726 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008727 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008728 mExtras = in.readBundle();
8729 }
8730
8731 /**
8732 * Parses the "intent" element (and its children) from XML and instantiates
8733 * an Intent object. The given XML parser should be located at the tag
8734 * where parsing should start (often named "intent"), from which the
8735 * basic action, data, type, and package and class name will be
8736 * retrieved. The function will then parse in to any child elements,
8737 * looking for <category android:name="xxx"> tags to add categories and
8738 * <extra android:name="xxx" android:value="yyy"> to attach extra data
8739 * to the intent.
8740 *
8741 * @param resources The Resources to use when inflating resources.
8742 * @param parser The XML parser pointing at an "intent" tag.
8743 * @param attrs The AttributeSet interface for retrieving extended
8744 * attribute data at the current <var>parser</var> location.
8745 * @return An Intent object matching the XML data.
8746 * @throws XmlPullParserException If there was an XML parsing error.
8747 * @throws IOException If there was an I/O error.
8748 */
8749 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
8750 throws XmlPullParserException, IOException {
8751 Intent intent = new Intent();
8752
8753 TypedArray sa = resources.obtainAttributes(attrs,
8754 com.android.internal.R.styleable.Intent);
8755
8756 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
8757
8758 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
8759 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
8760 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
8761
8762 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
8763 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
8764 if (packageName != null && className != null) {
8765 intent.setComponent(new ComponentName(packageName, className));
8766 }
8767
8768 sa.recycle();
8769
8770 int outerDepth = parser.getDepth();
8771 int type;
8772 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
8773 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
8774 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
8775 continue;
8776 }
8777
8778 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07008779 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008780 sa = resources.obtainAttributes(attrs,
8781 com.android.internal.R.styleable.IntentCategory);
8782 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
8783 sa.recycle();
8784
8785 if (cat != null) {
8786 intent.addCategory(cat);
8787 }
8788 XmlUtils.skipCurrentTag(parser);
8789
Craig Mautner21d24a22014-04-23 11:45:37 -07008790 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008791 if (intent.mExtras == null) {
8792 intent.mExtras = new Bundle();
8793 }
Craig Mautner21d24a22014-04-23 11:45:37 -07008794 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08008795 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07008796
8797 } else {
8798 XmlUtils.skipCurrentTag(parser);
8799 }
8800 }
8801
8802 return intent;
8803 }
Nick Pellyccae4122012-01-09 14:12:58 -08008804
Craig Mautner21d24a22014-04-23 11:45:37 -07008805 /** @hide */
8806 public void saveToXml(XmlSerializer out) throws IOException {
8807 if (mAction != null) {
8808 out.attribute(null, ATTR_ACTION, mAction);
8809 }
8810 if (mData != null) {
8811 out.attribute(null, ATTR_DATA, mData.toString());
8812 }
8813 if (mType != null) {
8814 out.attribute(null, ATTR_TYPE, mType);
8815 }
8816 if (mComponent != null) {
8817 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
8818 }
8819 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
8820
8821 if (mCategories != null) {
8822 out.startTag(null, TAG_CATEGORIES);
8823 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
8824 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
8825 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07008826 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07008827 }
8828 }
8829
8830 /** @hide */
8831 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
8832 XmlPullParserException {
8833 Intent intent = new Intent();
8834 final int outerDepth = in.getDepth();
8835
8836 int attrCount = in.getAttributeCount();
8837 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8838 final String attrName = in.getAttributeName(attrNdx);
8839 final String attrValue = in.getAttributeValue(attrNdx);
8840 if (ATTR_ACTION.equals(attrName)) {
8841 intent.setAction(attrValue);
8842 } else if (ATTR_DATA.equals(attrName)) {
8843 intent.setData(Uri.parse(attrValue));
8844 } else if (ATTR_TYPE.equals(attrName)) {
8845 intent.setType(attrValue);
8846 } else if (ATTR_COMPONENT.equals(attrName)) {
8847 intent.setComponent(ComponentName.unflattenFromString(attrValue));
8848 } else if (ATTR_FLAGS.equals(attrName)) {
8849 intent.setFlags(Integer.valueOf(attrValue, 16));
8850 } else {
8851 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
8852 }
8853 }
8854
8855 int event;
8856 String name;
8857 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
8858 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
8859 if (event == XmlPullParser.START_TAG) {
8860 name = in.getName();
8861 if (TAG_CATEGORIES.equals(name)) {
8862 attrCount = in.getAttributeCount();
8863 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
8864 intent.addCategory(in.getAttributeValue(attrNdx));
8865 }
8866 } else {
8867 Log.w("Intent", "restoreFromXml: unknown name=" + name);
8868 XmlUtils.skipCurrentTag(in);
8869 }
8870 }
8871 }
8872
8873 return intent;
8874 }
8875
Nick Pellyccae4122012-01-09 14:12:58 -08008876 /**
8877 * Normalize a MIME data type.
8878 *
8879 * <p>A normalized MIME type has white-space trimmed,
8880 * content-type parameters removed, and is lower-case.
8881 * This aligns the type with Android best practices for
8882 * intent filtering.
8883 *
8884 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
8885 * "text/x-vCard" becomes "text/x-vcard".
8886 *
8887 * <p>All MIME types received from outside Android (such as user input,
8888 * or external sources like Bluetooth, NFC, or the Internet) should
8889 * be normalized before they are used to create an Intent.
8890 *
8891 * @param type MIME data type to normalize
8892 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05008893 * @see #setType
8894 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08008895 */
8896 public static String normalizeMimeType(String type) {
8897 if (type == null) {
8898 return null;
8899 }
8900
Elliott Hughescb64d432013-08-02 10:00:44 -07008901 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08008902
8903 final int semicolonIndex = type.indexOf(';');
8904 if (semicolonIndex != -1) {
8905 type = type.substring(0, semicolonIndex);
8906 }
8907 return type;
8908 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07008909
8910 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008911 * Prepare this {@link Intent} to leave an app process.
8912 *
8913 * @hide
8914 */
Jeff Sharkey344744b2016-01-28 19:03:30 -07008915 public void prepareToLeaveProcess(Context context) {
8916 final boolean leavingPackage = (mComponent == null)
8917 || !Objects.equals(mComponent.getPackageName(), context.getPackageName());
8918 prepareToLeaveProcess(leavingPackage);
8919 }
8920
8921 /**
8922 * Prepare this {@link Intent} to leave an app process.
8923 *
8924 * @hide
8925 */
8926 public void prepareToLeaveProcess(boolean leavingPackage) {
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008927 setAllowFds(false);
8928
8929 if (mSelector != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008930 mSelector.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008931 }
8932 if (mClipData != null) {
Jeff Sharkey344744b2016-01-28 19:03:30 -07008933 mClipData.prepareToLeaveProcess(leavingPackage);
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008934 }
8935
Jeff Sharkey344744b2016-01-28 19:03:30 -07008936 if (mData != null && StrictMode.vmFileUriExposureEnabled() && leavingPackage) {
8937 switch (mAction) {
8938 case ACTION_MEDIA_REMOVED:
8939 case ACTION_MEDIA_UNMOUNTED:
8940 case ACTION_MEDIA_CHECKING:
8941 case ACTION_MEDIA_NOFS:
8942 case ACTION_MEDIA_MOUNTED:
8943 case ACTION_MEDIA_SHARED:
8944 case ACTION_MEDIA_UNSHARED:
8945 case ACTION_MEDIA_BAD_REMOVAL:
8946 case ACTION_MEDIA_UNMOUNTABLE:
8947 case ACTION_MEDIA_EJECT:
8948 case ACTION_MEDIA_SCANNER_STARTED:
8949 case ACTION_MEDIA_SCANNER_FINISHED:
8950 case ACTION_MEDIA_SCANNER_SCAN_FILE:
8951 // Ignore legacy actions
8952 break;
8953 default:
8954 mData.checkFileUriExposed("Intent.getData()");
Jeff Sharkeya14acd22013-04-02 18:27:45 -07008955 }
8956 }
8957 }
8958
8959 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008960 * @hide
8961 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008962 public void prepareToEnterProcess() {
8963 if (mContentUserHint != UserHandle.USER_CURRENT) {
Nicolas Prevotc4fc00a2014-10-31 12:01:32 +00008964 if (UserHandle.getAppId(Process.myUid()) != Process.SYSTEM_UID) {
8965 fixUris(mContentUserHint);
8966 mContentUserHint = UserHandle.USER_CURRENT;
8967 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008968 }
8969 }
8970
8971 /**
8972 * @hide
8973 */
8974 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008975 Uri data = getData();
8976 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008977 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008978 }
8979 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008980 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008981 }
8982 String action = getAction();
8983 if (ACTION_SEND.equals(action)) {
8984 final Uri stream = getParcelableExtra(EXTRA_STREAM);
8985 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008986 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008987 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008988 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008989 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
8990 if (streams != null) {
8991 ArrayList<Uri> newStreams = new ArrayList<Uri>();
8992 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008993 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01008994 }
8995 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
8996 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01008997 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
8998 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
8999 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9000 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9001 if (output != null) {
9002 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
9003 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009004 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009005 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01009006
9007 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009008 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009009 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
9010 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009011 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009012 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009013 * @hide
9014 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009015 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009016 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009017 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009018
9019 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009020 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009021
9022 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009023 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009024 // Inspect contained intents to see if we need to migrate extras. We
9025 // don't promote ClipData to the parent, since ChooserActivity will
9026 // already start the picked item as the caller, and we can't combine
9027 // the flags in a safe way.
9028
9029 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07009030 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009031 final Intent intent = getParcelableExtra(EXTRA_INTENT);
9032 if (intent != null) {
9033 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07009034 }
9035 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009036 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07009037 try {
9038 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
9039 if (intents != null) {
9040 for (int i = 0; i < intents.length; i++) {
9041 final Intent intent = (Intent) intents[i];
9042 if (intent != null) {
9043 migrated |= intent.migrateExtraStreamToClipData();
9044 }
9045 }
9046 }
9047 } catch (ClassCastException e) {
9048 }
9049 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009050
9051 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009052 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009053 final Uri stream = getParcelableExtra(EXTRA_STREAM);
9054 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
9055 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
9056 if (stream != null || text != null || htmlText != null) {
9057 final ClipData clipData = new ClipData(
9058 null, new String[] { getType() },
9059 new ClipData.Item(text, htmlText, null, stream));
9060 setClipData(clipData);
9061 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009062 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009063 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009064 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009065 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009066
9067 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009068 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009069 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
9070 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
9071 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
9072 int num = -1;
9073 if (streams != null) {
9074 num = streams.size();
9075 }
9076 if (texts != null) {
9077 if (num >= 0 && num != texts.size()) {
9078 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009079 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009080 }
9081 num = texts.size();
9082 }
9083 if (htmlTexts != null) {
9084 if (num >= 0 && num != htmlTexts.size()) {
9085 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009086 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009087 }
9088 num = htmlTexts.size();
9089 }
9090 if (num > 0) {
9091 final ClipData clipData = new ClipData(
9092 null, new String[] { getType() },
9093 makeClipItem(streams, texts, htmlTexts, 0));
9094
9095 for (int i = 1; i < num; i++) {
9096 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
9097 }
9098
9099 setClipData(clipData);
9100 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009101 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07009102 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009103 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07009104 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01009105 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
9106 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
9107 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
9108 final Uri output;
9109 try {
9110 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
9111 } catch (ClassCastException e) {
9112 return false;
9113 }
9114 if (output != null) {
9115 setClipData(ClipData.newRawUri("", output));
9116 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
9117 return true;
9118 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009119 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07009120
9121 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07009122 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07009123
9124 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
9125 ArrayList<String> htmlTexts, int which) {
9126 Uri uri = streams != null ? streams.get(which) : null;
9127 CharSequence text = texts != null ? texts.get(which) : null;
9128 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
9129 return new ClipData.Item(text, htmlText, null, uri);
9130 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07009131
9132 /** @hide */
9133 public boolean isDocument() {
9134 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
9135 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07009136}